skybridge 0.0.0-dev.b59de48 → 0.0.0-dev.b5d3898
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 +10 -16
- package/dist/cli/build-helpers.d.ts +6 -2
- package/dist/cli/build-helpers.js +39 -14
- package/dist/cli/build-helpers.js.map +1 -1
- package/dist/cli/build-helpers.test.js +73 -5
- package/dist/cli/build-helpers.test.js.map +1 -1
- package/dist/cli/build-steps.d.ts +2 -0
- package/dist/cli/build-steps.js +73 -0
- package/dist/cli/build-steps.js.map +1 -0
- package/dist/cli/build-steps.test.js +52 -0
- package/dist/cli/build-steps.test.js.map +1 -0
- package/dist/cli/detect-port.js +0 -1
- package/dist/cli/detect-port.js.map +1 -1
- package/dist/cli/header.d.ts +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/run-plain.d.ts +18 -0
- package/dist/cli/run-plain.js +89 -0
- package/dist/cli/run-plain.js.map +1 -0
- package/dist/cli/use-execute-steps.d.ts +1 -1
- package/dist/cli/use-nodemon.d.ts +14 -0
- package/dist/cli/use-nodemon.js +81 -62
- package/dist/cli/use-nodemon.js.map +1 -1
- package/dist/cli/use-typescript-check.d.ts +8 -2
- package/dist/cli/use-typescript-check.js +70 -67
- package/dist/cli/use-typescript-check.js.map +1 -1
- package/dist/commands/build.d.ts +0 -2
- package/dist/commands/build.js +2 -61
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/dev.d.ts +1 -0
- package/dist/commands/dev.js +35 -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 +23 -0
- package/dist/server/auth/security-schemes.js +64 -0
- package/dist/server/auth/security-schemes.js.map +1 -0
- package/dist/server/auth/security-schemes.test.d.ts +1 -0
- package/dist/server/auth/security-schemes.test.js +99 -0
- package/dist/server/auth/security-schemes.test.js.map +1 -0
- package/dist/server/auth/setup.d.ts +3 -1
- package/dist/server/auth/setup.js +66 -26
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +349 -20
- 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.d.ts +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 +130 -121
- package/dist/server/server.js +209 -271
- 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-name.test-d.d.ts +1 -0
- package/dist/server/view-name.test-d.js +8 -0
- package/dist/server/view-name.test-d.js.map +1 -0
- package/dist/server/view-resource-resolution.test.js +81 -8
- 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 +22 -5
- package/dist/web/bridges/adaptor.js.map +1 -1
- package/dist/web/bridges/adaptor.test.js +33 -5
- 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/components/modal-provider.d.ts +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.d.ts +1 -1
- package/dist/web/data-llm.test.js +11 -2
- 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 +31 -28
- 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 -189
- 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 → cli/build-steps.test.d.ts} +0 -0
- /package/dist/{web/plugin/data-llm.test.d.ts → context-warnings.test.d.ts} +0 -0
- /package/dist/{web/plugin/scan-views.test.d.ts → server/app.test.d.ts} +0 -0
- /package/dist/{web/plugin/validate-view.test.d.ts → server/auth/providers/authplane.test.d.ts} +0 -0
- /package/dist/{web/plugin/transform-data-llm.test.d.ts → server/auth-extra.test-d.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
|
|
@@ -49,8 +41,16 @@ export interface ViewCsp {
|
|
|
49
41
|
*/
|
|
50
42
|
export interface ViewNameRegistry {
|
|
51
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Resolve view component names from a registry: the union of its keys, or
|
|
46
|
+
* `string` when the registry is empty. The empty case happens before
|
|
47
|
+
* `.skybridge/views.d.ts` is generated; falling back to `string` keeps valid
|
|
48
|
+
* view names from erroring on a fresh checkout, and narrowing kicks in once
|
|
49
|
+
* the generated file augments the registry.
|
|
50
|
+
*/
|
|
51
|
+
export type ViewNameFor<Registry> = [keyof Registry & string] extends [never] ? string : keyof Registry & string;
|
|
52
52
|
/** Union of valid view component names. Narrowed by {@link ViewNameRegistry}. */
|
|
53
|
-
export type ViewName =
|
|
53
|
+
export type ViewName = ViewNameFor<ViewNameRegistry>;
|
|
54
54
|
/**
|
|
55
55
|
* Pass under `view` in a tool's `registerTool` config to render the tool's
|
|
56
56
|
* result through a Skybridge view instead of a plain text response.
|
|
@@ -60,11 +60,6 @@ export interface ViewConfig {
|
|
|
60
60
|
component: ViewName;
|
|
61
61
|
/** Human-readable label the host may show alongside the view. */
|
|
62
62
|
description?: string;
|
|
63
|
-
/**
|
|
64
|
-
* @deprecated No-op. Every view emits a single ext-apps resource regardless
|
|
65
|
-
* of this value. Will be removed in a future major.
|
|
66
|
-
*/
|
|
67
|
-
hosts?: ViewHostType[];
|
|
68
63
|
/** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
|
|
69
64
|
prefersBorder?: boolean;
|
|
70
65
|
/** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
|
|
@@ -80,17 +75,38 @@ export type SecurityScheme = {
|
|
|
80
75
|
type: "oauth2";
|
|
81
76
|
scopes?: string[];
|
|
82
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
|
+
*/
|
|
83
|
+
export type ToolAuth = {
|
|
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. */
|
|
90
|
+
scopes?: string[];
|
|
91
|
+
};
|
|
83
92
|
/**
|
|
84
93
|
* Options forwarded to the built-in `express.json()` body parser. Derived
|
|
85
94
|
* from Express's own types so the public API doesn't depend on `body-parser`.
|
|
86
95
|
*/
|
|
87
96
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
88
|
-
/**
|
|
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
|
+
*/
|
|
89
102
|
export interface SkybridgeServerOptions {
|
|
90
|
-
/**
|
|
91
|
-
|
|
92
|
-
/**
|
|
93
|
-
|
|
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;
|
|
94
110
|
}
|
|
95
111
|
/**
|
|
96
112
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
@@ -109,7 +125,6 @@ export interface KnownToolMeta {
|
|
|
109
125
|
"openai/fileParams"?: string[];
|
|
110
126
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
111
127
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
112
|
-
securitySchemes?: SecurityScheme[];
|
|
113
128
|
}
|
|
114
129
|
/** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
|
|
115
130
|
export type ToolMeta = KnownToolMeta & Record<string, unknown>;
|
|
@@ -135,10 +150,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
135
150
|
type Simplify<T> = {
|
|
136
151
|
[K in keyof T]: T[K];
|
|
137
152
|
};
|
|
138
|
-
type ShapeOutput<Shape extends
|
|
139
|
-
[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]>;
|
|
140
155
|
} & {
|
|
141
|
-
[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]>;
|
|
142
157
|
}>;
|
|
143
158
|
type ExtractStructuredContent<T> = T extends {
|
|
144
159
|
structuredContent: infer SC;
|
|
@@ -150,17 +165,28 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
150
165
|
}> extends {
|
|
151
166
|
_meta: infer M;
|
|
152
167
|
} ? Simplify<M> : unknown;
|
|
153
|
-
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 & {
|
|
154
169
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
155
|
-
}>;
|
|
156
|
-
interface
|
|
170
|
+
}, TAuthExtra>;
|
|
171
|
+
interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
|
|
157
172
|
name: string;
|
|
158
173
|
title?: string;
|
|
159
174
|
description?: string;
|
|
160
175
|
inputSchema?: TInput;
|
|
161
|
-
outputSchema?:
|
|
176
|
+
outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
162
177
|
annotations?: ToolAnnotations;
|
|
163
178
|
view?: ViewConfig;
|
|
179
|
+
_meta?: ToolMeta;
|
|
180
|
+
}
|
|
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 = {
|
|
186
|
+
auth?: ToolAuth;
|
|
187
|
+
securitySchemes?: never;
|
|
188
|
+
} | {
|
|
189
|
+
auth?: never;
|
|
164
190
|
/**
|
|
165
191
|
* Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
|
|
166
192
|
* Lets clients label tools that require sign-in before calling, and pass
|
|
@@ -169,8 +195,8 @@ interface ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> {
|
|
|
169
195
|
* enhanced behavior to authenticated ones.
|
|
170
196
|
*/
|
|
171
197
|
securitySchemes?: SecurityScheme[];
|
|
172
|
-
|
|
173
|
-
|
|
198
|
+
};
|
|
199
|
+
type ToolConfig<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> = ToolConfigBase<TInput> & ToolAuthConfig;
|
|
174
200
|
/**
|
|
175
201
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
176
202
|
* by the Apps SDK host. Hints only: never use for authorization, and tolerate
|
|
@@ -200,14 +226,16 @@ export interface ClientHintsMeta {
|
|
|
200
226
|
/** Stable id for the currently mounted widget instance. */
|
|
201
227
|
"openai/widgetSessionId"?: string;
|
|
202
228
|
}
|
|
203
|
-
type ToolHandlerExtra = Omit<
|
|
204
|
-
_meta
|
|
229
|
+
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
230
|
+
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
231
|
+
_meta?: RequestMeta & ClientHintsMeta;
|
|
232
|
+
};
|
|
205
233
|
};
|
|
206
|
-
type ToolHandler<TInput extends
|
|
234
|
+
type ToolHandler<TInput extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
207
235
|
content?: HandlerContent;
|
|
208
236
|
} = {
|
|
209
237
|
content?: HandlerContent;
|
|
210
|
-
}> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
|
|
238
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
211
239
|
/**
|
|
212
240
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
213
241
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -228,26 +256,39 @@ declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof M
|
|
|
228
256
|
export declare function __setBuildManifest(manifest: Record<string, {
|
|
229
257
|
file: string;
|
|
230
258
|
}>): void;
|
|
231
|
-
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 {
|
|
232
291
|
readonly $types: McpServerTypes<TTools>;
|
|
233
|
-
/**
|
|
234
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
235
|
-
* custom routes, middleware, or settings — e.g.
|
|
236
|
-
* `server.express.get("/health", ...)`.
|
|
237
|
-
*
|
|
238
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
239
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
240
|
-
* Register your handlers before `run()`;
|
|
241
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
242
|
-
* error handler are appended in that order.
|
|
243
|
-
*
|
|
244
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
245
|
-
* locally and on self-hosted deployments.
|
|
246
|
-
*/
|
|
247
|
-
readonly express: Express;
|
|
248
|
-
private customErrorMiddleware;
|
|
249
|
-
private mcpMiddlewareEntries;
|
|
250
|
-
private mcpMiddlewareApplied;
|
|
251
292
|
private claimedViews;
|
|
252
293
|
private viewMetaBuilders;
|
|
253
294
|
/**
|
|
@@ -258,41 +299,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
258
299
|
*/
|
|
259
300
|
private viewUriByPath;
|
|
260
301
|
private viteManifest;
|
|
261
|
-
private
|
|
262
|
-
private
|
|
302
|
+
private oauthEnabled;
|
|
303
|
+
private resolveResourceMetadataUrl?;
|
|
304
|
+
private readonly toolSecuritySchemes;
|
|
305
|
+
private readonly userMiddlewareEntries;
|
|
263
306
|
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
|
|
264
307
|
/**
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
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`.
|
|
268
311
|
*
|
|
269
|
-
*
|
|
270
|
-
* locally and on self-hosted deployments.
|
|
312
|
+
* @internal
|
|
271
313
|
*/
|
|
272
|
-
|
|
273
|
-
use(path: string, ...handlers: RequestHandler[]): this;
|
|
314
|
+
get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
|
|
274
315
|
/**
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
* 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.
|
|
278
318
|
*
|
|
279
|
-
* @
|
|
280
|
-
* ```ts
|
|
281
|
-
* server.useOnError((err, _req, _res, next) => {
|
|
282
|
-
* logger.error(err);
|
|
283
|
-
* next(err);
|
|
284
|
-
* });
|
|
285
|
-
* ```
|
|
319
|
+
* @internal
|
|
286
320
|
*/
|
|
287
|
-
|
|
288
|
-
|
|
321
|
+
setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
|
|
322
|
+
private setupSkills;
|
|
289
323
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
290
|
-
mcpMiddleware(handler: McpMiddlewareFn): this;
|
|
324
|
+
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
291
325
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
292
326
|
mcpMiddleware(filter: "request", handler: (request: {
|
|
293
327
|
method: string;
|
|
294
328
|
params: Record<string, unknown>;
|
|
295
|
-
}, extra: McpExtra
|
|
329
|
+
}, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
|
|
296
330
|
/** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
|
|
297
331
|
mcpMiddleware(filter: "notification", handler: (request: {
|
|
298
332
|
method: string;
|
|
@@ -302,7 +336,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
302
336
|
* Register MCP protocol-level middleware for an exact method.
|
|
303
337
|
* Narrows `params`, `extra`, and `next()` result based on the method string.
|
|
304
338
|
*/
|
|
305
|
-
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
|
|
339
|
+
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
|
|
306
340
|
/**
|
|
307
341
|
* Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
|
|
308
342
|
* `next()` returns the union of result types for matching methods.
|
|
@@ -310,55 +344,28 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
310
344
|
mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
|
|
311
345
|
method: string;
|
|
312
346
|
params: Record<string, unknown>;
|
|
313
|
-
}, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
347
|
+
}, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
314
348
|
/**
|
|
315
349
|
* Register MCP protocol-level middleware with a method filter.
|
|
316
350
|
* Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
|
|
317
351
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
318
352
|
*/
|
|
319
|
-
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
|
|
320
|
-
private applyMcpMiddleware;
|
|
353
|
+
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
321
354
|
/**
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
327
|
-
* throw afterwards.
|
|
328
|
-
*/
|
|
329
|
-
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
330
|
-
/**
|
|
331
|
-
* Per-request stateless connect. The SDK's `Protocol` only allows one
|
|
332
|
-
* transport per instance, so we can't reuse this `McpServer` across
|
|
333
|
-
* concurrent requests. The SDK's idiomatic fix is a `() => McpServer`
|
|
334
|
-
* factory, but that would break Skybridge's singleton API — so instead
|
|
335
|
-
* we build a fresh underlying `Server` per request and share the main
|
|
336
|
-
* server's handler maps by reference. The cast is unavoidable: there's
|
|
337
|
-
* no public API to inject handler maps. `getHandlerMaps` validates the
|
|
338
|
-
* read side and fails fast on SDK field renames.
|
|
339
|
-
*/
|
|
340
|
-
connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
341
|
-
/**
|
|
342
|
-
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
343
|
-
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
344
|
-
* via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
|
|
345
|
-
* 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}.
|
|
346
359
|
*
|
|
347
|
-
*
|
|
348
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
349
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
350
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
351
|
-
* Node, returns `undefined` once listening.
|
|
360
|
+
* @internal
|
|
352
361
|
*/
|
|
353
|
-
|
|
354
|
-
fetch: (...args: unknown[]) => unknown;
|
|
355
|
-
} | Express | undefined>;
|
|
362
|
+
protocolMiddlewareEntries(): McpMiddlewareEntry[];
|
|
356
363
|
private enforceOneToolPerView;
|
|
357
364
|
private resolveViewRequestContext;
|
|
358
365
|
private registerViewResources;
|
|
359
366
|
private registerViewResource;
|
|
360
367
|
private serveLegacyAppsSdkUrl;
|
|
361
|
-
private
|
|
368
|
+
private decorateToolHandler;
|
|
362
369
|
private computeViewVersionParam;
|
|
363
370
|
private lookupViewFile;
|
|
364
371
|
private lookupDistFile;
|
|
@@ -401,11 +408,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
401
408
|
*
|
|
402
409
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
403
410
|
*/
|
|
404
|
-
registerTool<TName extends string, InputArgs extends
|
|
411
|
+
registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
405
412
|
content?: HandlerContent;
|
|
406
413
|
}>(config: ToolConfig<InputArgs> & {
|
|
407
414
|
name: TName;
|
|
408
|
-
}, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn
|
|
409
|
-
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;
|
|
410
419
|
}
|
|
411
420
|
export {};
|