@frontmcp/sdk 1.2.1 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -60
- package/agent/agent.scope.d.ts +164 -0
- package/agent/agent.scope.d.ts.map +1 -1
- package/app/instances/app.esm.instance.d.ts.map +1 -1
- package/app/instances/app.remote.instance.d.ts.map +1 -1
- package/auth/auth-ui/auth-ui.contract.d.ts +149 -0
- package/auth/auth-ui/auth-ui.contract.d.ts.map +1 -0
- package/auth/auth-ui/auth-ui.registry.d.ts +151 -0
- package/auth/auth-ui/auth-ui.registry.d.ts.map +1 -0
- package/auth/auth-ui/auth-ui.render.d.ts +49 -0
- package/auth/auth-ui/auth-ui.render.d.ts.map +1 -0
- package/auth/auth-ui/auth-ui.state.d.ts +62 -0
- package/auth/auth-ui/auth-ui.state.d.ts.map +1 -0
- package/auth/auth-ui/index.d.ts +24 -0
- package/auth/auth-ui/index.d.ts.map +1 -0
- package/auth/auth.registry.d.ts.map +1 -1
- package/auth/authorized-apps.utils.d.ts +51 -0
- package/auth/authorized-apps.utils.d.ts.map +1 -0
- package/auth/consent-tools.helper.d.ts +26 -0
- package/auth/consent-tools.helper.d.ts.map +1 -0
- package/auth/consent.utils.d.ts +62 -0
- package/auth/consent.utils.d.ts.map +1 -0
- package/auth/credentials/credentials.context-extension.d.ts +63 -0
- package/auth/credentials/credentials.context-extension.d.ts.map +1 -0
- package/auth/credentials/credentials.providers.d.ts +40 -0
- package/auth/credentials/credentials.providers.d.ts.map +1 -0
- package/auth/credentials/index.d.ts +3 -0
- package/auth/credentials/index.d.ts.map +1 -0
- package/auth/flows/auth.verify.flow.d.ts.map +1 -1
- package/auth/flows/oauth.auth-ui.flow.d.ts +53 -0
- package/auth/flows/oauth.auth-ui.flow.d.ts.map +1 -0
- package/auth/flows/oauth.authorize.flow.d.ts +51 -9
- package/auth/flows/oauth.authorize.flow.d.ts.map +1 -1
- package/auth/flows/oauth.callback.flow.d.ts +118 -5
- package/auth/flows/oauth.callback.flow.d.ts.map +1 -1
- package/auth/flows/oauth.connect.flow.d.ts +89 -0
- package/auth/flows/oauth.connect.flow.d.ts.map +1 -0
- package/auth/flows/oauth.provider-callback.flow.d.ts +34 -4
- package/auth/flows/oauth.provider-callback.flow.d.ts.map +1 -1
- package/auth/flows/oauth.register.flow.d.ts +16 -20
- package/auth/flows/oauth.register.flow.d.ts.map +1 -1
- package/auth/flows/oauth.token.flow.d.ts +2 -2
- package/auth/flows/oauth.token.flow.d.ts.map +1 -1
- package/auth/flows/oauth.userinfo.flow.d.ts +67 -0
- package/auth/flows/oauth.userinfo.flow.d.ts.map +1 -0
- package/auth/flows/session.verify.flow.d.ts +2 -2
- package/auth/flows/session.verify.flow.d.ts.map +1 -1
- package/auth/flows/well-known.jwks.flow.d.ts +3 -3
- package/auth/flows/well-known.oauth-authorization-server.flow.d.ts +3 -2
- package/auth/flows/well-known.oauth-authorization-server.flow.d.ts.map +1 -1
- package/auth/flows/well-known.prm.flow.d.ts +1 -1
- package/auth/flows/well-known.prm.flow.d.ts.map +1 -1
- package/auth/instances/instance.local-primary-auth.d.ts +226 -12
- package/auth/instances/instance.local-primary-auth.d.ts.map +1 -1
- package/auth/secure-store/index.d.ts +3 -0
- package/auth/secure-store/index.d.ts.map +1 -0
- package/auth/secure-store/secure-store.context-extension.d.ts +61 -0
- package/auth/secure-store/secure-store.context-extension.d.ts.map +1 -0
- package/auth/secure-store/secure-store.providers.d.ts +36 -0
- package/auth/secure-store/secure-store.providers.d.ts.map +1 -0
- package/auth/session/session-store.factory.d.ts +25 -5
- package/auth/session/session-store.factory.d.ts.map +1 -1
- package/common/decorators/agent.decorator.d.ts +32 -0
- package/common/decorators/agent.decorator.d.ts.map +1 -1
- package/common/decorators/app.decorator.d.ts.map +1 -1
- package/common/decorators/front-mcp.decorator.d.ts.map +1 -1
- package/common/decorators/skill.decorator.d.ts +26 -9
- package/common/decorators/skill.decorator.d.ts.map +1 -1
- package/common/decorators/tool.decorator.d.ts +44 -0
- package/common/decorators/tool.decorator.d.ts.map +1 -1
- package/common/entries/scope.entry.d.ts +7 -0
- package/common/entries/scope.entry.d.ts.map +1 -1
- package/common/entries/skill.entry.d.ts +22 -1
- package/common/entries/skill.entry.d.ts.map +1 -1
- package/common/entries/tool.entry.d.ts +17 -0
- package/common/entries/tool.entry.d.ts.map +1 -1
- package/common/interfaces/internal/primary-auth-provider.interface.d.ts +18 -0
- package/common/interfaces/internal/primary-auth-provider.interface.d.ts.map +1 -1
- package/common/interfaces/skill.interface.d.ts +17 -4
- package/common/interfaces/skill.interface.d.ts.map +1 -1
- package/common/interfaces/tool.interface.d.ts +26 -0
- package/common/interfaces/tool.interface.d.ts.map +1 -1
- package/common/metadata/agent.metadata.d.ts +10 -0
- package/common/metadata/agent.metadata.d.ts.map +1 -1
- package/common/metadata/app.metadata.d.ts +472 -0
- package/common/metadata/app.metadata.d.ts.map +1 -1
- package/common/metadata/channel.metadata.d.ts +10 -0
- package/common/metadata/channel.metadata.d.ts.map +1 -1
- package/common/metadata/front-mcp.metadata.d.ts +2103 -49
- package/common/metadata/front-mcp.metadata.d.ts.map +1 -1
- package/common/metadata/index.d.ts +1 -0
- package/common/metadata/index.d.ts.map +1 -1
- package/common/metadata/output-policy.d.ts +82 -0
- package/common/metadata/output-policy.d.ts.map +1 -0
- package/common/metadata/prompt.metadata.d.ts +10 -0
- package/common/metadata/prompt.metadata.d.ts.map +1 -1
- package/common/metadata/resource.metadata.d.ts +20 -0
- package/common/metadata/resource.metadata.d.ts.map +1 -1
- package/common/metadata/skill.metadata.d.ts +55 -1
- package/common/metadata/skill.metadata.d.ts.map +1 -1
- package/common/metadata/tool-ui.metadata.d.ts +1 -1
- package/common/metadata/tool-ui.metadata.d.ts.map +1 -1
- package/common/metadata/tool.metadata.d.ts +75 -0
- package/common/metadata/tool.metadata.d.ts.map +1 -1
- package/common/records/skill.record.d.ts +2 -0
- package/common/records/skill.record.d.ts.map +1 -1
- package/common/schemas/http-output.schema.d.ts +25 -25
- package/common/schemas/http-output.schema.d.ts.map +1 -1
- package/common/tokens/app.tokens.d.ts.map +1 -1
- package/common/tokens/front-mcp.tokens.d.ts.map +1 -1
- package/common/tokens/skill.tokens.d.ts +10 -0
- package/common/tokens/skill.tokens.d.ts.map +1 -1
- package/common/tokens/tool.tokens.d.ts +1 -0
- package/common/tokens/tool.tokens.d.ts.map +1 -1
- package/common/types/auth/session.types.d.ts +2 -2
- package/common/types/options/auth/index.d.ts +4 -4
- package/common/types/options/auth/index.d.ts.map +1 -1
- package/common/types/options/auth/interfaces.d.ts +1 -1
- package/common/types/options/auth/interfaces.d.ts.map +1 -1
- package/common/types/options/auth/orchestrated.schema.d.ts +1 -1
- package/common/types/options/auth/orchestrated.schema.d.ts.map +1 -1
- package/common/types/options/auth/shared.schemas.d.ts +2 -2
- package/common/types/options/auth/shared.schemas.d.ts.map +1 -1
- package/common/types/options/http/index.d.ts +1 -1
- package/common/types/options/http/index.d.ts.map +1 -1
- package/common/types/options/http/interfaces.d.ts +88 -1
- package/common/types/options/http/interfaces.d.ts.map +1 -1
- package/common/types/options/http/schema.d.ts +17 -0
- package/common/types/options/http/schema.d.ts.map +1 -1
- package/common/types/options/index.d.ts +1 -0
- package/common/types/options/index.d.ts.map +1 -1
- package/common/types/options/metrics/index.d.ts +3 -0
- package/common/types/options/metrics/index.d.ts.map +1 -0
- package/common/types/options/metrics/interfaces.d.ts +154 -0
- package/common/types/options/metrics/interfaces.d.ts.map +1 -0
- package/common/types/options/metrics/schema.d.ts +33 -0
- package/common/types/options/metrics/schema.d.ts.map +1 -0
- package/common/types/options/session/schema.d.ts +3 -3
- package/common/types/options/sqlite/index.d.ts +2 -0
- package/common/types/options/sqlite/index.d.ts.map +1 -1
- package/common/types/options/sqlite/interfaces.d.ts +7 -2
- package/common/types/options/sqlite/interfaces.d.ts.map +1 -1
- package/common/types/options/sqlite/resolve.d.ts +29 -0
- package/common/types/options/sqlite/resolve.d.ts.map +1 -0
- package/common/types/options/sqlite/schema.d.ts +1 -1
- package/common/types/options/sqlite/schema.d.ts.map +1 -1
- package/common/types/options/transport/interfaces.d.ts +23 -7
- package/common/types/options/transport/interfaces.d.ts.map +1 -1
- package/common/types/options/transport/schema.d.ts +24 -5
- package/common/types/options/transport/schema.d.ts.map +1 -1
- package/common/utils/caller-dir.utils.d.ts +15 -0
- package/common/utils/caller-dir.utils.d.ts.map +1 -0
- package/common/utils/index.d.ts +1 -0
- package/common/utils/index.d.ts.map +1 -1
- package/direct/client.types.d.ts +10 -0
- package/direct/client.types.d.ts.map +1 -1
- package/elicitation/store/elicitation-store.factory.d.ts +19 -5
- package/elicitation/store/elicitation-store.factory.d.ts.map +1 -1
- package/errors/index.d.ts +4 -2
- package/errors/index.d.ts.map +1 -1
- package/errors/mcp.error.d.ts +79 -4
- package/errors/mcp.error.d.ts.map +1 -1
- package/errors/sdk.errors.d.ts +13 -0
- package/errors/sdk.errors.d.ts.map +1 -1
- package/errors/tool-credentials-required.error.d.ts +70 -0
- package/errors/tool-credentials-required.error.d.ts.map +1 -0
- package/esm/index.mjs +7689 -3080
- package/flows/flow.instance.d.ts.map +1 -1
- package/front-mcp/front-mcp.d.ts +61 -32
- package/front-mcp/front-mcp.d.ts.map +1 -1
- package/front-mcp/front-mcp.providers.d.ts +804 -12
- package/front-mcp/front-mcp.providers.d.ts.map +1 -1
- package/index.d.ts +35 -8
- package/index.d.ts.map +1 -1
- package/index.js +8264 -3675
- package/job/index.d.ts +1 -0
- package/job/index.d.ts.map +1 -1
- package/metrics/index.d.ts +4 -0
- package/metrics/index.d.ts.map +1 -0
- package/metrics/metrics.errors.d.ts +18 -0
- package/metrics/metrics.errors.d.ts.map +1 -0
- package/metrics/metrics.routes.d.ts +30 -0
- package/metrics/metrics.routes.d.ts.map +1 -0
- package/metrics/metrics.service.d.ts +66 -0
- package/metrics/metrics.service.d.ts.map +1 -0
- package/package.json +30 -11
- package/prompt/prompt.registry.d.ts +5 -0
- package/prompt/prompt.registry.d.ts.map +1 -1
- package/resource/resource.registry.d.ts +5 -0
- package/resource/resource.registry.d.ts.map +1 -1
- package/scope/flows/http.request.flow.d.ts +18 -1
- package/scope/flows/http.request.flow.d.ts.map +1 -1
- package/scope/optional-dependency.util.d.ts +39 -0
- package/scope/optional-dependency.util.d.ts.map +1 -0
- package/scope/scope.instance.d.ts +30 -0
- package/scope/scope.instance.d.ts.map +1 -1
- package/scope/scope.utils.d.ts.map +1 -1
- package/server/adapters/express.host.adapter.d.ts +16 -0
- package/server/adapters/express.host.adapter.d.ts.map +1 -1
- package/server/adapters/polyfills/browser-express-host.d.ts +3 -0
- package/server/adapters/polyfills/browser-express-host.d.ts.map +1 -1
- package/server/adapters/polyfills/node-express-host.d.ts +1 -1
- package/server/adapters/polyfills/node-express-host.d.ts.map +1 -1
- package/server/custom-routes.helper.d.ts +81 -0
- package/server/custom-routes.helper.d.ts.map +1 -0
- package/server/server.instance.d.ts +16 -0
- package/server/server.instance.d.ts.map +1 -1
- package/skill/flows/http/llm-full-txt.flow.d.ts +1 -1
- package/skill/flows/http/llm-txt.flow.d.ts +1 -1
- package/skill/flows/http/skills-api.flow.d.ts +18 -1
- package/skill/flows/http/skills-api.flow.d.ts.map +1 -1
- package/skill/flows/load-skill.flow.d.ts +7 -0
- package/skill/flows/load-skill.flow.d.ts.map +1 -1
- package/skill/flows/search-skills.flow.d.ts +13 -0
- package/skill/flows/search-skills.flow.d.ts.map +1 -1
- package/skill/index.d.ts +1 -0
- package/skill/index.d.ts.map +1 -1
- package/skill/sep-2640/resources/skill-file.resource.d.ts.map +1 -1
- package/skill/sep-2640/resources/skill-index.resource.d.ts.map +1 -1
- package/skill/sep-2640/resources/skill-md.resource.d.ts.map +1 -1
- package/skill/sep-2640/sep-2640.per-skill.d.ts.map +1 -1
- package/skill/skill-authorities.helper.d.ts +100 -0
- package/skill/skill-authorities.helper.d.ts.map +1 -0
- package/skill/skill.instance.d.ts.map +1 -1
- package/skill/skill.registry.d.ts +34 -0
- package/skill/skill.registry.d.ts.map +1 -1
- package/skill/skill.utils.d.ts.map +1 -1
- package/task/helpers/cli-task-runner.d.ts.map +1 -1
- package/tool/flows/call-tool.flow.d.ts +26 -1
- package/tool/flows/call-tool.flow.d.ts.map +1 -1
- package/tool/flows/tool-credentials.gate.d.ts +31 -0
- package/tool/flows/tool-credentials.gate.d.ts.map +1 -0
- package/tool/flows/tools-list.flow.d.ts.map +1 -1
- package/tool/tool.instance.d.ts.map +1 -1
- package/tool/tool.registry.d.ts +6 -0
- package/tool/tool.registry.d.ts.map +1 -1
- package/tool/ui/index.d.ts +1 -1
- package/tool/ui/index.d.ts.map +1 -1
- package/tool/ui/ui-resource.handler.d.ts.map +1 -1
- package/tool/ui/ui-shared.d.ts +33 -1
- package/tool/ui/ui-shared.d.ts.map +1 -1
- package/transport/adapters/transport.local.adapter.d.ts.map +1 -1
- package/transport/event-stores/event-store.factory.d.ts.map +1 -1
- package/transport/flows/handle.sse.flow.d.ts +1 -1
- package/transport/flows/handle.streamable-http.flow.d.ts +58 -1
- package/transport/flows/handle.streamable-http.flow.d.ts.map +1 -1
- package/transport/mcp-handlers/call-tool-request.handler.d.ts.map +1 -1
- package/transport/mcp-handlers/index.d.ts.map +1 -1
- package/transport/mcp-handlers/read-resource-request.handler.d.ts.map +1 -1
- package/transport/mcp-handlers/skills-list-request.handler.d.ts.map +1 -1
- package/transport/mcp-handlers/skills-load-request.handler.d.ts.map +1 -1
- package/transport/mcp-handlers/skills-search-request.handler.d.ts.map +1 -1
- package/transport/transport.registry.d.ts +24 -3
- package/transport/transport.registry.d.ts.map +1 -1
- package/workflow/index.d.ts +1 -0
- package/workflow/index.d.ts.map +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flow.instance.d.ts","sourceRoot":"","sources":["../../src/flows/flow.instance.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAI1B,OAAO,EAEL,SAAS,EAGT,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EAEjB,KAAK,UAAU,EAMf,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,KAAK,EACV,KAAK,IAAI,EACV,MAAM,WAAW,CAAC;AAInB,OAAO,KAAK,gBAAgB,MAAM,+BAA+B,CAAC;AAyBlE,qBAAa,YAAY,CAAC,IAAI,SAAS,QAAQ,CAAE,SAAQ,SAAS,CAAC,IAAI,CAAC;IACtE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;IAC3B,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC3C,OAAO,CAAC,IAAI,CAAkB;IAC9B,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,gBAAgB;cAW1F,UAAU;
|
|
1
|
+
{"version":3,"file":"flow.instance.d.ts","sourceRoot":"","sources":["../../src/flows/flow.instance.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAI1B,OAAO,EAEL,SAAS,EAGT,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EAEjB,KAAK,UAAU,EAMf,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,KAAK,EACV,KAAK,IAAI,EACV,MAAM,WAAW,CAAC;AAInB,OAAO,KAAK,gBAAgB,MAAM,+BAA+B,CAAC;AAyBlE,qBAAa,YAAY,CAAC,IAAI,SAAS,QAAQ,CAAE,SAAQ,SAAS,CAAC,IAAI,CAAC;IACtE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;IAC3B,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC3C,OAAO,CAAC,IAAI,CAAkB;IAC9B,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,gBAAgB;cAW1F,UAAU;IAkFpB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAa3D;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;;;;;;OASG;YACW,cAAc;IAiCtB,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;CA6TrG"}
|
package/front-mcp/front-mcp.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { type FrontMcpConfigInput, type FrontMcpConfigType, type FrontMcpInterface, type ScopeEntry } from '../common';
|
|
2
2
|
import { type SqliteOptionsInput } from '../common/types/options/sqlite/schema';
|
|
3
3
|
import { type DirectMcpServer } from '../direct';
|
|
4
|
+
/**
|
|
5
|
+
* A `@FrontMcp`-decorated server class, or the raw config object it wraps.
|
|
6
|
+
* Entry points that accept either resolve a class to its stored config via
|
|
7
|
+
* {@link resolveConfigInput}.
|
|
8
|
+
*/
|
|
9
|
+
export type ConfigOrServerClass = FrontMcpConfigInput | (abstract new (...args: never[]) => unknown);
|
|
4
10
|
export declare class FrontMcpInstance implements FrontMcpInterface {
|
|
5
11
|
config: FrontMcpConfigType;
|
|
6
12
|
readonly ready: Promise<void>;
|
|
@@ -25,6 +31,15 @@ export declare class FrontMcpInstance implements FrontMcpInterface {
|
|
|
25
31
|
* Called before server.start() or server.prepare() to register health routes.
|
|
26
32
|
*/
|
|
27
33
|
private wireHealthService;
|
|
34
|
+
/**
|
|
35
|
+
* Wire the `/metrics` service into the server instance (issue #397).
|
|
36
|
+
*
|
|
37
|
+
* Off by default — `metrics.enabled` must be set to `true` explicitly.
|
|
38
|
+
* The `MetricsService` is instantiated here (not in scope construction)
|
|
39
|
+
* because the endpoint is server-wide, not per-app — counters and process
|
|
40
|
+
* stats are process-global.
|
|
41
|
+
*/
|
|
42
|
+
private wireMetricsService;
|
|
28
43
|
static bootstrap(options: FrontMcpConfigInput | FrontMcpConfigType): Promise<void>;
|
|
29
44
|
/**
|
|
30
45
|
* Creates and initializes a FrontMCP instance without starting the HTTP server.
|
|
@@ -89,35 +104,6 @@ export declare class FrontMcpInstance implements FrontMcpInterface {
|
|
|
89
104
|
* ```
|
|
90
105
|
*/
|
|
91
106
|
static createDirect(options: FrontMcpConfigInput): Promise<DirectMcpServer>;
|
|
92
|
-
/**
|
|
93
|
-
* Runs the FrontMCP server using stdio transport for use with Claude Code
|
|
94
|
-
* or other MCP clients that support stdio communication.
|
|
95
|
-
*
|
|
96
|
-
* This method connects the server to stdin/stdout and handles MCP protocol
|
|
97
|
-
* messages directly. It does not return until the connection is closed.
|
|
98
|
-
*
|
|
99
|
-
* @example
|
|
100
|
-
* ```typescript
|
|
101
|
-
* // In your CLI entrypoint
|
|
102
|
-
* import { FrontMcpInstance } from '@frontmcp/sdk';
|
|
103
|
-
* import MyServer from './my-server';
|
|
104
|
-
*
|
|
105
|
-
* FrontMcpInstance.runStdio(MyServer);
|
|
106
|
-
* ```
|
|
107
|
-
*
|
|
108
|
-
* @example
|
|
109
|
-
* ```bash
|
|
110
|
-
* # In Claude Desktop config:
|
|
111
|
-
* {
|
|
112
|
-
* "mcpServers": {
|
|
113
|
-
* "my-server": {
|
|
114
|
-
* "command": "node",
|
|
115
|
-
* "args": ["./dist/main.js", "--stdio"]
|
|
116
|
-
* }
|
|
117
|
-
* }
|
|
118
|
-
* }
|
|
119
|
-
* ```
|
|
120
|
-
*/
|
|
121
107
|
/**
|
|
122
108
|
* Runs the FrontMCP server on a Unix socket for local-only access.
|
|
123
109
|
*
|
|
@@ -125,13 +111,16 @@ export declare class FrontMcpInstance implements FrontMcpInterface {
|
|
|
125
111
|
* a Unix `.sock` file. The entire HTTP feature set (streamable HTTP, SSE,
|
|
126
112
|
* elicitation, sessions) works unchanged over Unix sockets.
|
|
127
113
|
*
|
|
114
|
+
* Pass the same config object you give to `@FrontMcp()` (not the decorated
|
|
115
|
+
* class — spreading a class yields no config) plus the socket path.
|
|
116
|
+
*
|
|
128
117
|
* @example
|
|
129
118
|
* ```typescript
|
|
130
119
|
* import { FrontMcpInstance } from '@frontmcp/sdk';
|
|
131
|
-
* import
|
|
120
|
+
* import { serverConfig } from './server-config';
|
|
132
121
|
*
|
|
133
122
|
* const handle = await FrontMcpInstance.runUnixSocket({
|
|
134
|
-
* ...
|
|
123
|
+
* ...serverConfig,
|
|
135
124
|
* socketPath: '/tmp/my-app.sock',
|
|
136
125
|
* sqlite: { path: '~/.frontmcp/data/my-app.sqlite' },
|
|
137
126
|
* });
|
|
@@ -146,6 +135,46 @@ export declare class FrontMcpInstance implements FrontMcpInterface {
|
|
|
146
135
|
}): Promise<{
|
|
147
136
|
close: () => Promise<void>;
|
|
148
137
|
}>;
|
|
149
|
-
|
|
138
|
+
/**
|
|
139
|
+
* Runs the FrontMCP server over **stdio** (stdin/stdout JSON-RPC) for local
|
|
140
|
+
* MCP clients such as Claude Desktop, Claude Code, and Cursor. Connects the
|
|
141
|
+
* transport and returns only when the connection closes. **No TCP port is
|
|
142
|
+
* bound** — the HTTP server is disabled for this entry point (#451).
|
|
143
|
+
*
|
|
144
|
+
* Accepts either a `@FrontMcp`-decorated class or the same config object you
|
|
145
|
+
* pass to `@FrontMcp()` (#450).
|
|
146
|
+
*
|
|
147
|
+
* IMPORTANT — importing a `@FrontMcp`-decorated class starts an HTTP server at
|
|
148
|
+
* import time unless `FRONTMCP_STDIO=1` is set *before* the import. Two safe
|
|
149
|
+
* patterns avoid that:
|
|
150
|
+
*
|
|
151
|
+
* 1. Built bundles — `frontmcp build --target node`, then run the emitted
|
|
152
|
+
* runner with `--stdio` (it sets `FRONTMCP_STDIO=1` for you, so the
|
|
153
|
+
* decorator serves over stdio). A `--target cli` binary supports
|
|
154
|
+
* `<bin> --stdio` the same way.
|
|
155
|
+
* 2. Hand-written entry — keep the config object in its own module (no
|
|
156
|
+
* decorated class in the import graph) and pass it directly, as below.
|
|
157
|
+
*
|
|
158
|
+
* @example Hand-written stdio entry (config kept separate from the class)
|
|
159
|
+
* ```typescript
|
|
160
|
+
* // server-config.ts — a plain object, no @FrontMcp decorator here
|
|
161
|
+
* export const serverConfig = { info: { name: 'my-server', version: '0.1.0' }, apps: [MyApp] };
|
|
162
|
+
*
|
|
163
|
+
* // stdio.ts
|
|
164
|
+
* import { FrontMcpInstance } from '@frontmcp/sdk';
|
|
165
|
+
* import { serverConfig } from './server-config';
|
|
166
|
+
* FrontMcpInstance.runStdio(serverConfig);
|
|
167
|
+
* ```
|
|
168
|
+
*
|
|
169
|
+
* @example Claude Desktop config (built `--target node` runner)
|
|
170
|
+
* ```json
|
|
171
|
+
* {
|
|
172
|
+
* "mcpServers": {
|
|
173
|
+
* "my-server": { "command": "/abs/path/dist/node/my-server", "args": ["--stdio"] }
|
|
174
|
+
* }
|
|
175
|
+
* }
|
|
176
|
+
* ```
|
|
177
|
+
*/
|
|
178
|
+
static runStdio(optionsOrClass: ConfigOrServerClass): Promise<void>;
|
|
150
179
|
}
|
|
151
180
|
//# sourceMappingURL=front-mcp.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"front-mcp.d.ts","sourceRoot":"","sources":["../../src/front-mcp/front-mcp.ts"],"names":[],"mappings":"AAEA,OAAO,
|
|
1
|
+
{"version":3,"file":"front-mcp.d.ts","sourceRoot":"","sources":["../../src/front-mcp/front-mcp.ts"],"names":[],"mappings":"AAEA,OAAO,EAML,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAuB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AActE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,CAAC,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,CAAC;AAiCrG,qBAAa,gBAAiB,YAAW,iBAAiB;IACxD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,GAAG,CAAC,CAAiB;gBAEjB,MAAM,EAAE,kBAAkB;IAKhC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB3B,KAAK;IA8BX;;OAEG;IACH,SAAS,IAAI,kBAAkB;IAI/B;;;OAGG;IACH,SAAS,IAAI,UAAU,EAAE;IAIzB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAiCzB;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;WAoBN,SAAS,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB;IAkB/E;;;;;;;;;;OAUG;WACiB,aAAa,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBhF;;;;;;;;OAQG;WACiB,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQ3F;;;;;;;;OAQG;WACiB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA4BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACiB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAqBxF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,aAAa,CAC/B,OAAO,EAAE,CAAC,mBAAmB,GAAG,kBAAkB,CAAC,GAAG;QACpD,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,kBAAkB,CAAC;KAC7B,GACA,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAmD1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,QAAQ,CAAC,cAAc,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CAuOjF"}
|