skybridge 0.0.0-dev.ffaef7a → 0.0.0-dev.ffdf126
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 +9 -7
- package/dist/cli/build-helpers.d.ts +3 -2
- package/dist/cli/build-helpers.js +24 -10
- package/dist/cli/build-helpers.js.map +1 -1
- package/dist/cli/build-helpers.test.js +48 -5
- package/dist/cli/build-helpers.test.js.map +1 -1
- package/dist/cli/build-steps.js +10 -5
- package/dist/cli/build-steps.js.map +1 -1
- package/dist/cli/build-steps.test.js +3 -3
- package/dist/cli/build-steps.test.js.map +1 -1
- package/dist/cli/detect-port.js +0 -1
- package/dist/cli/detect-port.js.map +1 -1
- package/dist/cli/resolve-skybridge-config.d.ts +5 -0
- package/dist/cli/{resolve-views-dir.js → resolve-skybridge-config.js} +4 -3
- package/dist/cli/resolve-skybridge-config.js.map +1 -0
- package/dist/cli/use-nodemon.js +12 -4
- package/dist/cli/use-nodemon.js.map +1 -1
- package/dist/cli/use-typescript-check.js +1 -1
- package/dist/cli/use-typescript-check.js.map +1 -1
- package/dist/commands/dev.js +3 -3
- package/dist/commands/dev.js.map +1 -1
- package/dist/commands/start.js +2 -2
- package/dist/commands/start.js.map +1 -1
- package/dist/context-warnings.d.ts +5 -0
- package/dist/context-warnings.js +31 -0
- package/dist/context-warnings.js.map +1 -0
- package/dist/context-warnings.test.js +28 -0
- package/dist/context-warnings.test.js.map +1 -0
- package/dist/server/app.d.ts +194 -0
- package/dist/server/app.js +266 -0
- package/dist/server/app.js.map +1 -0
- package/dist/server/app.test.js +97 -0
- package/dist/server/app.test.js.map +1 -0
- package/dist/server/auth/discovery.d.ts +2 -1
- package/dist/server/auth/discovery.js +2 -2
- package/dist/server/auth/discovery.js.map +1 -1
- package/dist/server/auth/index.d.ts +35 -5
- package/dist/server/auth/index.js.map +1 -1
- package/dist/server/auth/providers/auth0.d.ts +25 -3
- package/dist/server/auth/providers/auth0.js +13 -8
- package/dist/server/auth/providers/auth0.js.map +1 -1
- package/dist/server/auth/providers/auth0.test.js +5 -3
- package/dist/server/auth/providers/auth0.test.js.map +1 -1
- package/dist/server/auth/providers/authplane.d.ts +49 -0
- package/dist/server/auth/providers/authplane.js +57 -0
- package/dist/server/auth/providers/authplane.js.map +1 -0
- package/dist/server/auth/providers/authplane.test.js +143 -0
- package/dist/server/auth/providers/authplane.test.js.map +1 -0
- package/dist/server/auth/providers/clerk.d.ts +40 -3
- package/dist/server/auth/providers/clerk.js +4 -1
- package/dist/server/auth/providers/clerk.js.map +1 -1
- package/dist/server/auth/providers/clerk.test.js +5 -3
- package/dist/server/auth/providers/clerk.test.js.map +1 -1
- package/dist/server/auth/providers/custom.d.ts +20 -4
- package/dist/server/auth/providers/custom.js +33 -11
- package/dist/server/auth/providers/custom.js.map +1 -1
- package/dist/server/auth/providers/custom.test.js +71 -17
- package/dist/server/auth/providers/custom.test.js.map +1 -1
- package/dist/server/auth/providers/descope.d.ts +32 -3
- package/dist/server/auth/providers/descope.js +13 -2
- package/dist/server/auth/providers/descope.js.map +1 -1
- package/dist/server/auth/providers/descope.test.js +42 -17
- package/dist/server/auth/providers/descope.test.js.map +1 -1
- package/dist/server/auth/providers/stytch.d.ts +16 -3
- package/dist/server/auth/providers/stytch.js +4 -1
- package/dist/server/auth/providers/stytch.js.map +1 -1
- package/dist/server/auth/providers/verify-spy.d.ts +12 -0
- package/dist/server/auth/providers/verify-spy.js +21 -0
- package/dist/server/auth/providers/verify-spy.js.map +1 -0
- package/dist/server/auth/providers/workos.d.ts +25 -3
- package/dist/server/auth/providers/workos.js +4 -1
- package/dist/server/auth/providers/workos.js.map +1 -1
- package/dist/server/auth/security-schemes.d.ts +10 -0
- package/dist/server/auth/security-schemes.js +15 -4
- package/dist/server/auth/security-schemes.js.map +1 -1
- package/dist/server/auth/security-schemes.test.js +11 -2
- package/dist/server/auth/security-schemes.test.js.map +1 -1
- package/dist/server/auth/setup.d.ts +1 -1
- package/dist/server/auth/setup.js +10 -17
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +123 -59
- package/dist/server/auth/setup.test.js.map +1 -1
- package/dist/server/auth/verify.d.ts +37 -3
- package/dist/server/auth/verify.js +27 -3
- package/dist/server/auth/verify.js.map +1 -1
- package/dist/server/auth/verify.test.js +49 -0
- package/dist/server/auth/verify.test.js.map +1 -1
- package/dist/server/auth-extra.test-d.js +130 -0
- package/dist/server/auth-extra.test-d.js.map +1 -0
- package/dist/server/auth.d.ts +43 -6
- package/dist/server/auth.js +4 -5
- package/dist/server/auth.js.map +1 -1
- package/dist/server/build-manifest.test.js +7 -6
- package/dist/server/build-manifest.test.js.map +1 -1
- package/dist/server/content-helpers.d.ts +1 -1
- package/dist/server/content-helpers.js.map +1 -1
- package/dist/server/express.d.ts +23 -3
- package/dist/server/express.js +38 -32
- package/dist/server/express.js.map +1 -1
- package/dist/server/express.test.js +220 -103
- package/dist/server/express.test.js.map +1 -1
- package/dist/server/file-ref.d.ts +1 -1
- package/dist/server/file-ref.js +1 -1
- package/dist/server/file-ref.js.map +1 -1
- package/dist/server/host.d.ts +2 -0
- package/dist/server/host.js +11 -0
- package/dist/server/host.js.map +1 -0
- package/dist/server/host.test.js +13 -0
- package/dist/server/host.test.js.map +1 -0
- package/dist/server/index.d.ts +16 -9
- package/dist/server/index.js +9 -3
- package/dist/server/index.js.map +1 -1
- package/dist/server/mcp-errors.test.d.ts +1 -0
- package/dist/server/mcp-errors.test.js +41 -0
- package/dist/server/mcp-errors.test.js.map +1 -0
- package/dist/server/middleware.d.ts +35 -10
- package/dist/server/middleware.js +33 -0
- package/dist/server/middleware.js.map +1 -1
- package/dist/server/middleware.test-d.js +1 -1
- package/dist/server/middleware.test-d.js.map +1 -1
- package/dist/server/middleware.test.js +242 -134
- package/dist/server/middleware.test.js.map +1 -1
- package/dist/server/register-tool.test.d.ts +1 -0
- package/dist/server/register-tool.test.js +27 -0
- package/dist/server/register-tool.test.js.map +1 -0
- package/dist/server/server.d.ts +110 -122
- package/dist/server/server.js +146 -286
- package/dist/server/server.js.map +1 -1
- package/dist/server/skills-integration.test.d.ts +1 -0
- package/dist/server/skills-integration.test.js +86 -0
- package/dist/server/skills-integration.test.js.map +1 -0
- package/dist/server/skills.d.ts +27 -0
- package/dist/server/skills.js +188 -0
- package/dist/server/skills.js.map +1 -0
- package/dist/server/skills.test.d.ts +1 -0
- package/dist/server/skills.test.js +243 -0
- package/dist/server/skills.test.js.map +1 -0
- package/dist/server/templateHelper.d.ts +0 -3
- package/dist/server/templateHelper.js.map +1 -1
- package/dist/server/templates.generated.js +4 -8
- package/dist/server/templates.generated.js.map +1 -1
- package/dist/server/tool-extra.test.d.ts +1 -0
- package/dist/server/tool-extra.test.js +88 -0
- package/dist/server/tool-extra.test.js.map +1 -0
- package/dist/server/view-resource-resolution.test.js +18 -13
- package/dist/server/view-resource-resolution.test.js.map +1 -1
- package/dist/server/viewsDevServer.js +4 -1
- package/dist/server/viewsDevServer.js.map +1 -1
- package/dist/test/utils.d.ts +9 -11
- package/dist/test/utils.js +220 -201
- package/dist/test/utils.js.map +1 -1
- package/dist/test/view.test.js +44 -40
- package/dist/test/view.test.js.map +1 -1
- package/dist/views/index.d.ts +10 -0
- package/dist/views/index.js +3 -0
- package/dist/views/index.js.map +1 -0
- package/dist/{web/plugin → views}/scan-views.js +1 -1
- package/dist/views/scan-views.js.map +1 -0
- package/dist/views/scan-views.test.d.ts +1 -0
- package/dist/views/scan-views.test.js.map +1 -0
- package/dist/views/validate-view.d.ts +1 -0
- package/dist/{web/plugin → views}/validate-view.js +2 -2
- package/dist/views/validate-view.js.map +1 -0
- package/dist/views/validate-view.test.d.ts +1 -0
- package/dist/views/validate-view.test.js.map +1 -0
- package/dist/web/bridges/adaptor.js +14 -17
- package/dist/web/bridges/adaptor.js.map +1 -1
- package/dist/web/bridges/adaptor.test.js +24 -7
- package/dist/web/bridges/adaptor.test.js.map +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
- package/dist/web/bridges/get-adaptor.test.js +2 -2
- package/dist/web/bridges/get-adaptor.test.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.js +6 -4
- package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.test.js +2 -2
- package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -1
- package/dist/web/bridges/mcp-app/types.d.ts +2 -0
- package/dist/web/bridges/mcp-app/types.js.map +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.js +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
- package/dist/web/bridges/mcp-app/view-tools.test.js +1 -1
- package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -1
- package/dist/web/bridges/types.d.ts +17 -12
- package/dist/web/bridges/types.js.map +1 -1
- package/dist/web/create-store.test.js +2 -2
- package/dist/web/create-store.test.js.map +1 -1
- package/dist/web/data-llm.test.js +5 -4
- package/dist/web/data-llm.test.js.map +1 -1
- package/dist/web/generate-helpers.d.ts +22 -18
- package/dist/web/generate-helpers.js +19 -15
- package/dist/web/generate-helpers.js.map +1 -1
- package/dist/web/generate-helpers.test-d.js +3 -3
- package/dist/web/generate-helpers.test-d.js.map +1 -1
- package/dist/web/generate-helpers.test.js +2 -2
- package/dist/web/generate-helpers.test.js.map +1 -1
- package/dist/web/hooks/index.d.ts +2 -1
- package/dist/web/hooks/index.js +2 -1
- package/dist/web/hooks/index.js.map +1 -1
- package/dist/web/hooks/test/utils.d.ts +2 -1
- package/dist/web/hooks/test/utils.js +1 -1
- package/dist/web/hooks/test/utils.js.map +1 -1
- package/dist/web/hooks/use-call-tool.test.js +2 -2
- package/dist/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/web/hooks/use-display-mode.d.ts +1 -1
- package/dist/web/hooks/use-display-mode.js +1 -1
- package/dist/web/hooks/use-display-mode.js.map +1 -1
- package/dist/web/hooks/use-display-mode.test.js +1 -1
- package/dist/web/hooks/use-display-mode.test.js.map +1 -1
- package/dist/web/hooks/use-download.d.ts +1 -3
- package/dist/web/hooks/use-download.js +1 -2
- package/dist/web/hooks/use-download.js.map +1 -1
- package/dist/web/hooks/use-download.test.js +7 -7
- package/dist/web/hooks/use-download.test.js.map +1 -1
- package/dist/web/hooks/use-files.test.js +1 -1
- package/dist/web/hooks/use-files.test.js.map +1 -1
- package/dist/web/hooks/use-host.d.ts +22 -0
- package/dist/web/hooks/use-host.js +30 -0
- package/dist/web/hooks/use-host.js.map +1 -0
- package/dist/web/hooks/use-host.test.d.ts +1 -0
- package/dist/web/hooks/use-host.test.js +59 -0
- package/dist/web/hooks/use-host.test.js.map +1 -0
- package/dist/web/hooks/use-open-external.test.js +2 -2
- package/dist/web/hooks/use-open-external.test.js.map +1 -1
- package/dist/web/hooks/use-register-view-tool.d.ts +2 -3
- package/dist/web/hooks/use-register-view-tool.js.map +1 -1
- package/dist/web/hooks/use-request-close.test.js +1 -1
- package/dist/web/hooks/use-request-close.test.js.map +1 -1
- package/dist/web/hooks/use-request-modal.test.js +1 -1
- package/dist/web/hooks/use-request-modal.test.js.map +1 -1
- package/dist/web/hooks/use-request-size.d.ts +1 -1
- package/dist/web/hooks/use-request-size.js +1 -1
- package/dist/web/hooks/use-request-size.js.map +1 -1
- package/dist/web/hooks/use-request-size.test.js +1 -1
- package/dist/web/hooks/use-request-size.test.js.map +1 -1
- package/dist/web/hooks/use-set-open-in-app-url.test.js +2 -8
- package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -1
- package/dist/web/hooks/use-tool-info.d.ts +1 -20
- package/dist/web/hooks/use-tool-info.js +0 -1
- package/dist/web/hooks/use-tool-info.js.map +1 -1
- package/dist/web/hooks/use-tool-info.test-d.js +0 -5
- package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
- package/dist/web/hooks/use-tool-info.test.js +2 -7
- package/dist/web/hooks/use-tool-info.test.js.map +1 -1
- package/dist/web/hooks/use-user.d.ts +3 -2
- package/dist/web/hooks/use-user.js +4 -3
- package/dist/web/hooks/use-user.js.map +1 -1
- package/dist/web/hooks/use-user.test.js +5 -3
- package/dist/web/hooks/use-user.test.js.map +1 -1
- package/dist/web/hooks/use-view-state.js +19 -9
- package/dist/web/hooks/use-view-state.js.map +1 -1
- package/dist/web/hooks/use-view-state.test.js +33 -2
- package/dist/web/hooks/use-view-state.test.js.map +1 -1
- package/dist/web/hooks/use-viewport.d.ts +20 -0
- package/dist/web/hooks/use-viewport.js +21 -0
- package/dist/web/hooks/use-viewport.js.map +1 -0
- package/dist/web/hooks/use-viewport.test.d.ts +1 -0
- package/dist/web/hooks/{use-layout.test.js → use-viewport.test.js} +12 -32
- package/dist/web/hooks/use-viewport.test.js.map +1 -0
- package/dist/web/mount-view.d.ts +3 -2
- package/dist/web/mount-view.js +5 -8
- package/dist/web/mount-view.js.map +1 -1
- package/package.json +20 -17
- package/dist/cli/resolve-views-dir.d.ts +0 -1
- package/dist/cli/resolve-views-dir.js.map +0 -1
- package/dist/web/hooks/use-layout.d.ts +0 -24
- package/dist/web/hooks/use-layout.js +0 -25
- package/dist/web/hooks/use-layout.js.map +0 -1
- package/dist/web/hooks/use-layout.test.js.map +0 -1
- package/dist/web/plugin/data-llm.test.js +0 -81
- package/dist/web/plugin/data-llm.test.js.map +0 -1
- package/dist/web/plugin/plugin.d.ts +0 -33
- package/dist/web/plugin/plugin.js +0 -188
- package/dist/web/plugin/plugin.js.map +0 -1
- package/dist/web/plugin/scan-views.js.map +0 -1
- package/dist/web/plugin/scan-views.test.js.map +0 -1
- package/dist/web/plugin/transform-data-llm.d.ts +0 -12
- package/dist/web/plugin/transform-data-llm.js +0 -96
- package/dist/web/plugin/transform-data-llm.js.map +0 -1
- package/dist/web/plugin/transform-data-llm.test.js +0 -81
- package/dist/web/plugin/transform-data-llm.test.js.map +0 -1
- package/dist/web/plugin/validate-view.d.ts +0 -1
- package/dist/web/plugin/validate-view.js.map +0 -1
- package/dist/web/plugin/validate-view.test.js.map +0 -1
- /package/dist/{web/hooks/use-layout.test.d.ts → context-warnings.test.d.ts} +0 -0
- /package/dist/{web/plugin/data-llm.test.d.ts → server/app.test.d.ts} +0 -0
- /package/dist/{web/plugin/transform-data-llm.test.d.ts → server/auth/providers/authplane.test.d.ts} +0 -0
- /package/dist/{web/plugin/scan-views.test.d.ts → server/auth-extra.test-d.d.ts} +0 -0
- /package/dist/{web/plugin/validate-view.test.d.ts → server/host.test.d.ts} +0 -0
- /package/dist/{web/plugin → views}/scan-views.d.ts +0 -0
- /package/dist/{web/plugin → views}/scan-views.test.js +0 -0
- /package/dist/{web/plugin → views}/validate-view.test.js +0 -0
package/dist/server/server.d.ts
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
|
|
2
|
-
import { type ServerOptions } from "@modelcontextprotocol/
|
|
3
|
-
import
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
7
|
-
import
|
|
8
|
-
import type { OAuthConfig } from "./auth/index.js";
|
|
9
|
-
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
2
|
+
import { type ContentBlock, type Implementation, McpServer as McpServerBase, type RequestMeta, type ServerOptions, type ServerResult, type StandardSchemaV1, type StandardSchemaWithJSON, type ToolAnnotations } from "@modelcontextprotocol/server";
|
|
3
|
+
import type express from "express";
|
|
4
|
+
import type { ResourceMetadataUrlResolver } from "./auth/setup.js";
|
|
5
|
+
import type { ExtraClaims } from "./auth.js";
|
|
6
|
+
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareEntry, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
7
|
+
import { type SkillsManifest } from "./skills.js";
|
|
10
8
|
/**
|
|
11
9
|
* Type marker for a registered tool — carries its input, output, and response
|
|
12
10
|
* metadata shapes so views can infer types from `typeof server`.
|
|
@@ -19,12 +17,6 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
|
|
|
19
17
|
output: TOutput;
|
|
20
18
|
responseMetadata: TResponseMetadata;
|
|
21
19
|
};
|
|
22
|
-
/**
|
|
23
|
-
* @deprecated Views now always emit a single ext-apps resource; host targeting
|
|
24
|
-
* no longer applies. Retained for backwards compatibility; will be removed in a
|
|
25
|
-
* future major.
|
|
26
|
-
*/
|
|
27
|
-
export type ViewHostType = "apps-sdk" | "mcp-app";
|
|
28
20
|
/**
|
|
29
21
|
* Content Security Policy origins attached to a view's resource. Each list is
|
|
30
22
|
* passed through to the host's CSP for the view iframe; omit a field to inherit
|
|
@@ -68,11 +60,6 @@ export interface ViewConfig {
|
|
|
68
60
|
component: ViewName;
|
|
69
61
|
/** Human-readable label the host may show alongside the view. */
|
|
70
62
|
description?: string;
|
|
71
|
-
/**
|
|
72
|
-
* @deprecated No-op. Every view emits a single ext-apps resource regardless
|
|
73
|
-
* of this value. Will be removed in a future major.
|
|
74
|
-
*/
|
|
75
|
-
hosts?: ViewHostType[];
|
|
76
63
|
/** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
|
|
77
64
|
prefersBorder?: boolean;
|
|
78
65
|
/** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
|
|
@@ -88,8 +75,18 @@ export type SecurityScheme = {
|
|
|
88
75
|
type: "oauth2";
|
|
89
76
|
scopes?: string[];
|
|
90
77
|
};
|
|
78
|
+
/**
|
|
79
|
+
* Declarative per-tool auth. Enforced when the server has an `oauth` provider:
|
|
80
|
+
* anonymous or under-scoped calls are rejected before the handler runs. Omit
|
|
81
|
+
* `auth` entirely for the secure default (sign-in required, no specific scope).
|
|
82
|
+
*/
|
|
91
83
|
export type ToolAuth = {
|
|
92
|
-
|
|
84
|
+
/**
|
|
85
|
+
* When `true`, the tool is callable signed out; the token is still used when
|
|
86
|
+
* one is present. Omit (or `false`) to require sign-in.
|
|
87
|
+
*/
|
|
88
|
+
allowsAnonymous?: boolean;
|
|
89
|
+
/** OAuth scopes the caller's token must carry to invoke the tool. */
|
|
93
90
|
scopes?: string[];
|
|
94
91
|
};
|
|
95
92
|
/**
|
|
@@ -97,12 +94,19 @@ export type ToolAuth = {
|
|
|
97
94
|
* from Express's own types so the public API doesn't depend on `body-parser`.
|
|
98
95
|
*/
|
|
99
96
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
100
|
-
/**
|
|
97
|
+
/**
|
|
98
|
+
* The Skybridge-specific options an {@link McpServer} is built with. A
|
|
99
|
+
* {@link Skybridge} app derives them from its config; pass them directly only
|
|
100
|
+
* when constructing an `McpServer` by hand.
|
|
101
|
+
*/
|
|
101
102
|
export interface SkybridgeServerOptions {
|
|
102
|
-
/**
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
|
|
103
|
+
/** Whether an OAuth provider guards `/mcp`; enables per-tool scheme enforcement. */
|
|
104
|
+
oauth?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
|
|
107
|
+
* API may change.
|
|
108
|
+
*/
|
|
109
|
+
skills?: boolean;
|
|
106
110
|
}
|
|
107
111
|
/**
|
|
108
112
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
@@ -121,7 +125,6 @@ export interface KnownToolMeta {
|
|
|
121
125
|
"openai/fileParams"?: string[];
|
|
122
126
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
123
127
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
124
|
-
securitySchemes?: SecurityScheme[];
|
|
125
128
|
}
|
|
126
129
|
/** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
|
|
127
130
|
export type ToolMeta = KnownToolMeta & Record<string, unknown>;
|
|
@@ -147,10 +150,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
147
150
|
type Simplify<T> = {
|
|
148
151
|
[K in keyof T]: T[K];
|
|
149
152
|
};
|
|
150
|
-
type ShapeOutput<Shape extends
|
|
151
|
-
[K in keyof Shape as undefined extends
|
|
153
|
+
type ShapeOutput<Shape extends Record<string, StandardSchemaWithJSON>> = Simplify<{
|
|
154
|
+
[K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? never : K]: StandardSchemaV1.InferOutput<Shape[K]>;
|
|
152
155
|
} & {
|
|
153
|
-
[K in keyof Shape as undefined extends
|
|
156
|
+
[K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? K : never]?: StandardSchemaV1.InferOutput<Shape[K]>;
|
|
154
157
|
}>;
|
|
155
158
|
type ExtractStructuredContent<T> = T extends {
|
|
156
159
|
structuredContent: infer SC;
|
|
@@ -162,23 +165,27 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
162
165
|
}> extends {
|
|
163
166
|
_meta: infer M;
|
|
164
167
|
} ? Simplify<M> : unknown;
|
|
165
|
-
type AddTool<TTools, TName extends string, TInput extends
|
|
168
|
+
type AddTool<TTools, TName extends string, TInput extends Record<string, StandardSchemaWithJSON>, TOutput, TResponseMetadata = unknown, TAuthExtra extends ExtraClaims = ExtraClaims> = McpServer<TTools & {
|
|
166
169
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
167
|
-
}>;
|
|
168
|
-
interface ToolConfigBase<TInput extends
|
|
170
|
+
}, TAuthExtra>;
|
|
171
|
+
interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
|
|
169
172
|
name: string;
|
|
170
173
|
title?: string;
|
|
171
174
|
description?: string;
|
|
172
175
|
inputSchema?: TInput;
|
|
173
|
-
outputSchema?:
|
|
176
|
+
outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
174
177
|
annotations?: ToolAnnotations;
|
|
175
178
|
view?: ViewConfig;
|
|
176
179
|
_meta?: ToolMeta;
|
|
177
180
|
}
|
|
178
|
-
|
|
181
|
+
/**
|
|
182
|
+
* The auth face of a tool config: either the high-level `auth` shorthand or the
|
|
183
|
+
* low-level `securitySchemes` escape hatch, never both.
|
|
184
|
+
*/
|
|
185
|
+
type ToolAuthConfig = {
|
|
179
186
|
auth?: ToolAuth;
|
|
180
187
|
securitySchemes?: never;
|
|
181
|
-
}
|
|
188
|
+
} | {
|
|
182
189
|
auth?: never;
|
|
183
190
|
/**
|
|
184
191
|
* Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
|
|
@@ -188,7 +195,8 @@ type ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> = (ToolConfigBase<
|
|
|
188
195
|
* enhanced behavior to authenticated ones.
|
|
189
196
|
*/
|
|
190
197
|
securitySchemes?: SecurityScheme[];
|
|
191
|
-
}
|
|
198
|
+
};
|
|
199
|
+
type ToolConfig<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> = ToolConfigBase<TInput> & ToolAuthConfig;
|
|
192
200
|
/**
|
|
193
201
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
194
202
|
* by the Apps SDK host. Hints only: never use for authorization, and tolerate
|
|
@@ -218,14 +226,16 @@ export interface ClientHintsMeta {
|
|
|
218
226
|
/** Stable id for the currently mounted widget instance. */
|
|
219
227
|
"openai/widgetSessionId"?: string;
|
|
220
228
|
}
|
|
221
|
-
type ToolHandlerExtra = Omit<
|
|
222
|
-
_meta
|
|
229
|
+
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
230
|
+
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
231
|
+
_meta?: RequestMeta & ClientHintsMeta;
|
|
232
|
+
};
|
|
223
233
|
};
|
|
224
|
-
type ToolHandler<TInput extends
|
|
234
|
+
type ToolHandler<TInput extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
225
235
|
content?: HandlerContent;
|
|
226
236
|
} = {
|
|
227
237
|
content?: HandlerContent;
|
|
228
|
-
}> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
|
|
238
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
229
239
|
/**
|
|
230
240
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
231
241
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -246,26 +256,39 @@ declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof M
|
|
|
246
256
|
export declare function __setBuildManifest(manifest: Record<string, {
|
|
247
257
|
file: string;
|
|
248
258
|
}>): void;
|
|
249
|
-
export declare
|
|
259
|
+
export declare function __setSkillsManifest(manifest: SkillsManifest): void;
|
|
260
|
+
/**
|
|
261
|
+
* Typed registration sugar over the MCP SDK's `McpServer`: a tool registry
|
|
262
|
+
* that carries input/output/meta shapes, view resources, per-tool security
|
|
263
|
+
* schemes, and prompt/resource registration. A {@link Skybridge} app builds
|
|
264
|
+
* one of these per request and hands it to your `handler`; chain
|
|
265
|
+
* {@link McpServer.registerTool} calls on it and return the result.
|
|
266
|
+
*
|
|
267
|
+
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
268
|
+
* shape, so `typeof app` carries enough information for view-side helpers
|
|
269
|
+
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
270
|
+
*
|
|
271
|
+
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
272
|
+
* chaining; you almost never set this manually.
|
|
273
|
+
*
|
|
274
|
+
* @example
|
|
275
|
+
* ```ts
|
|
276
|
+
* export const app = new Skybridge({
|
|
277
|
+
* name: "my-app",
|
|
278
|
+
* version: "1.0.0",
|
|
279
|
+
* handler: (server) =>
|
|
280
|
+
* server.registerTool({
|
|
281
|
+
* name: "search",
|
|
282
|
+
* inputSchema: { query: z.string() },
|
|
283
|
+
* view: { component: "search" },
|
|
284
|
+
* }, async ({ query }) => ({ content: `Results for ${query}` })),
|
|
285
|
+
* });
|
|
286
|
+
* ```
|
|
287
|
+
*
|
|
288
|
+
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
289
|
+
*/
|
|
290
|
+
export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>, TAuthExtra extends ExtraClaims = ExtraClaims> extends McpServerBaseOmitted {
|
|
250
291
|
readonly $types: McpServerTypes<TTools>;
|
|
251
|
-
/**
|
|
252
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
253
|
-
* custom routes, middleware, or settings — e.g.
|
|
254
|
-
* `server.express.get("/health", ...)`.
|
|
255
|
-
*
|
|
256
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
257
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
258
|
-
* Register your handlers before `run()`;
|
|
259
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
260
|
-
* error handler are appended in that order.
|
|
261
|
-
*
|
|
262
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
263
|
-
* locally and on self-hosted deployments.
|
|
264
|
-
*/
|
|
265
|
-
readonly express: Express;
|
|
266
|
-
private customErrorMiddleware;
|
|
267
|
-
private mcpMiddlewareEntries;
|
|
268
|
-
private mcpMiddlewareApplied;
|
|
269
292
|
private claimedViews;
|
|
270
293
|
private viewMetaBuilders;
|
|
271
294
|
/**
|
|
@@ -276,44 +299,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
276
299
|
*/
|
|
277
300
|
private viewUriByPath;
|
|
278
301
|
private viteManifest;
|
|
279
|
-
private readonly serverInfo;
|
|
280
|
-
private readonly serverOptions?;
|
|
281
302
|
private oauthEnabled;
|
|
282
303
|
private resolveResourceMetadataUrl?;
|
|
283
|
-
private
|
|
304
|
+
private readonly toolSecuritySchemes;
|
|
305
|
+
private readonly userMiddlewareEntries;
|
|
284
306
|
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
|
|
285
307
|
/**
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
308
|
+
* The per-tool security schemes collected during registration, keyed by tool
|
|
309
|
+
* name. Read by the OAuth layer to decide whether anonymous requests are
|
|
310
|
+
* allowed and which schemes gate a given `tools/call`.
|
|
289
311
|
*
|
|
290
|
-
*
|
|
291
|
-
* locally and on self-hosted deployments.
|
|
312
|
+
* @internal
|
|
292
313
|
*/
|
|
293
|
-
|
|
294
|
-
use(path: string, ...handlers: RequestHandler[]): this;
|
|
314
|
+
get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
|
|
295
315
|
/**
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
* thrown by tool handlers before the default error handler responds.
|
|
316
|
+
* Inject the resolver the app uses to build the protected-resource metadata
|
|
317
|
+
* URL, so tool handlers can emit in-band auth challenges.
|
|
299
318
|
*
|
|
300
|
-
* @
|
|
301
|
-
* ```ts
|
|
302
|
-
* server.useOnError((err, _req, _res, next) => {
|
|
303
|
-
* logger.error(err);
|
|
304
|
-
* next(err);
|
|
305
|
-
* });
|
|
306
|
-
* ```
|
|
319
|
+
* @internal
|
|
307
320
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
321
|
+
setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
|
|
322
|
+
private setupSkills;
|
|
310
323
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
311
|
-
mcpMiddleware(handler: McpMiddlewareFn): this;
|
|
324
|
+
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
312
325
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
313
326
|
mcpMiddleware(filter: "request", handler: (request: {
|
|
314
327
|
method: string;
|
|
315
328
|
params: Record<string, unknown>;
|
|
316
|
-
}, extra: McpExtra
|
|
329
|
+
}, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
|
|
317
330
|
/** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
|
|
318
331
|
mcpMiddleware(filter: "notification", handler: (request: {
|
|
319
332
|
method: string;
|
|
@@ -323,7 +336,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
323
336
|
* Register MCP protocol-level middleware for an exact method.
|
|
324
337
|
* Narrows `params`, `extra`, and `next()` result based on the method string.
|
|
325
338
|
*/
|
|
326
|
-
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
|
|
339
|
+
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
|
|
327
340
|
/**
|
|
328
341
|
* Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
|
|
329
342
|
* `next()` returns the union of result types for matching methods.
|
|
@@ -331,49 +344,22 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
331
344
|
mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
|
|
332
345
|
method: string;
|
|
333
346
|
params: Record<string, unknown>;
|
|
334
|
-
}, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
347
|
+
}, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
335
348
|
/**
|
|
336
349
|
* Register MCP protocol-level middleware with a method filter.
|
|
337
350
|
* Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
|
|
338
351
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
339
352
|
*/
|
|
340
|
-
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
|
|
341
|
-
private applyMcpMiddleware;
|
|
353
|
+
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
342
354
|
/**
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
348
|
-
* throw afterwards.
|
|
349
|
-
*/
|
|
350
|
-
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
351
|
-
/**
|
|
352
|
-
* Per-request stateless connect. The SDK's `Protocol` only allows one
|
|
353
|
-
* transport per instance, so we can't reuse this `McpServer` across
|
|
354
|
-
* concurrent requests. The SDK's idiomatic fix is a `() => McpServer`
|
|
355
|
-
* factory, but that would break Skybridge's singleton API — so instead
|
|
356
|
-
* we build a fresh underlying `Server` per request and share the main
|
|
357
|
-
* server's handler maps by reference. The cast is unavoidable: there's
|
|
358
|
-
* no public API to inject handler maps. `getHandlerMaps` validates the
|
|
359
|
-
* read side and fails fast on SDK field renames.
|
|
360
|
-
*/
|
|
361
|
-
connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
362
|
-
/**
|
|
363
|
-
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
364
|
-
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
365
|
-
* via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
|
|
366
|
-
* any MCP middleware registered via {@link McpServer.mcpMiddleware}.
|
|
355
|
+
* This instance's protocol-level middleware: the framework's own entries
|
|
356
|
+
* (view `_meta` on `resources/list`, version-agnostic view resolution on
|
|
357
|
+
* `resources/read`, the top-level `securitySchemes` mirror on `tools/list`)
|
|
358
|
+
* followed by the ones registered via {@link McpServer.mcpMiddleware}.
|
|
367
359
|
*
|
|
368
|
-
*
|
|
369
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
370
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
371
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
372
|
-
* Node, returns `undefined` once listening.
|
|
360
|
+
* @internal
|
|
373
361
|
*/
|
|
374
|
-
|
|
375
|
-
fetch: (...args: unknown[]) => unknown;
|
|
376
|
-
} | Express | undefined>;
|
|
362
|
+
protocolMiddlewareEntries(): McpMiddlewareEntry[];
|
|
377
363
|
private enforceOneToolPerView;
|
|
378
364
|
private resolveViewRequestContext;
|
|
379
365
|
private registerViewResources;
|
|
@@ -422,11 +408,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
422
408
|
*
|
|
423
409
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
424
410
|
*/
|
|
425
|
-
registerTool<TName extends string, InputArgs extends
|
|
411
|
+
registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
426
412
|
content?: HandlerContent;
|
|
427
413
|
}>(config: ToolConfig<InputArgs> & {
|
|
428
414
|
name: TName;
|
|
429
|
-
}, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn
|
|
430
|
-
registerTool<InputArgs extends
|
|
415
|
+
}, cb: ToolHandler<InputArgs, TReturn, TAuthExtra>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
416
|
+
registerTool<InputArgs extends Record<string, StandardSchemaWithJSON>>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, {
|
|
417
|
+
content?: HandlerContent;
|
|
418
|
+
}, TAuthExtra>): this;
|
|
431
419
|
}
|
|
432
420
|
export {};
|