skybridge 0.0.0-dev.ce040fa → 0.0.0-dev.ce2bbbe
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 +17 -23
- 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 +90 -0
- package/dist/cli/run-plain.js.map +1 -0
- package/dist/cli/telemetry.js +2 -0
- package/dist/cli/telemetry.js.map +1 -1
- package/dist/cli/use-execute-steps.d.ts +1 -1
- package/dist/cli/use-nodemon.d.ts +25 -1
- package/dist/cli/use-nodemon.js +96 -63
- 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 +38 -6
- 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 +24 -6
- 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 +28 -5
- package/dist/server/auth/providers/workos.js +6 -2
- 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 +42 -6
- package/dist/server/auth/verify.js +27 -3
- package/dist/server/auth/verify.js.map +1 -1
- package/dist/server/auth/verify.test.js +65 -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 +230 -0
- package/dist/server/register-tool.test.js.map +1 -0
- package/dist/server/server.d.ts +354 -124
- package/dist/server/server.js +465 -367
- 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 +105 -17
- 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 +105 -133
- 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.d.ts +62 -0
- package/dist/web/bridges/adaptor.js +471 -0
- package/dist/web/bridges/adaptor.js.map +1 -0
- package/dist/web/bridges/adaptor.test.d.ts +1 -0
- package/dist/web/bridges/adaptor.test.js +264 -0
- package/dist/web/bridges/adaptor.test.js.map +1 -0
- package/dist/web/bridges/apps-sdk/bridge.d.ts +6 -2
- package/dist/web/bridges/apps-sdk/bridge.js +15 -4
- package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
- package/dist/web/bridges/apps-sdk/index.d.ts +0 -1
- package/dist/web/bridges/apps-sdk/index.js +0 -1
- package/dist/web/bridges/apps-sdk/index.js.map +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +4 -4
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +4 -4
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
- package/dist/web/bridges/get-adaptor.d.ts +4 -4
- package/dist/web/bridges/get-adaptor.js +6 -11
- package/dist/web/bridges/get-adaptor.js.map +1 -1
- package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
- package/dist/web/bridges/get-adaptor.test.js +32 -0
- package/dist/web/bridges/get-adaptor.test.js.map +1 -0
- package/dist/web/bridges/mcp-app/bridge.d.ts +14 -3
- package/dist/web/bridges/mcp-app/bridge.js +60 -9
- package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
- package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
- package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
- package/dist/web/bridges/mcp-app/index.d.ts +0 -1
- package/dist/web/bridges/mcp-app/index.js +0 -1
- package/dist/web/bridges/mcp-app/index.js.map +1 -1
- package/dist/web/bridges/mcp-app/types.d.ts +19 -2
- package/dist/web/bridges/mcp-app/types.js.map +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +2 -2
- 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 +6 -7
- package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -1
- package/dist/web/bridges/types.d.ts +83 -15
- package/dist/web/bridges/types.js +14 -1
- package/dist/web/bridges/types.js.map +1 -1
- package/dist/web/bridges/types.test.d.ts +1 -0
- package/dist/web/bridges/types.test.js +19 -0
- package/dist/web/bridges/types.test.js.map +1 -0
- package/dist/web/components/modal-provider.d.ts +1 -1
- package/dist/web/components/modal-provider.js +4 -3
- package/dist/web/components/modal-provider.js.map +1 -1
- package/dist/web/create-store.test.js +10 -7
- package/dist/web/create-store.test.js.map +1 -1
- package/dist/web/data-llm.d.ts +1 -1
- package/dist/web/data-llm.js +3 -2
- package/dist/web/data-llm.js.map +1 -1
- package/dist/web/data-llm.test.js +26 -7
- package/dist/web/data-llm.test.js.map +1 -1
- package/dist/web/generate-helpers.d.ts +23 -19
- package/dist/web/generate-helpers.js +21 -17
- 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 +6 -1
- package/dist/web/hooks/index.js +6 -1
- package/dist/web/hooks/index.js.map +1 -1
- package/dist/web/hooks/openai-extensions.test.d.ts +1 -0
- package/dist/web/hooks/openai-extensions.test.js +107 -0
- package/dist/web/hooks/openai-extensions.test.js.map +1 -0
- 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.d.ts +2 -2
- package/dist/web/hooks/use-call-tool.js +15 -10
- package/dist/web/hooks/use-call-tool.js.map +1 -1
- package/dist/web/hooks/use-call-tool.test.js +50 -25
- package/dist/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/web/hooks/use-deep-link.d.ts +22 -0
- package/dist/web/hooks/use-deep-link.js +34 -0
- package/dist/web/hooks/use-deep-link.js.map +1 -0
- 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 +57 -21
- 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 +18 -10
- package/dist/web/hooks/use-download.test.js.map +1 -1
- package/dist/web/hooks/use-file-resource.d.ts +37 -0
- package/dist/web/hooks/use-file-resource.js +98 -0
- package/dist/web/hooks/use-file-resource.js.map +1 -0
- package/dist/web/hooks/use-file-resource.test.d.ts +1 -0
- package/dist/web/hooks/use-file-resource.test.js +65 -0
- package/dist/web/hooks/use-file-resource.test.js.map +1 -0
- package/dist/web/hooks/use-files.test.js +11 -3
- package/dist/web/hooks/use-files.test.js.map +1 -1
- package/dist/web/hooks/use-host.d.ts +44 -0
- package/dist/web/hooks/use-host.js +45 -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-model-context.d.ts +44 -0
- package/dist/web/hooks/use-model-context.js +63 -0
- package/dist/web/hooks/use-model-context.js.map +1 -0
- package/dist/web/hooks/use-open-external.test.js +15 -5
- package/dist/web/hooks/use-open-external.test.js.map +1 -1
- package/dist/web/hooks/use-open-file.d.ts +20 -0
- package/dist/web/hooks/use-open-file.js +25 -0
- package/dist/web/hooks/use-open-file.js.map +1 -0
- package/dist/web/hooks/use-register-view-tool.d.ts +3 -4
- package/dist/web/hooks/use-register-view-tool.js +1 -1
- package/dist/web/hooks/use-register-view-tool.js.map +1 -1
- package/dist/web/hooks/use-request-close.test.js +35 -40
- package/dist/web/hooks/use-request-close.test.js.map +1 -1
- package/dist/web/hooks/use-request-modal.test.js +11 -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 +35 -53
- package/dist/web/hooks/use-request-size.test.js.map +1 -1
- package/dist/web/hooks/use-send-follow-up-message.d.ts +8 -2
- package/dist/web/hooks/use-send-follow-up-message.js +6 -0
- package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
- package/dist/web/hooks/use-set-open-in-app-url.test.js +26 -12
- 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 +38 -33
- 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 +85 -37
- 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 +39 -4
- 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-viewport.test.js +109 -0
- 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 +32 -29
- package/dist/cli/resolve-views-dir.d.ts +0 -1
- package/dist/cli/resolve-views-dir.js.map +0 -1
- package/dist/web/bridges/apps-sdk/adaptor.d.ts +0 -29
- package/dist/web/bridges/apps-sdk/adaptor.js +0 -117
- package/dist/web/bridges/apps-sdk/adaptor.js.map +0 -1
- package/dist/web/bridges/mcp-app/adaptor.d.ts +0 -53
- package/dist/web/bridges/mcp-app/adaptor.js +0 -283
- package/dist/web/bridges/mcp-app/adaptor.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 +0 -96
- 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,11 @@
|
|
|
1
1
|
import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
|
|
2
|
-
import { type ServerOptions } from "@modelcontextprotocol/
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
7
|
-
import
|
|
8
|
-
import type
|
|
9
|
-
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
2
|
+
import { type ContentBlock, type Icon, type Implementation, McpServer as McpServerBase, type RequestMeta, type ResourceLink, type ServerOptions, type ServerResult, type StandardSchemaV1, type StandardSchemaWithJSON, type ToolAnnotations } from "@modelcontextprotocol/server";
|
|
3
|
+
import type express from "express";
|
|
4
|
+
import { z } from "zod/v4";
|
|
5
|
+
import type { ResourceMetadataUrlResolver } from "./auth/setup.js";
|
|
6
|
+
import type { ExtraClaims } from "./auth.js";
|
|
7
|
+
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareEntry, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
8
|
+
import { type SkillsManifest } from "./skills.js";
|
|
10
9
|
/**
|
|
11
10
|
* Type marker for a registered tool — carries its input, output, and response
|
|
12
11
|
* metadata shapes so views can infer types from `typeof server`.
|
|
@@ -19,8 +18,6 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
|
|
|
19
18
|
output: TOutput;
|
|
20
19
|
responseMetadata: TResponseMetadata;
|
|
21
20
|
};
|
|
22
|
-
/** Which host runtime a view targets — `"apps-sdk"` (ChatGPT) or `"mcp-app"` (MCP Apps spec). */
|
|
23
|
-
export type ViewHostType = "apps-sdk" | "mcp-app";
|
|
24
21
|
/**
|
|
25
22
|
* Content Security Policy origins attached to a view's resource. Each list is
|
|
26
23
|
* passed through to the host's CSP for the view iframe; omit a field to inherit
|
|
@@ -31,7 +28,7 @@ export interface ViewCsp {
|
|
|
31
28
|
resourceDomains?: string[];
|
|
32
29
|
/** Origins the view may contact via fetch/XHR. */
|
|
33
30
|
connectDomains?: string[];
|
|
34
|
-
/** Origins allowed for iframe embeds (opts into stricter
|
|
31
|
+
/** Origins allowed for iframe embeds (opts into stricter plugin review). */
|
|
35
32
|
frameDomains?: string[];
|
|
36
33
|
/** Origins that can receive openExternal redirects without the safe-link modal. */
|
|
37
34
|
redirectDomains?: string[];
|
|
@@ -45,8 +42,16 @@ export interface ViewCsp {
|
|
|
45
42
|
*/
|
|
46
43
|
export interface ViewNameRegistry {
|
|
47
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* Resolve view component names from a registry: the union of its keys, or
|
|
47
|
+
* `string` when the registry is empty. The empty case happens before
|
|
48
|
+
* `.skybridge/views.d.ts` is generated; falling back to `string` keeps valid
|
|
49
|
+
* view names from erroring on a fresh checkout, and narrowing kicks in once
|
|
50
|
+
* the generated file augments the registry.
|
|
51
|
+
*/
|
|
52
|
+
export type ViewNameFor<Registry> = [keyof Registry & string] extends [never] ? string : keyof Registry & string;
|
|
48
53
|
/** Union of valid view component names. Narrowed by {@link ViewNameRegistry}. */
|
|
49
|
-
export type ViewName =
|
|
54
|
+
export type ViewName = ViewNameFor<ViewNameRegistry>;
|
|
50
55
|
/**
|
|
51
56
|
* Pass under `view` in a tool's `registerTool` config to render the tool's
|
|
52
57
|
* result through a Skybridge view instead of a plain text response.
|
|
@@ -56,11 +61,9 @@ export interface ViewConfig {
|
|
|
56
61
|
component: ViewName;
|
|
57
62
|
/** Human-readable label the host may show alongside the view. */
|
|
58
63
|
description?: string;
|
|
59
|
-
/**
|
|
60
|
-
hosts?: ViewHostType[];
|
|
61
|
-
/** Apps SDK only: request a visible border around the widget. */
|
|
64
|
+
/** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
|
|
62
65
|
prefersBorder?: boolean;
|
|
63
|
-
/**
|
|
66
|
+
/** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
|
|
64
67
|
domain?: string;
|
|
65
68
|
/** Per-view CSP overrides — see {@link ViewCsp}. */
|
|
66
69
|
csp?: ViewCsp;
|
|
@@ -73,36 +76,115 @@ export type SecurityScheme = {
|
|
|
73
76
|
type: "oauth2";
|
|
74
77
|
scopes?: string[];
|
|
75
78
|
};
|
|
79
|
+
/** A display mode ChatGPT can render a view in. ChatGPT doesn't support `pip`. */
|
|
80
|
+
export type OpenAIDisplayMode = "inline" | "fullscreen";
|
|
81
|
+
/** A sidebar shortcut that calls another tool of the same server. */
|
|
82
|
+
export interface OpenAIQuickAction {
|
|
83
|
+
title: string;
|
|
84
|
+
icons: [Icon, ...Icon[]];
|
|
85
|
+
target: {
|
|
86
|
+
type: "tool";
|
|
87
|
+
name: string;
|
|
88
|
+
arguments?: Record<string, unknown>;
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* A place in ChatGPT where users can open the tool's view without the model.
|
|
93
|
+
*
|
|
94
|
+
* - `global`: an entry in the sidebar, opened fullscreen.
|
|
95
|
+
* - `thread`: a tab in a conversation's side panel.
|
|
96
|
+
* - `file`: a viewer for files with these extensions, such as `".stl"`.
|
|
97
|
+
* ChatGPT calls the tool with `{ file: { name, resourceUri } }`.
|
|
98
|
+
* - `settings`: an entry in the plugin settings.
|
|
99
|
+
*
|
|
100
|
+
* ChatGPT calls the tool with `{}` for global and thread entrypoints, so the
|
|
101
|
+
* tool must not require any input.
|
|
102
|
+
*/
|
|
103
|
+
export type OpenAIEntrypoint = {
|
|
104
|
+
type: "global";
|
|
105
|
+
quickAction?: OpenAIQuickAction;
|
|
106
|
+
} | {
|
|
107
|
+
type: "thread";
|
|
108
|
+
} | {
|
|
109
|
+
type: "file";
|
|
110
|
+
extensions: string[];
|
|
111
|
+
} | {
|
|
112
|
+
type: "settings";
|
|
113
|
+
searchTerms?: string[];
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* ChatGPT-only tool options, emitted as `_meta["openai/ui"]` on the tool and
|
|
117
|
+
* on its view resource. Every field is optional: ChatGPT applies the defaults
|
|
118
|
+
* of the OpenAI MCP extensions spec when one is omitted. Requires `view`.
|
|
119
|
+
*
|
|
120
|
+
* @see https://github.com/openai/mcp-extensions/blob/main/docs/spec.md
|
|
121
|
+
*/
|
|
122
|
+
export interface OpenAIToolConfig {
|
|
123
|
+
/** Places where users can open the view directly. */
|
|
124
|
+
entrypoints?: OpenAIEntrypoint[];
|
|
125
|
+
/**
|
|
126
|
+
* Display modes the view supports, read before the view loads. Defaults to
|
|
127
|
+
* `[preferredDisplayMode]` when that is set, otherwise to both modes.
|
|
128
|
+
*/
|
|
129
|
+
availableDisplayModes?: OpenAIDisplayMode[];
|
|
130
|
+
/**
|
|
131
|
+
* Display mode the view prefers to open in. Setting it alone makes it the
|
|
132
|
+
* only available mode, so also set `availableDisplayModes` to keep the other.
|
|
133
|
+
*/
|
|
134
|
+
preferredDisplayMode?: OpenAIDisplayMode;
|
|
135
|
+
/** Display mode the view opens in first when the model calls the tool. */
|
|
136
|
+
preferredModelDisplayMode?: OpenAIDisplayMode;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Declarative per-tool auth. Enforced when the server has an `oauth` provider:
|
|
140
|
+
* anonymous or under-scoped calls are rejected before the handler runs. Omit
|
|
141
|
+
* `auth` entirely for the secure default (sign-in required, no specific scope).
|
|
142
|
+
*/
|
|
143
|
+
export type ToolAuth = {
|
|
144
|
+
/**
|
|
145
|
+
* When `true`, the tool is callable signed out; the token is still used when
|
|
146
|
+
* one is present. Omit (or `false`) to require sign-in.
|
|
147
|
+
*/
|
|
148
|
+
allowsAnonymous?: boolean;
|
|
149
|
+
/** OAuth scopes the caller's token must carry to invoke the tool. */
|
|
150
|
+
scopes?: string[];
|
|
151
|
+
};
|
|
76
152
|
/**
|
|
77
153
|
* Options forwarded to the built-in `express.json()` body parser. Derived
|
|
78
154
|
* from Express's own types so the public API doesn't depend on `body-parser`.
|
|
79
155
|
*/
|
|
80
156
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
81
|
-
/**
|
|
157
|
+
/**
|
|
158
|
+
* The Skybridge-specific options an {@link McpServer} is built with. A
|
|
159
|
+
* {@link Skybridge} app derives them from its config; pass them directly only
|
|
160
|
+
* when constructing an `McpServer` by hand.
|
|
161
|
+
*/
|
|
82
162
|
export interface SkybridgeServerOptions {
|
|
83
|
-
/**
|
|
84
|
-
|
|
85
|
-
/**
|
|
86
|
-
|
|
163
|
+
/** Whether an OAuth provider guards `/mcp`; enables per-tool scheme enforcement. */
|
|
164
|
+
oauth?: boolean;
|
|
165
|
+
/**
|
|
166
|
+
* @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
|
|
167
|
+
* API may change.
|
|
168
|
+
*/
|
|
169
|
+
skills?: boolean;
|
|
87
170
|
}
|
|
88
171
|
/**
|
|
89
172
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
90
173
|
* Use {@link ToolMeta} to also pass arbitrary custom metadata alongside these.
|
|
91
174
|
*
|
|
92
|
-
* @see https://developers.openai.com/
|
|
175
|
+
* @see https://developers.openai.com/plugins/reference#tool-descriptor-parameters
|
|
93
176
|
*/
|
|
94
177
|
export interface KnownToolMeta {
|
|
95
|
-
/**
|
|
178
|
+
/** ChatGPT: allow the rendered view to call this tool from inside its iframe. */
|
|
96
179
|
"openai/widgetAccessible"?: boolean;
|
|
97
|
-
/**
|
|
180
|
+
/** ChatGPT: status text shown while the tool is running (e.g. `"Searching trips"`). */
|
|
98
181
|
"openai/toolInvocation/invoking"?: string;
|
|
99
|
-
/**
|
|
182
|
+
/** ChatGPT: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
|
|
100
183
|
"openai/toolInvocation/invoked"?: string;
|
|
101
|
-
/**
|
|
184
|
+
/** ChatGPT: input parameters that hold file references — the host attaches uploaded files to them. */
|
|
102
185
|
"openai/fileParams"?: string[];
|
|
103
186
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
104
187
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
105
|
-
securitySchemes?: SecurityScheme[];
|
|
106
188
|
}
|
|
107
189
|
/** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
|
|
108
190
|
export type ToolMeta = KnownToolMeta & Record<string, unknown>;
|
|
@@ -128,10 +210,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
128
210
|
type Simplify<T> = {
|
|
129
211
|
[K in keyof T]: T[K];
|
|
130
212
|
};
|
|
131
|
-
type ShapeOutput<Shape extends
|
|
132
|
-
[K in keyof Shape as undefined extends
|
|
213
|
+
type ShapeOutput<Shape extends Record<string, StandardSchemaWithJSON>> = Simplify<{
|
|
214
|
+
[K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? never : K]: StandardSchemaV1.InferOutput<Shape[K]>;
|
|
133
215
|
} & {
|
|
134
|
-
[K in keyof Shape as undefined extends
|
|
216
|
+
[K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? K : never]?: StandardSchemaV1.InferOutput<Shape[K]>;
|
|
135
217
|
}>;
|
|
136
218
|
type ExtractStructuredContent<T> = T extends {
|
|
137
219
|
structuredContent: infer SC;
|
|
@@ -143,17 +225,36 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
143
225
|
}> extends {
|
|
144
226
|
_meta: infer M;
|
|
145
227
|
} ? Simplify<M> : unknown;
|
|
146
|
-
type AddTool<TTools, TName extends string, TInput extends
|
|
228
|
+
type AddTool<TTools, TName extends string, TInput extends Record<string, StandardSchemaWithJSON>, TOutput, TResponseMetadata = unknown, TAuthExtra extends ExtraClaims = ExtraClaims> = McpServer<TTools & {
|
|
147
229
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
148
|
-
}>;
|
|
149
|
-
interface
|
|
230
|
+
}, TAuthExtra>;
|
|
231
|
+
interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
|
|
150
232
|
name: string;
|
|
151
233
|
title?: string;
|
|
152
234
|
description?: string;
|
|
153
235
|
inputSchema?: TInput;
|
|
154
|
-
outputSchema?:
|
|
236
|
+
outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
155
237
|
annotations?: ToolAnnotations;
|
|
238
|
+
/**
|
|
239
|
+
* Icons for the tool, a standard MCP field. Hosts choose whether and where
|
|
240
|
+
* to show them. ChatGPT asks for them on every entrypoint tool, as a
|
|
241
|
+
* monochrome SVG on a 20x20 viewport that uses `currentColor`.
|
|
242
|
+
*/
|
|
243
|
+
icons?: Icon[];
|
|
156
244
|
view?: ViewConfig;
|
|
245
|
+
/** ChatGPT-only options. See {@link OpenAIToolConfig}. */
|
|
246
|
+
openai?: OpenAIToolConfig;
|
|
247
|
+
_meta?: ToolMeta;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* The auth face of a tool config: either the high-level `auth` shorthand or the
|
|
251
|
+
* low-level `securitySchemes` escape hatch, never both.
|
|
252
|
+
*/
|
|
253
|
+
type ToolAuthConfig = {
|
|
254
|
+
auth?: ToolAuth;
|
|
255
|
+
securitySchemes?: never;
|
|
256
|
+
} | {
|
|
257
|
+
auth?: never;
|
|
157
258
|
/**
|
|
158
259
|
* Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
|
|
159
260
|
* Lets clients label tools that require sign-in before calling, and pass
|
|
@@ -162,13 +263,29 @@ interface ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> {
|
|
|
162
263
|
* enhanced behavior to authenticated ones.
|
|
163
264
|
*/
|
|
164
265
|
securitySchemes?: SecurityScheme[];
|
|
165
|
-
|
|
166
|
-
|
|
266
|
+
};
|
|
267
|
+
type ToolConfig<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> = ToolConfigBase<TInput> & ToolAuthConfig;
|
|
268
|
+
declare const fileEntrypointInput: {
|
|
269
|
+
file: z.ZodObject<{
|
|
270
|
+
name: z.ZodString;
|
|
271
|
+
resourceUri: z.ZodString;
|
|
272
|
+
}, z.core.$strip>;
|
|
273
|
+
};
|
|
274
|
+
type FileEntrypointInput = typeof fileEntrypointInput;
|
|
275
|
+
/** A ChatGPT file viewer, registered with `server.registerFileViewer`. */
|
|
276
|
+
export type OpenAIFileViewerConfig<TName extends string = string> = Omit<ToolConfigBase<FileEntrypointInput>, "inputSchema" | "openai" | "view"> & ToolAuthConfig & {
|
|
277
|
+
name: TName;
|
|
278
|
+
/** File extensions the viewer opens, each starting with `.`. */
|
|
279
|
+
extensions: string[];
|
|
280
|
+
view: ViewConfig;
|
|
281
|
+
/** Display modes. The file entrypoint is set from `extensions`. */
|
|
282
|
+
openai?: Omit<OpenAIToolConfig, "entrypoints">;
|
|
283
|
+
};
|
|
167
284
|
/**
|
|
168
285
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
169
|
-
* by the
|
|
286
|
+
* by the ChatGPT host. Hints only: never use for authorization, and tolerate
|
|
170
287
|
* absence.
|
|
171
|
-
* @see https://developers.openai.com/
|
|
288
|
+
* @see https://developers.openai.com/plugins/reference#_meta-fields-the-client-provides
|
|
172
289
|
*/
|
|
173
290
|
export interface ClientHintsMeta {
|
|
174
291
|
/** Requested locale (BCP-47, e.g. `"en-US"`). */
|
|
@@ -192,15 +309,77 @@ export interface ClientHintsMeta {
|
|
|
192
309
|
"openai/organization"?: string;
|
|
193
310
|
/** Stable id for the currently mounted widget instance. */
|
|
194
311
|
"openai/widgetSessionId"?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Set by ChatGPT desktop on tool calls from a view opened through a file
|
|
314
|
+
* entrypoint. `path` is the absolute path of the opened file. Any MCP client
|
|
315
|
+
* can send this key: never use it for authorization, and resolve the path
|
|
316
|
+
* and keep it inside an allowed directory before touching the filesystem.
|
|
317
|
+
*/
|
|
318
|
+
"openai/resource"?: {
|
|
319
|
+
path?: string;
|
|
320
|
+
};
|
|
195
321
|
}
|
|
196
|
-
type ToolHandlerExtra = Omit<
|
|
197
|
-
_meta
|
|
322
|
+
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
323
|
+
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
324
|
+
_meta?: RequestMeta & ClientHintsMeta;
|
|
325
|
+
};
|
|
198
326
|
};
|
|
199
|
-
|
|
327
|
+
/** Composer at-mention search, registered with `server.registerMentions`. */
|
|
328
|
+
export interface OpenAIMentionsConfig<TAuthExtra extends ExtraClaims = ExtraClaims> {
|
|
329
|
+
/** Name of the tool ChatGPT calls for each search. */
|
|
330
|
+
name: string;
|
|
331
|
+
description?: string;
|
|
332
|
+
/** Returns the items matching the typed text, which may be empty. */
|
|
333
|
+
handler: (params: {
|
|
334
|
+
query: string;
|
|
335
|
+
}, extra: ToolHandlerExtra<TAuthExtra>) => Promise<{
|
|
336
|
+
items: ResourceLink[];
|
|
337
|
+
}> | {
|
|
338
|
+
items: ResourceLink[];
|
|
339
|
+
};
|
|
340
|
+
}
|
|
341
|
+
/** One setting, registered with `server.registerSettings`. */
|
|
342
|
+
export interface OpenAISettingsField {
|
|
343
|
+
/** A boolean, string, string enum, number or integer schema, without a default. */
|
|
344
|
+
schema: z.ZodType<boolean | string | number>;
|
|
345
|
+
title: string;
|
|
346
|
+
description?: string;
|
|
347
|
+
}
|
|
348
|
+
/** Values of every setting, keyed by field name. */
|
|
349
|
+
export type OpenAISettingsValues<TFields extends Record<string, OpenAISettingsField>> = {
|
|
350
|
+
[K in keyof TFields]-?: Exclude<z.output<TFields[K]["schema"]>, undefined>;
|
|
351
|
+
};
|
|
352
|
+
/** App settings in ChatGPT, registered with `server.registerSettings`. */
|
|
353
|
+
export interface OpenAISettingsConfig<TFields extends Record<string, OpenAISettingsField>, TAuthExtra extends ExtraClaims = ExtraClaims> {
|
|
354
|
+
fields: TFields;
|
|
355
|
+
/** Sections of the settings page. Fields left out appear under "Other settings". */
|
|
356
|
+
layout?: {
|
|
357
|
+
kind: "group";
|
|
358
|
+
title: string;
|
|
359
|
+
items: ({
|
|
360
|
+
kind: "property";
|
|
361
|
+
property: Extract<keyof TFields, string>;
|
|
362
|
+
} | {
|
|
363
|
+
kind: "tool";
|
|
364
|
+
tool: string;
|
|
365
|
+
title: string;
|
|
366
|
+
description?: string;
|
|
367
|
+
})[];
|
|
368
|
+
}[];
|
|
369
|
+
/** Returns the current value of every field. */
|
|
370
|
+
read: (extra: ToolHandlerExtra<TAuthExtra>) => OpenAISettingsValues<TFields> | Promise<OpenAISettingsValues<TFields>>;
|
|
371
|
+
/** Saves the changed fields and returns the value of every field. */
|
|
372
|
+
update: (set: Partial<OpenAISettingsValues<TFields>>, extra: ToolHandlerExtra<TAuthExtra>) => OpenAISettingsValues<TFields> | Promise<OpenAISettingsValues<TFields>>;
|
|
373
|
+
/** Name of the read tool. Defaults to `settings.read`. */
|
|
374
|
+
readTool?: string;
|
|
375
|
+
/** Name of the update tool. Defaults to `settings.update`. */
|
|
376
|
+
updateTool?: string;
|
|
377
|
+
}
|
|
378
|
+
type ToolHandler<TInput extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
200
379
|
content?: HandlerContent;
|
|
201
380
|
} = {
|
|
202
381
|
content?: HandlerContent;
|
|
203
|
-
}> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
|
|
382
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
204
383
|
/**
|
|
205
384
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
206
385
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -221,26 +400,39 @@ declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof M
|
|
|
221
400
|
export declare function __setBuildManifest(manifest: Record<string, {
|
|
222
401
|
file: string;
|
|
223
402
|
}>): void;
|
|
224
|
-
export declare
|
|
403
|
+
export declare function __setSkillsManifest(manifest: SkillsManifest): void;
|
|
404
|
+
/**
|
|
405
|
+
* Typed registration sugar over the MCP SDK's `McpServer`: a tool registry
|
|
406
|
+
* that carries input/output/meta shapes, view resources, per-tool security
|
|
407
|
+
* schemes, and prompt/resource registration. A {@link Skybridge} app builds
|
|
408
|
+
* one of these per request and hands it to your `handler`; chain
|
|
409
|
+
* {@link McpServer.registerTool} calls on it and return the result.
|
|
410
|
+
*
|
|
411
|
+
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
412
|
+
* shape, so `typeof app` carries enough information for view-side helpers
|
|
413
|
+
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
414
|
+
*
|
|
415
|
+
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
416
|
+
* chaining; you almost never set this manually.
|
|
417
|
+
*
|
|
418
|
+
* @example
|
|
419
|
+
* ```ts
|
|
420
|
+
* export const app = new Skybridge({
|
|
421
|
+
* name: "my-app",
|
|
422
|
+
* version: "1.0.0",
|
|
423
|
+
* handler: (server) =>
|
|
424
|
+
* server.registerTool({
|
|
425
|
+
* name: "search",
|
|
426
|
+
* inputSchema: { query: z.string() },
|
|
427
|
+
* view: { component: "search" },
|
|
428
|
+
* }, async ({ query }) => ({ content: `Results for ${query}` })),
|
|
429
|
+
* });
|
|
430
|
+
* ```
|
|
431
|
+
*
|
|
432
|
+
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
433
|
+
*/
|
|
434
|
+
export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>, TAuthExtra extends ExtraClaims = ExtraClaims> extends McpServerBaseOmitted {
|
|
225
435
|
readonly $types: McpServerTypes<TTools>;
|
|
226
|
-
/**
|
|
227
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
228
|
-
* custom routes, middleware, or settings — e.g.
|
|
229
|
-
* `server.express.get("/health", ...)`.
|
|
230
|
-
*
|
|
231
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
232
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
233
|
-
* Register your handlers before `run()`;
|
|
234
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
235
|
-
* error handler are appended in that order.
|
|
236
|
-
*
|
|
237
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
238
|
-
* locally and on self-hosted deployments.
|
|
239
|
-
*/
|
|
240
|
-
readonly express: Express;
|
|
241
|
-
private customErrorMiddleware;
|
|
242
|
-
private mcpMiddlewareEntries;
|
|
243
|
-
private mcpMiddlewareApplied;
|
|
244
436
|
private claimedViews;
|
|
245
437
|
private viewMetaBuilders;
|
|
246
438
|
/**
|
|
@@ -251,41 +443,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
251
443
|
*/
|
|
252
444
|
private viewUriByPath;
|
|
253
445
|
private viteManifest;
|
|
254
|
-
private
|
|
255
|
-
private
|
|
446
|
+
private oauthEnabled;
|
|
447
|
+
private resolveResourceMetadataUrl?;
|
|
448
|
+
private readonly toolSecuritySchemes;
|
|
449
|
+
private readonly userMiddlewareEntries;
|
|
256
450
|
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
|
|
257
451
|
/**
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
452
|
+
* The per-tool security schemes collected during registration, keyed by tool
|
|
453
|
+
* name. Read by the OAuth layer to decide whether anonymous requests are
|
|
454
|
+
* allowed and which schemes gate a given `tools/call`.
|
|
261
455
|
*
|
|
262
|
-
*
|
|
263
|
-
* locally and on self-hosted deployments.
|
|
456
|
+
* @internal
|
|
264
457
|
*/
|
|
265
|
-
|
|
266
|
-
use(path: string, ...handlers: RequestHandler[]): this;
|
|
458
|
+
get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
|
|
267
459
|
/**
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
* thrown by tool handlers before the default error handler responds.
|
|
460
|
+
* Inject the resolver the app uses to build the protected-resource metadata
|
|
461
|
+
* URL, so tool handlers can emit in-band auth challenges.
|
|
271
462
|
*
|
|
272
|
-
* @
|
|
273
|
-
* ```ts
|
|
274
|
-
* server.useOnError((err, _req, _res, next) => {
|
|
275
|
-
* logger.error(err);
|
|
276
|
-
* next(err);
|
|
277
|
-
* });
|
|
278
|
-
* ```
|
|
463
|
+
* @internal
|
|
279
464
|
*/
|
|
280
|
-
|
|
281
|
-
|
|
465
|
+
setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
|
|
466
|
+
private setupSkills;
|
|
282
467
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
283
|
-
mcpMiddleware(handler: McpMiddlewareFn): this;
|
|
468
|
+
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
284
469
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
285
470
|
mcpMiddleware(filter: "request", handler: (request: {
|
|
286
471
|
method: string;
|
|
287
472
|
params: Record<string, unknown>;
|
|
288
|
-
}, extra: McpExtra
|
|
473
|
+
}, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
|
|
289
474
|
/** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
|
|
290
475
|
mcpMiddleware(filter: "notification", handler: (request: {
|
|
291
476
|
method: string;
|
|
@@ -295,7 +480,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
295
480
|
* Register MCP protocol-level middleware for an exact method.
|
|
296
481
|
* Narrows `params`, `extra`, and `next()` result based on the method string.
|
|
297
482
|
*/
|
|
298
|
-
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
|
|
483
|
+
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
|
|
299
484
|
/**
|
|
300
485
|
* Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
|
|
301
486
|
* `next()` returns the union of result types for matching methods.
|
|
@@ -303,54 +488,28 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
303
488
|
mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
|
|
304
489
|
method: string;
|
|
305
490
|
params: Record<string, unknown>;
|
|
306
|
-
}, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
491
|
+
}, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
307
492
|
/**
|
|
308
493
|
* Register MCP protocol-level middleware with a method filter.
|
|
309
494
|
* Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
|
|
310
495
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
311
496
|
*/
|
|
312
|
-
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
|
|
313
|
-
private applyMcpMiddleware;
|
|
314
|
-
/**
|
|
315
|
-
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
316
|
-
* when you're embedding Skybridge in a host that already manages its own
|
|
317
|
-
* transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
|
|
318
|
-
* which sets the transport up for you. Locks in any middleware registered
|
|
319
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
320
|
-
* throw afterwards.
|
|
321
|
-
*/
|
|
322
|
-
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
497
|
+
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
323
498
|
/**
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
* we build a fresh underlying `Server` per request and share the main
|
|
329
|
-
* server's handler maps by reference. The cast is unavoidable: there's
|
|
330
|
-
* no public API to inject handler maps. `getHandlerMaps` validates the
|
|
331
|
-
* read side and fails fast on SDK field renames.
|
|
332
|
-
*/
|
|
333
|
-
connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
334
|
-
/**
|
|
335
|
-
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
336
|
-
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
337
|
-
* via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
|
|
338
|
-
* any MCP middleware registered via {@link McpServer.mcpMiddleware}.
|
|
499
|
+
* This instance's protocol-level middleware: the framework's own entries
|
|
500
|
+
* (view `_meta` on `resources/list`, version-agnostic view resolution on
|
|
501
|
+
* `resources/read`, the top-level `securitySchemes` mirror on `tools/list`)
|
|
502
|
+
* followed by the ones registered via {@link McpServer.mcpMiddleware}.
|
|
339
503
|
*
|
|
340
|
-
*
|
|
341
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
342
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
343
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
344
|
-
* Node, returns `undefined` once listening.
|
|
504
|
+
* @internal
|
|
345
505
|
*/
|
|
346
|
-
|
|
347
|
-
fetch: (...args: unknown[]) => unknown;
|
|
348
|
-
} | Express | undefined>;
|
|
506
|
+
protocolMiddlewareEntries(): McpMiddlewareEntry[];
|
|
349
507
|
private enforceOneToolPerView;
|
|
350
508
|
private resolveViewRequestContext;
|
|
351
509
|
private registerViewResources;
|
|
352
510
|
private registerViewResource;
|
|
353
|
-
private
|
|
511
|
+
private serveLegacyAppsSdkUrl;
|
|
512
|
+
private decorateToolHandler;
|
|
354
513
|
private computeViewVersionParam;
|
|
355
514
|
private lookupViewFile;
|
|
356
515
|
private lookupDistFile;
|
|
@@ -364,6 +523,75 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
364
523
|
file: string;
|
|
365
524
|
}>): this;
|
|
366
525
|
private readManifest;
|
|
526
|
+
/**
|
|
527
|
+
* Register a ChatGPT file viewer, from the OpenAI MCP extensions: a tool
|
|
528
|
+
* with a file entrypoint for `extensions` and a view. ChatGPT desktop calls
|
|
529
|
+
* it with the file the user opened, as `{ file: { name, resourceUri } }`.
|
|
530
|
+
* Read and save the file from the view with `useFileResource`.
|
|
531
|
+
*
|
|
532
|
+
* @example
|
|
533
|
+
* ```ts
|
|
534
|
+
* server.registerFileViewer(
|
|
535
|
+
* {
|
|
536
|
+
* name: "part-viewer",
|
|
537
|
+
* title: "Part Viewer",
|
|
538
|
+
* extensions: [".stl", ".step"],
|
|
539
|
+
* view: { component: "part-viewer" },
|
|
540
|
+
* },
|
|
541
|
+
* async ({ file }) => ({ structuredContent: { name: file.name } }),
|
|
542
|
+
* );
|
|
543
|
+
* ```
|
|
544
|
+
*
|
|
545
|
+
* @see https://docs.skybridge.tech/api-reference/register-file-viewer
|
|
546
|
+
*/
|
|
547
|
+
registerFileViewer<TName extends string, TReturn extends {
|
|
548
|
+
content?: HandlerContent;
|
|
549
|
+
}>(config: OpenAIFileViewerConfig<TName>, cb: ToolHandler<FileEntrypointInput, TReturn, TAuthExtra>): AddTool<TTools, TName, FileEntrypointInput, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
550
|
+
/**
|
|
551
|
+
* Register the composer at-mention search for ChatGPT, from the OpenAI MCP
|
|
552
|
+
* extensions. When the user types `@` and your app name, ChatGPT calls
|
|
553
|
+
* `handler` with the typed text and lists the returned resource links.
|
|
554
|
+
* Skybridge registers it as a tool hidden from the model.
|
|
555
|
+
*
|
|
556
|
+
* @example
|
|
557
|
+
* ```ts
|
|
558
|
+
* server.registerMentions({
|
|
559
|
+
* name: "search_parts",
|
|
560
|
+
* handler: async ({ query }) => ({
|
|
561
|
+
* items: findParts(query).map((part) => ({
|
|
562
|
+
* type: "resource_link",
|
|
563
|
+
* uri: `parts://${part.id}`,
|
|
564
|
+
* name: part.name,
|
|
565
|
+
* })),
|
|
566
|
+
* }),
|
|
567
|
+
* });
|
|
568
|
+
* ```
|
|
569
|
+
*
|
|
570
|
+
* @see https://docs.skybridge.tech/api-reference/register-mentions
|
|
571
|
+
*/
|
|
572
|
+
registerMentions(config: OpenAIMentionsConfig<TAuthExtra>): this;
|
|
573
|
+
/**
|
|
574
|
+
* Register app settings for ChatGPT, from the OpenAI MCP extensions.
|
|
575
|
+
* Skybridge registers a read tool and an update tool from `fields`, and
|
|
576
|
+
* advertises them in the `openai/settings` server capability. ChatGPT shows
|
|
577
|
+
* the settings page and calls `update` with the changed fields only. Store
|
|
578
|
+
* the values yourself, for example per user.
|
|
579
|
+
*
|
|
580
|
+
* @example
|
|
581
|
+
* ```ts
|
|
582
|
+
* server.registerSettings({
|
|
583
|
+
* fields: {
|
|
584
|
+
* units: { title: "Units", schema: z.enum(["mm", "in"]) },
|
|
585
|
+
* showGrid: { title: "Show grid", schema: z.boolean() },
|
|
586
|
+
* },
|
|
587
|
+
* read: (extra) => loadSettings(extra),
|
|
588
|
+
* update: (set, extra) => saveSettings(set, extra),
|
|
589
|
+
* });
|
|
590
|
+
* ```
|
|
591
|
+
*
|
|
592
|
+
* @see https://docs.skybridge.tech/api-reference/register-settings
|
|
593
|
+
*/
|
|
594
|
+
registerSettings<TFields extends Record<string, OpenAISettingsField>>(config: OpenAISettingsConfig<TFields, TAuthExtra>): this;
|
|
367
595
|
/**
|
|
368
596
|
* Register a tool. Pass a `config` describing the tool (name, schemas,
|
|
369
597
|
* optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
|
|
@@ -393,11 +621,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
393
621
|
*
|
|
394
622
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
395
623
|
*/
|
|
396
|
-
registerTool<TName extends string, InputArgs extends
|
|
624
|
+
registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
397
625
|
content?: HandlerContent;
|
|
398
626
|
}>(config: ToolConfig<InputArgs> & {
|
|
399
627
|
name: TName;
|
|
400
|
-
}, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn
|
|
401
|
-
registerTool<InputArgs extends
|
|
628
|
+
}, cb: ToolHandler<InputArgs, TReturn, TAuthExtra>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
629
|
+
registerTool<InputArgs extends Record<string, StandardSchemaWithJSON>>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, {
|
|
630
|
+
content?: HandlerContent;
|
|
631
|
+
}, TAuthExtra>): this;
|
|
402
632
|
}
|
|
403
633
|
export {};
|