skybridge 0.0.0-dev.93dffd6 → 0.0.0-dev.93e3f05
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/dist/cli/build-helpers.d.ts +3 -2
- package/dist/cli/build-helpers.js +24 -10
- package/dist/cli/build-helpers.js.map +1 -1
- package/dist/cli/build-helpers.test.js +48 -5
- package/dist/cli/build-helpers.test.js.map +1 -1
- package/dist/cli/build-steps.js +10 -5
- package/dist/cli/build-steps.js.map +1 -1
- package/dist/cli/build-steps.test.js +3 -3
- package/dist/cli/build-steps.test.js.map +1 -1
- package/dist/cli/detect-port.js +0 -1
- package/dist/cli/detect-port.js.map +1 -1
- package/dist/cli/resolve-skybridge-config.d.ts +5 -0
- package/dist/cli/{resolve-views-dir.js → resolve-skybridge-config.js} +4 -3
- package/dist/cli/resolve-skybridge-config.js.map +1 -0
- package/dist/cli/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-nodemon.d.ts +11 -1
- package/dist/cli/use-nodemon.js +31 -9
- 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 +24 -6
- package/dist/server/auth/providers/custom.js +33 -11
- package/dist/server/auth/providers/custom.js.map +1 -1
- package/dist/server/auth/providers/custom.test.js +71 -17
- package/dist/server/auth/providers/custom.test.js.map +1 -1
- package/dist/server/auth/providers/descope.d.ts +32 -3
- package/dist/server/auth/providers/descope.js +13 -2
- package/dist/server/auth/providers/descope.js.map +1 -1
- package/dist/server/auth/providers/descope.test.js +42 -17
- package/dist/server/auth/providers/descope.test.js.map +1 -1
- package/dist/server/auth/providers/stytch.d.ts +16 -3
- package/dist/server/auth/providers/stytch.js +4 -1
- package/dist/server/auth/providers/stytch.js.map +1 -1
- package/dist/server/auth/providers/verify-spy.d.ts +12 -0
- package/dist/server/auth/providers/verify-spy.js +21 -0
- package/dist/server/auth/providers/verify-spy.js.map +1 -0
- package/dist/server/auth/providers/workos.d.ts +28 -5
- package/dist/server/auth/providers/workos.js +6 -2
- package/dist/server/auth/providers/workos.js.map +1 -1
- package/dist/server/auth/security-schemes.d.ts +10 -0
- package/dist/server/auth/security-schemes.js +12 -1
- package/dist/server/auth/security-schemes.js.map +1 -1
- package/dist/server/auth/security-schemes.test.js +2 -2
- package/dist/server/auth/security-schemes.test.js.map +1 -1
- package/dist/server/auth/setup.d.ts +1 -1
- package/dist/server/auth/setup.js +10 -17
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +123 -59
- package/dist/server/auth/setup.test.js.map +1 -1
- package/dist/server/auth/verify.d.ts +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/index.d.ts +16 -9
- package/dist/server/index.js +9 -3
- package/dist/server/index.js.map +1 -1
- package/dist/server/mcp-errors.test.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 +223 -122
- package/dist/server/server.js +226 -292
- package/dist/server/server.js.map +1 -1
- package/dist/server/skills-integration.test.d.ts +1 -0
- package/dist/server/skills-integration.test.js +86 -0
- package/dist/server/skills-integration.test.js.map +1 -0
- package/dist/server/skills.d.ts +27 -0
- package/dist/server/skills.js +188 -0
- package/dist/server/skills.js.map +1 -0
- package/dist/server/skills.test.d.ts +1 -0
- package/dist/server/skills.test.js +243 -0
- package/dist/server/skills.test.js.map +1 -0
- package/dist/server/templateHelper.d.ts +0 -3
- package/dist/server/templateHelper.js.map +1 -1
- package/dist/server/templates.generated.js +4 -8
- package/dist/server/templates.generated.js.map +1 -1
- package/dist/server/tool-extra.test.d.ts +1 -0
- package/dist/server/tool-extra.test.js +88 -0
- package/dist/server/tool-extra.test.js.map +1 -0
- package/dist/server/view-resource-resolution.test.js +18 -13
- package/dist/server/view-resource-resolution.test.js.map +1 -1
- package/dist/server/viewsDevServer.js +4 -1
- package/dist/server/viewsDevServer.js.map +1 -1
- package/dist/test/utils.d.ts +9 -11
- package/dist/test/utils.js +220 -201
- package/dist/test/utils.js.map +1 -1
- package/dist/test/view.test.js +44 -40
- package/dist/test/view.test.js.map +1 -1
- package/dist/views/index.d.ts +10 -0
- package/dist/views/index.js +3 -0
- package/dist/views/index.js.map +1 -0
- package/dist/{web/plugin → views}/scan-views.js +1 -1
- package/dist/views/scan-views.js.map +1 -0
- package/dist/views/scan-views.test.d.ts +1 -0
- package/dist/views/scan-views.test.js.map +1 -0
- package/dist/views/validate-view.d.ts +1 -0
- package/dist/{web/plugin → views}/validate-view.js +2 -2
- package/dist/views/validate-view.js.map +1 -0
- package/dist/views/validate-view.test.d.ts +1 -0
- package/dist/views/validate-view.test.js.map +1 -0
- package/dist/web/bridges/adaptor.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 +68 -12
- package/dist/web/bridges/adaptor.test.js.map +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
- package/dist/web/bridges/get-adaptor.test.js +2 -2
- package/dist/web/bridges/get-adaptor.test.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.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 +46 -15
- 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 +19 -0
- package/dist/web/hooks/use-open-file.js +24 -0
- package/dist/web/hooks/use-open-file.js.map +1 -0
- package/dist/web/hooks/use-register-view-tool.d.ts +2 -3
- package/dist/web/hooks/use-register-view-tool.js.map +1 -1
- package/dist/web/hooks/use-request-close.test.js +1 -1
- package/dist/web/hooks/use-request-close.test.js.map +1 -1
- package/dist/web/hooks/use-request-modal.test.js +1 -1
- package/dist/web/hooks/use-request-modal.test.js.map +1 -1
- package/dist/web/hooks/use-request-size.d.ts +1 -1
- package/dist/web/hooks/use-request-size.js +1 -1
- package/dist/web/hooks/use-request-size.js.map +1 -1
- package/dist/web/hooks/use-request-size.test.js +1 -1
- package/dist/web/hooks/use-request-size.test.js.map +1 -1
- package/dist/web/hooks/use-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 +21 -18
- package/dist/cli/resolve-views-dir.d.ts +0 -1
- package/dist/cli/resolve-views-dir.js.map +0 -1
- package/dist/web/hooks/use-layout.d.ts +0 -24
- package/dist/web/hooks/use-layout.js +0 -25
- package/dist/web/hooks/use-layout.js.map +0 -1
- package/dist/web/hooks/use-layout.test.js.map +0 -1
- package/dist/web/plugin/data-llm.test.js +0 -81
- package/dist/web/plugin/data-llm.test.js.map +0 -1
- package/dist/web/plugin/plugin.d.ts +0 -33
- package/dist/web/plugin/plugin.js +0 -188
- package/dist/web/plugin/plugin.js.map +0 -1
- package/dist/web/plugin/scan-views.js.map +0 -1
- package/dist/web/plugin/scan-views.test.js.map +0 -1
- package/dist/web/plugin/transform-data-llm.d.ts +0 -12
- package/dist/web/plugin/transform-data-llm.js +0 -96
- package/dist/web/plugin/transform-data-llm.js.map +0 -1
- package/dist/web/plugin/transform-data-llm.test.js +0 -81
- package/dist/web/plugin/transform-data-llm.test.js.map +0 -1
- package/dist/web/plugin/validate-view.d.ts +0 -1
- package/dist/web/plugin/validate-view.js.map +0 -1
- package/dist/web/plugin/validate-view.test.js.map +0 -1
- /package/dist/{web/hooks/use-layout.test.d.ts → context-warnings.test.d.ts} +0 -0
- /package/dist/{web/plugin/data-llm.test.d.ts → server/app.test.d.ts} +0 -0
- /package/dist/{web/plugin/transform-data-llm.test.d.ts → server/auth/providers/authplane.test.d.ts} +0 -0
- /package/dist/{web/plugin/scan-views.test.d.ts → server/auth-extra.test-d.d.ts} +0 -0
- /package/dist/{web/plugin/validate-view.test.d.ts → server/mcp-errors.test.d.ts} +0 -0
- /package/dist/{web/plugin → views}/scan-views.d.ts +0 -0
- /package/dist/{web/plugin → views}/scan-views.test.js +0 -0
- /package/dist/{web/plugin → views}/validate-view.test.js +0 -0
package/dist/server/server.d.ts
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
|
|
2
|
-
import { type ServerOptions } from "@modelcontextprotocol/
|
|
3
|
-
import
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
7
|
-
import
|
|
8
|
-
import type { OAuthConfig } from "./auth/index.js";
|
|
9
|
-
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
2
|
+
import { type ContentBlock, type 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";
|
|
7
|
+
import { type SkillsManifest } from "./skills.js";
|
|
10
8
|
/**
|
|
11
9
|
* Type marker for a registered tool — carries its input, output, and response
|
|
12
10
|
* metadata shapes so views can infer types from `typeof server`.
|
|
@@ -19,12 +17,6 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
|
|
|
19
17
|
output: TOutput;
|
|
20
18
|
responseMetadata: TResponseMetadata;
|
|
21
19
|
};
|
|
22
|
-
/**
|
|
23
|
-
* @deprecated Views now always emit a single ext-apps resource; host targeting
|
|
24
|
-
* no longer applies. Retained for backwards compatibility; will be removed in a
|
|
25
|
-
* future major.
|
|
26
|
-
*/
|
|
27
|
-
export type ViewHostType = "apps-sdk" | "mcp-app";
|
|
28
20
|
/**
|
|
29
21
|
* Content Security Policy origins attached to a view's resource. Each list is
|
|
30
22
|
* passed through to the host's CSP for the view iframe; omit a field to inherit
|
|
@@ -68,11 +60,6 @@ export interface ViewConfig {
|
|
|
68
60
|
component: ViewName;
|
|
69
61
|
/** Human-readable label the host may show alongside the view. */
|
|
70
62
|
description?: string;
|
|
71
|
-
/**
|
|
72
|
-
* @deprecated No-op. Every view emits a single ext-apps resource regardless
|
|
73
|
-
* of this value. Will be removed in a future major.
|
|
74
|
-
*/
|
|
75
|
-
hosts?: ViewHostType[];
|
|
76
63
|
/** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
|
|
77
64
|
prefersBorder?: boolean;
|
|
78
65
|
/** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
|
|
@@ -88,8 +75,77 @@ export type SecurityScheme = {
|
|
|
88
75
|
type: "oauth2";
|
|
89
76
|
scopes?: string[];
|
|
90
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
|
+
*/
|
|
91
142
|
export type ToolAuth = {
|
|
92
|
-
|
|
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. */
|
|
93
149
|
scopes?: string[];
|
|
94
150
|
};
|
|
95
151
|
/**
|
|
@@ -97,12 +153,19 @@ export type ToolAuth = {
|
|
|
97
153
|
* from Express's own types so the public API doesn't depend on `body-parser`.
|
|
98
154
|
*/
|
|
99
155
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
100
|
-
/**
|
|
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
|
+
*/
|
|
101
161
|
export interface SkybridgeServerOptions {
|
|
102
|
-
/**
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
|
|
162
|
+
/** Whether an OAuth provider guards `/mcp`; enables per-tool scheme enforcement. */
|
|
163
|
+
oauth?: boolean;
|
|
164
|
+
/**
|
|
165
|
+
* @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
|
|
166
|
+
* API may change.
|
|
167
|
+
*/
|
|
168
|
+
skills?: boolean;
|
|
106
169
|
}
|
|
107
170
|
/**
|
|
108
171
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
@@ -121,7 +184,6 @@ export interface KnownToolMeta {
|
|
|
121
184
|
"openai/fileParams"?: string[];
|
|
122
185
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
123
186
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
124
|
-
securitySchemes?: SecurityScheme[];
|
|
125
187
|
}
|
|
126
188
|
/** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
|
|
127
189
|
export type ToolMeta = KnownToolMeta & Record<string, unknown>;
|
|
@@ -147,10 +209,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
147
209
|
type Simplify<T> = {
|
|
148
210
|
[K in keyof T]: T[K];
|
|
149
211
|
};
|
|
150
|
-
type ShapeOutput<Shape extends
|
|
151
|
-
[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]>;
|
|
152
214
|
} & {
|
|
153
|
-
[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]>;
|
|
154
216
|
}>;
|
|
155
217
|
type ExtractStructuredContent<T> = T extends {
|
|
156
218
|
structuredContent: infer SC;
|
|
@@ -162,23 +224,35 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
162
224
|
}> extends {
|
|
163
225
|
_meta: infer M;
|
|
164
226
|
} ? Simplify<M> : unknown;
|
|
165
|
-
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 & {
|
|
166
228
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
167
|
-
}>;
|
|
168
|
-
interface ToolConfigBase<TInput extends
|
|
229
|
+
}, TAuthExtra>;
|
|
230
|
+
interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
|
|
169
231
|
name: string;
|
|
170
232
|
title?: string;
|
|
171
233
|
description?: string;
|
|
172
234
|
inputSchema?: TInput;
|
|
173
|
-
outputSchema?:
|
|
235
|
+
outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
174
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[];
|
|
175
243
|
view?: ViewConfig;
|
|
244
|
+
/** ChatGPT-only options. See {@link OpenAIToolConfig}. */
|
|
245
|
+
openai?: OpenAIToolConfig;
|
|
176
246
|
_meta?: ToolMeta;
|
|
177
247
|
}
|
|
178
|
-
|
|
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 = {
|
|
179
253
|
auth?: ToolAuth;
|
|
180
254
|
securitySchemes?: never;
|
|
181
|
-
}
|
|
255
|
+
} | {
|
|
182
256
|
auth?: never;
|
|
183
257
|
/**
|
|
184
258
|
* Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
|
|
@@ -188,7 +262,8 @@ type ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> = (ToolConfigBase<
|
|
|
188
262
|
* enhanced behavior to authenticated ones.
|
|
189
263
|
*/
|
|
190
264
|
securitySchemes?: SecurityScheme[];
|
|
191
|
-
}
|
|
265
|
+
};
|
|
266
|
+
type ToolConfig<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> = ToolConfigBase<TInput> & ToolAuthConfig;
|
|
192
267
|
/**
|
|
193
268
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
194
269
|
* by the Apps SDK host. Hints only: never use for authorization, and tolerate
|
|
@@ -217,15 +292,40 @@ export interface ClientHintsMeta {
|
|
|
217
292
|
"openai/organization"?: string;
|
|
218
293
|
/** Stable id for the currently mounted widget instance. */
|
|
219
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
|
+
};
|
|
220
304
|
}
|
|
221
|
-
type ToolHandlerExtra = Omit<
|
|
222
|
-
_meta
|
|
305
|
+
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
306
|
+
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
307
|
+
_meta?: RequestMeta & ClientHintsMeta;
|
|
308
|
+
};
|
|
223
309
|
};
|
|
224
|
-
|
|
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 {
|
|
225
325
|
content?: HandlerContent;
|
|
226
326
|
} = {
|
|
227
327
|
content?: HandlerContent;
|
|
228
|
-
}> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
|
|
328
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
229
329
|
/**
|
|
230
330
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
231
331
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -246,26 +346,39 @@ declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof M
|
|
|
246
346
|
export declare function __setBuildManifest(manifest: Record<string, {
|
|
247
347
|
file: string;
|
|
248
348
|
}>): void;
|
|
249
|
-
export declare
|
|
349
|
+
export declare function __setSkillsManifest(manifest: SkillsManifest): void;
|
|
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 {
|
|
250
381
|
readonly $types: McpServerTypes<TTools>;
|
|
251
|
-
/**
|
|
252
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
253
|
-
* custom routes, middleware, or settings — e.g.
|
|
254
|
-
* `server.express.get("/health", ...)`.
|
|
255
|
-
*
|
|
256
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
257
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
258
|
-
* Register your handlers before `run()`;
|
|
259
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
260
|
-
* error handler are appended in that order.
|
|
261
|
-
*
|
|
262
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
263
|
-
* locally and on self-hosted deployments.
|
|
264
|
-
*/
|
|
265
|
-
readonly express: Express;
|
|
266
|
-
private customErrorMiddleware;
|
|
267
|
-
private mcpMiddlewareEntries;
|
|
268
|
-
private mcpMiddlewareApplied;
|
|
269
382
|
private claimedViews;
|
|
270
383
|
private viewMetaBuilders;
|
|
271
384
|
/**
|
|
@@ -276,44 +389,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
276
389
|
*/
|
|
277
390
|
private viewUriByPath;
|
|
278
391
|
private viteManifest;
|
|
279
|
-
private readonly serverInfo;
|
|
280
|
-
private readonly serverOptions?;
|
|
281
392
|
private oauthEnabled;
|
|
282
393
|
private resolveResourceMetadataUrl?;
|
|
283
|
-
private
|
|
394
|
+
private readonly toolSecuritySchemes;
|
|
395
|
+
private readonly userMiddlewareEntries;
|
|
284
396
|
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
|
|
285
397
|
/**
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
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`.
|
|
289
401
|
*
|
|
290
|
-
*
|
|
291
|
-
* locally and on self-hosted deployments.
|
|
402
|
+
* @internal
|
|
292
403
|
*/
|
|
293
|
-
|
|
294
|
-
use(path: string, ...handlers: RequestHandler[]): this;
|
|
404
|
+
get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
|
|
295
405
|
/**
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
* 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.
|
|
299
408
|
*
|
|
300
|
-
* @
|
|
301
|
-
* ```ts
|
|
302
|
-
* server.useOnError((err, _req, _res, next) => {
|
|
303
|
-
* logger.error(err);
|
|
304
|
-
* next(err);
|
|
305
|
-
* });
|
|
306
|
-
* ```
|
|
409
|
+
* @internal
|
|
307
410
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
411
|
+
setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
|
|
412
|
+
private setupSkills;
|
|
310
413
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
311
|
-
mcpMiddleware(handler: McpMiddlewareFn): this;
|
|
414
|
+
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
312
415
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
313
416
|
mcpMiddleware(filter: "request", handler: (request: {
|
|
314
417
|
method: string;
|
|
315
418
|
params: Record<string, unknown>;
|
|
316
|
-
}, extra: McpExtra
|
|
419
|
+
}, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
|
|
317
420
|
/** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
|
|
318
421
|
mcpMiddleware(filter: "notification", handler: (request: {
|
|
319
422
|
method: string;
|
|
@@ -323,7 +426,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
323
426
|
* Register MCP protocol-level middleware for an exact method.
|
|
324
427
|
* Narrows `params`, `extra`, and `next()` result based on the method string.
|
|
325
428
|
*/
|
|
326
|
-
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
|
|
429
|
+
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
|
|
327
430
|
/**
|
|
328
431
|
* Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
|
|
329
432
|
* `next()` returns the union of result types for matching methods.
|
|
@@ -331,49 +434,22 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
331
434
|
mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
|
|
332
435
|
method: string;
|
|
333
436
|
params: Record<string, unknown>;
|
|
334
|
-
}, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
437
|
+
}, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
335
438
|
/**
|
|
336
439
|
* Register MCP protocol-level middleware with a method filter.
|
|
337
440
|
* Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
|
|
338
441
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
339
442
|
*/
|
|
340
|
-
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
|
|
341
|
-
private applyMcpMiddleware;
|
|
342
|
-
/**
|
|
343
|
-
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
344
|
-
* when you're embedding Skybridge in a host that already manages its own
|
|
345
|
-
* transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
|
|
346
|
-
* which sets the transport up for you. Locks in any middleware registered
|
|
347
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
348
|
-
* throw afterwards.
|
|
349
|
-
*/
|
|
350
|
-
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
351
|
-
/**
|
|
352
|
-
* Per-request stateless connect. The SDK's `Protocol` only allows one
|
|
353
|
-
* transport per instance, so we can't reuse this `McpServer` across
|
|
354
|
-
* concurrent requests. The SDK's idiomatic fix is a `() => McpServer`
|
|
355
|
-
* factory, but that would break Skybridge's singleton API — so instead
|
|
356
|
-
* we build a fresh underlying `Server` per request and share the main
|
|
357
|
-
* server's handler maps by reference. The cast is unavoidable: there's
|
|
358
|
-
* no public API to inject handler maps. `getHandlerMaps` validates the
|
|
359
|
-
* read side and fails fast on SDK field renames.
|
|
360
|
-
*/
|
|
361
|
-
connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
443
|
+
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
362
444
|
/**
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
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}.
|
|
367
449
|
*
|
|
368
|
-
*
|
|
369
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
370
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
371
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
372
|
-
* Node, returns `undefined` once listening.
|
|
450
|
+
* @internal
|
|
373
451
|
*/
|
|
374
|
-
|
|
375
|
-
fetch: (...args: unknown[]) => unknown;
|
|
376
|
-
} | Express | undefined>;
|
|
452
|
+
protocolMiddlewareEntries(): McpMiddlewareEntry[];
|
|
377
453
|
private enforceOneToolPerView;
|
|
378
454
|
private resolveViewRequestContext;
|
|
379
455
|
private registerViewResources;
|
|
@@ -393,6 +469,29 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
393
469
|
file: string;
|
|
394
470
|
}>): this;
|
|
395
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;
|
|
396
495
|
/**
|
|
397
496
|
* Register a tool. Pass a `config` describing the tool (name, schemas,
|
|
398
497
|
* optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
|
|
@@ -422,11 +521,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
422
521
|
*
|
|
423
522
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
424
523
|
*/
|
|
425
|
-
registerTool<TName extends string, InputArgs extends
|
|
524
|
+
registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
426
525
|
content?: HandlerContent;
|
|
427
526
|
}>(config: ToolConfig<InputArgs> & {
|
|
428
527
|
name: TName;
|
|
429
|
-
}, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn
|
|
430
|
-
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;
|
|
431
532
|
}
|
|
432
533
|
export {};
|