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