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