skybridge 0.0.0-dev.81fd90a → 0.0.0-dev.8226541
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 +14 -14
- package/dist/cli/build-helpers.d.ts +1 -1
- package/dist/cli/build-helpers.js +4 -4
- package/dist/cli/build-helpers.js.map +1 -1
- package/dist/cli/build-helpers.test.js +2 -2
- package/dist/cli/build-helpers.test.js.map +1 -1
- package/dist/cli/build-steps.js +1 -1
- 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/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 +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 +4 -4
- 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/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 +1 -1
- package/dist/server/auth/discovery.js +1 -1
- package/dist/server/auth/discovery.js.map +1 -1
- package/dist/server/auth/index.d.ts +19 -1
- package/dist/server/auth/index.js.map +1 -1
- package/dist/server/auth/providers/auth0.d.ts +2 -2
- 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 +1 -1
- package/dist/server/auth/providers/auth0.test.js.map +1 -1
- package/dist/server/auth/providers/authplane.d.ts +2 -2
- package/dist/server/auth/providers/authplane.js.map +1 -1
- package/dist/server/auth/providers/authplane.test.js +10 -7
- package/dist/server/auth/providers/authplane.test.js.map +1 -1
- package/dist/server/auth/providers/clerk.d.ts +2 -2
- package/dist/server/auth/providers/clerk.js.map +1 -1
- package/dist/server/auth/providers/clerk.test.js +1 -1
- package/dist/server/auth/providers/clerk.test.js.map +1 -1
- package/dist/server/auth/providers/custom.d.ts +7 -5
- package/dist/server/auth/providers/custom.js +5 -2
- package/dist/server/auth/providers/custom.js.map +1 -1
- package/dist/server/auth/providers/custom.test.js +13 -10
- package/dist/server/auth/providers/custom.test.js.map +1 -1
- package/dist/server/auth/providers/descope.d.ts +2 -2
- package/dist/server/auth/providers/descope.js.map +1 -1
- package/dist/server/auth/providers/descope.test.js +3 -3
- package/dist/server/auth/providers/descope.test.js.map +1 -1
- package/dist/server/auth/providers/stytch.d.ts +2 -2
- package/dist/server/auth/providers/stytch.js.map +1 -1
- package/dist/server/auth/providers/workos.d.ts +5 -4
- package/dist/server/auth/providers/workos.js +2 -1
- package/dist/server/auth/providers/workos.js.map +1 -1
- package/dist/server/auth/setup.d.ts +1 -1
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +74 -58
- package/dist/server/auth/setup.test.js.map +1 -1
- package/dist/server/auth/verify.d.ts +5 -3
- package/dist/server/auth/verify.js.map +1 -1
- package/dist/server/auth/verify.test.js +16 -0
- package/dist/server/auth/verify.test.js.map +1 -1
- package/dist/server/auth-extra.test-d.js +93 -34
- package/dist/server/auth-extra.test-d.js.map +1 -1
- package/dist/server/auth.d.ts +4 -4
- package/dist/server/auth.js +2 -2
- 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/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.js +172 -0
- package/dist/server/events.test.js.map +1 -0
- package/dist/server/express.d.ts +23 -3
- package/dist/server/express.js +40 -10
- package/dist/server/express.js.map +1 -1
- package/dist/server/express.test.js +193 -110
- 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/index.d.ts +8 -4
- package/dist/server/index.js +5 -1
- package/dist/server/index.js.map +1 -1
- package/dist/server/mcp-errors.test.js +9 -5
- package/dist/server/mcp-errors.test.js.map +1 -1
- package/dist/server/middleware.test.js +221 -148
- package/dist/server/middleware.test.js.map +1 -1
- package/dist/server/register-tool.test.js +212 -7
- package/dist/server/register-tool.test.js.map +1 -1
- package/dist/server/server.d.ts +323 -150
- package/dist/server/server.js +349 -324
- package/dist/server/server.js.map +1 -1
- package/dist/server/skills-integration.test.js +16 -9
- package/dist/server/skills-integration.test.js.map +1 -1
- package/dist/server/skills.js +1 -1
- package/dist/server/skills.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.js +115 -20
- package/dist/server/tool-extra.test.js.map +1 -1
- package/dist/server/view-resource-resolution.test.js +17 -10
- package/dist/server/view-resource-resolution.test.js.map +1 -1
- package/dist/test/utils.d.ts +7 -6
- package/dist/test/utils.js +212 -197
- package/dist/test/utils.js.map +1 -1
- package/dist/test/view.test.js +24 -20
- 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.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.js.map +1 -0
- package/dist/web/bridges/adaptor.d.ts +14 -3
- package/dist/web/bridges/adaptor.js +157 -13
- package/dist/web/bridges/adaptor.js.map +1 -1
- package/dist/web/bridges/adaptor.test.js +46 -7
- 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 +3 -3
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +3 -3
- 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 +10 -3
- 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 +18 -3
- 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 +63 -13
- 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 +8 -2
- 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.js +107 -0
- package/dist/web/hooks/openai-extensions.test.js.map +1 -0
- 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.test.js +1 -1
- package/dist/web/hooks/use-display-mode.test.js.map +1 -1
- package/dist/web/hooks/use-download.test.js +3 -3
- 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.js +65 -0
- package/dist/web/hooks/use-file-resource.test.js.map +1 -0
- 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 +27 -5
- package/dist/web/hooks/use-host.js +20 -5
- package/dist/web/hooks/use-host.js.map +1 -1
- package/dist/web/hooks/use-host.test.js +1 -1
- package/dist/web/hooks/use-host.test.js.map +1 -1
- 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 +1 -1
- 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.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.test.js +2 -2
- package/dist/web/hooks/use-tool-info.test.js.map +1 -1
- package/dist/web/hooks/use-user.test.js +2 -2
- package/dist/web/hooks/use-user.test.js.map +1 -1
- package/dist/web/hooks/use-view-state.test.js +2 -2
- package/dist/web/hooks/use-view-state.test.js.map +1 -1
- package/dist/web/hooks/use-viewport.test.js +2 -2
- package/dist/web/hooks/use-viewport.test.js.map +1 -1
- package/dist/web/index.d.ts +0 -1
- package/dist/web/index.js.map +1 -1
- package/dist/web/mount-view.js +2 -6
- package/dist/web/mount-view.js.map +1 -1
- package/package.json +15 -15
- package/dist/standard-schema.d.ts +0 -3
- package/dist/standard-schema.js +0 -2
- package/dist/standard-schema.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-build.test.js +0 -54
- package/dist/web/plugin/plugin-build.test.js.map +0 -1
- package/dist/web/plugin/plugin.d.ts +0 -39
- package/dist/web/plugin/plugin.js +0 -200
- package/dist/web/plugin/plugin.js.map +0 -1
- package/dist/web/plugin/plugin.test.js +0 -61
- package/dist/web/plugin/plugin.test.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/plugin/data-llm.test.d.ts → server/app.test.d.ts} +0 -0
- /package/dist/{web/plugin/plugin-build.test.d.ts → server/events.test.d.ts} +0 -0
- /package/dist/{web/plugin → views}/scan-views.d.ts +0 -0
- /package/dist/{web/plugin → views}/scan-views.test.d.ts +0 -0
- /package/dist/{web/plugin → views}/scan-views.test.js +0 -0
- /package/dist/{web/plugin → views}/validate-view.test.d.ts +0 -0
- /package/dist/{web/plugin → views}/validate-view.test.js +0 -0
- /package/dist/web/{plugin/plugin.test.d.ts → hooks/openai-extensions.test.d.ts} +0 -0
- /package/dist/web/{plugin/transform-data-llm.test.d.ts → hooks/use-file-resource.test.d.ts} +0 -0
package/dist/server/server.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
|
|
2
|
-
import { type
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import type {
|
|
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
6
|
import type { ExtraClaims } from "./auth.js";
|
|
7
|
-
import
|
|
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";
|
|
8
9
|
import { type SkillsManifest } from "./skills.js";
|
|
9
10
|
/**
|
|
10
11
|
* Type marker for a registered tool — carries its input, output, and response
|
|
@@ -18,12 +19,6 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
|
|
|
18
19
|
output: TOutput;
|
|
19
20
|
responseMetadata: TResponseMetadata;
|
|
20
21
|
};
|
|
21
|
-
/**
|
|
22
|
-
* The runtime a served view page declares on `window.skybridge`. Every view
|
|
23
|
-
* emits a single ext-apps resource, so this is always `"mcp-app"`; the Apps
|
|
24
|
-
* SDK runtime is detected at load time via `window.openai` instead.
|
|
25
|
-
*/
|
|
26
|
-
export type ViewHostType = "mcp-app";
|
|
27
22
|
/**
|
|
28
23
|
* Content Security Policy origins attached to a view's resource. Each list is
|
|
29
24
|
* passed through to the host's CSP for the view iframe; omit a field to inherit
|
|
@@ -34,7 +29,7 @@ export interface ViewCsp {
|
|
|
34
29
|
resourceDomains?: string[];
|
|
35
30
|
/** Origins the view may contact via fetch/XHR. */
|
|
36
31
|
connectDomains?: string[];
|
|
37
|
-
/** Origins allowed for iframe embeds (opts into stricter
|
|
32
|
+
/** Origins allowed for iframe embeds (opts into stricter plugin review). */
|
|
38
33
|
frameDomains?: string[];
|
|
39
34
|
/** Origins that can receive openExternal redirects without the safe-link modal. */
|
|
40
35
|
redirectDomains?: string[];
|
|
@@ -82,6 +77,65 @@ export type SecurityScheme = {
|
|
|
82
77
|
type: "oauth2";
|
|
83
78
|
scopes?: string[];
|
|
84
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
|
+
}
|
|
85
139
|
/**
|
|
86
140
|
* Declarative per-tool auth. Enforced when the server has an `oauth` provider:
|
|
87
141
|
* anonymous or under-scoped calls are rejected before the handler runs. Omit
|
|
@@ -102,17 +156,13 @@ export type ToolAuth = {
|
|
|
102
156
|
*/
|
|
103
157
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
104
158
|
/**
|
|
105
|
-
* Skybridge-specific
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
* @typeParam TAuthExtra - Claims the `oauth` verifier populates. Inferred from
|
|
109
|
-
* the config a provider returns, and carried on to tool handlers.
|
|
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.
|
|
110
162
|
*/
|
|
111
|
-
export interface SkybridgeServerOptions
|
|
112
|
-
/**
|
|
113
|
-
|
|
114
|
-
/** Resource-server OAuth config. When set, mounts well-known metadata and bearer auth on `/mcp`. */
|
|
115
|
-
oauth?: OAuthConfig<TAuthExtra>;
|
|
163
|
+
export interface SkybridgeServerOptions {
|
|
164
|
+
/** Whether an OAuth provider guards `/mcp`; enables per-tool scheme enforcement. */
|
|
165
|
+
oauth?: boolean;
|
|
116
166
|
/**
|
|
117
167
|
* @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
|
|
118
168
|
* API may change.
|
|
@@ -123,16 +173,16 @@ export interface SkybridgeServerOptions<TAuthExtra extends ExtraClaims = ExtraCl
|
|
|
123
173
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
124
174
|
* Use {@link ToolMeta} to also pass arbitrary custom metadata alongside these.
|
|
125
175
|
*
|
|
126
|
-
* @see https://developers.openai.com/
|
|
176
|
+
* @see https://developers.openai.com/plugins/reference#tool-descriptor-parameters
|
|
127
177
|
*/
|
|
128
178
|
export interface KnownToolMeta {
|
|
129
|
-
/**
|
|
179
|
+
/** ChatGPT: allow the rendered view to call this tool from inside its iframe. */
|
|
130
180
|
"openai/widgetAccessible"?: boolean;
|
|
131
|
-
/**
|
|
181
|
+
/** ChatGPT: status text shown while the tool is running (e.g. `"Searching trips"`). */
|
|
132
182
|
"openai/toolInvocation/invoking"?: string;
|
|
133
|
-
/**
|
|
183
|
+
/** ChatGPT: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
|
|
134
184
|
"openai/toolInvocation/invoked"?: string;
|
|
135
|
-
/**
|
|
185
|
+
/** ChatGPT: input parameters that hold file references — the host attaches uploaded files to them. */
|
|
136
186
|
"openai/fileParams"?: string[];
|
|
137
187
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
138
188
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
@@ -161,10 +211,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
161
211
|
type Simplify<T> = {
|
|
162
212
|
[K in keyof T]: T[K];
|
|
163
213
|
};
|
|
164
|
-
type ShapeOutput<Shape extends
|
|
165
|
-
[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]>;
|
|
166
216
|
} & {
|
|
167
|
-
[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]>;
|
|
168
218
|
}>;
|
|
169
219
|
type ExtractStructuredContent<T> = T extends {
|
|
170
220
|
structuredContent: infer SC;
|
|
@@ -176,17 +226,25 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
176
226
|
}> extends {
|
|
177
227
|
_meta: infer M;
|
|
178
228
|
} ? Simplify<M> : unknown;
|
|
179
|
-
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 & {
|
|
180
230
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
181
231
|
}, TAuthExtra>;
|
|
182
|
-
interface ToolConfigBase<TInput extends
|
|
232
|
+
interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
|
|
183
233
|
name: string;
|
|
184
234
|
title?: string;
|
|
185
235
|
description?: string;
|
|
186
236
|
inputSchema?: TInput;
|
|
187
|
-
outputSchema?:
|
|
237
|
+
outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
188
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[];
|
|
189
245
|
view?: ViewConfig;
|
|
246
|
+
/** ChatGPT-only options. See {@link OpenAIToolConfig}. */
|
|
247
|
+
openai?: OpenAIToolConfig;
|
|
190
248
|
_meta?: ToolMeta;
|
|
191
249
|
}
|
|
192
250
|
/**
|
|
@@ -207,12 +265,28 @@ type ToolAuthConfig = {
|
|
|
207
265
|
*/
|
|
208
266
|
securitySchemes?: SecurityScheme[];
|
|
209
267
|
};
|
|
210
|
-
type ToolConfig<TInput extends
|
|
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
|
+
};
|
|
211
285
|
/**
|
|
212
286
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
213
|
-
* by the
|
|
287
|
+
* by the ChatGPT host. Hints only: never use for authorization, and tolerate
|
|
214
288
|
* absence.
|
|
215
|
-
* @see https://developers.openai.com/
|
|
289
|
+
* @see https://developers.openai.com/plugins/reference#_meta-fields-the-client-provides
|
|
216
290
|
*/
|
|
217
291
|
export interface ClientHintsMeta {
|
|
218
292
|
/** Requested locale (BCP-47, e.g. `"en-US"`). */
|
|
@@ -236,17 +310,77 @@ export interface ClientHintsMeta {
|
|
|
236
310
|
"openai/organization"?: string;
|
|
237
311
|
/** Stable id for the currently mounted widget instance. */
|
|
238
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
|
+
};
|
|
239
322
|
}
|
|
240
323
|
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
241
324
|
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
242
325
|
_meta?: RequestMeta & ClientHintsMeta;
|
|
243
326
|
};
|
|
244
327
|
};
|
|
245
|
-
|
|
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 {
|
|
246
380
|
content?: HandlerContent;
|
|
247
381
|
} = {
|
|
248
382
|
content?: HandlerContent;
|
|
249
|
-
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
383
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | InputRequiredResult | Promise<TReturn | InputRequiredResult>;
|
|
250
384
|
/**
|
|
251
385
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
252
386
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -254,7 +388,7 @@ type ToolHandler<TInput extends RawInputShape, TReturn extends {
|
|
|
254
388
|
* who build content lazily can apply the same normalization.
|
|
255
389
|
*/
|
|
256
390
|
export declare function normalizeContent(content: HandlerContent | undefined): ContentBlock[];
|
|
257
|
-
interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "
|
|
391
|
+
interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "connect"> {
|
|
258
392
|
}
|
|
259
393
|
declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof McpServerBase>) => McpServerBaseOmitted;
|
|
260
394
|
/**
|
|
@@ -268,28 +402,38 @@ export declare function __setBuildManifest(manifest: Record<string, {
|
|
|
268
402
|
file: string;
|
|
269
403
|
}>): void;
|
|
270
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.
|
|
411
|
+
*
|
|
412
|
+
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
413
|
+
* shape, so `typeof app` carries enough information for view-side helpers
|
|
414
|
+
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
415
|
+
*
|
|
416
|
+
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
417
|
+
* chaining; you almost never set this manually.
|
|
418
|
+
*
|
|
419
|
+
* @example
|
|
420
|
+
* ```ts
|
|
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
|
+
* });
|
|
431
|
+
* ```
|
|
432
|
+
*
|
|
433
|
+
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
434
|
+
*/
|
|
271
435
|
export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>, TAuthExtra extends ExtraClaims = ExtraClaims> extends McpServerBaseOmitted {
|
|
272
436
|
readonly $types: McpServerTypes<TTools>;
|
|
273
|
-
/**
|
|
274
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
275
|
-
* custom routes, middleware, or settings — e.g.
|
|
276
|
-
* `server.express.get("/health", ...)`.
|
|
277
|
-
*
|
|
278
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
279
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
280
|
-
* Register your handlers before `run()`;
|
|
281
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
282
|
-
* error handler are appended in that order.
|
|
283
|
-
*
|
|
284
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
285
|
-
* locally and on self-hosted deployments.
|
|
286
|
-
*/
|
|
287
|
-
readonly express: Express;
|
|
288
|
-
private customErrorMiddleware;
|
|
289
|
-
private mcpMiddlewareEntries;
|
|
290
|
-
private mcpMiddlewareApplied;
|
|
291
|
-
private middlewareEntriesCache;
|
|
292
|
-
private readonly registrations;
|
|
293
437
|
private claimedViews;
|
|
294
438
|
private viewMetaBuilders;
|
|
295
439
|
/**
|
|
@@ -300,63 +444,28 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
300
444
|
*/
|
|
301
445
|
private viewUriByPath;
|
|
302
446
|
private viteManifest;
|
|
303
|
-
private readonly serverInfo;
|
|
304
|
-
private readonly serverOptions?;
|
|
305
447
|
private oauthEnabled;
|
|
306
448
|
private resolveResourceMetadataUrl?;
|
|
307
|
-
private
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
* Signature owned by Skybridge (not inherited) so a typed wrapper can land
|
|
312
|
-
* in a minor without a type-level break.
|
|
313
|
-
*/
|
|
314
|
-
registerResource(name: string, uri: string, config: ResourceMetadata & {
|
|
315
|
-
cacheHint?: CacheHint;
|
|
316
|
-
}, readCallback: ReadResourceCallback): RegisteredResource;
|
|
317
|
-
registerResource(name: string, template: ResourceTemplate, config: ResourceMetadata & {
|
|
318
|
-
cacheHint?: CacheHint;
|
|
319
|
-
}, readCallback: ReadResourceTemplateCallback): RegisteredResourceTemplate;
|
|
320
|
-
/**
|
|
321
|
-
* Register a prompt, recorded so every per-request instance carries it.
|
|
322
|
-
* Signature owned by Skybridge (not inherited) so a typed wrapper can land
|
|
323
|
-
* in a minor without a type-level break.
|
|
324
|
-
*/
|
|
325
|
-
registerPrompt<Args extends StandardSchemaWithJSON>(name: string, config: {
|
|
326
|
-
title?: string;
|
|
327
|
-
description?: string;
|
|
328
|
-
argsSchema?: Args;
|
|
329
|
-
icons?: Icon[];
|
|
330
|
-
_meta?: Record<string, unknown>;
|
|
331
|
-
}, cb: PromptCallback<Args>): RegisteredPrompt;
|
|
332
|
-
private recordInherited;
|
|
333
|
-
private skillRegistrar;
|
|
334
|
-
private setupSkills;
|
|
449
|
+
private readonly toolSecuritySchemes;
|
|
450
|
+
private readonly userMiddlewareEntries;
|
|
451
|
+
private eventRegistry?;
|
|
452
|
+
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
|
|
335
453
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
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`.
|
|
339
457
|
*
|
|
340
|
-
*
|
|
341
|
-
* locally and on self-hosted deployments.
|
|
458
|
+
* @internal
|
|
342
459
|
*/
|
|
343
|
-
|
|
344
|
-
use(path: string, ...handlers: RequestHandler[]): this;
|
|
460
|
+
get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
|
|
345
461
|
/**
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
* 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.
|
|
349
464
|
*
|
|
350
|
-
* @
|
|
351
|
-
* ```ts
|
|
352
|
-
* server.useOnError((err, _req, _res, next) => {
|
|
353
|
-
* logger.error(err);
|
|
354
|
-
* next(err);
|
|
355
|
-
* });
|
|
356
|
-
* ```
|
|
465
|
+
* @internal
|
|
357
466
|
*/
|
|
358
|
-
|
|
359
|
-
|
|
467
|
+
setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
|
|
468
|
+
private setupSkills;
|
|
360
469
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
361
470
|
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
362
471
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
@@ -388,49 +497,15 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
388
497
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
389
498
|
*/
|
|
390
499
|
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
391
|
-
private applyMcpMiddleware;
|
|
392
|
-
private instrumentHandlers;
|
|
393
|
-
/**
|
|
394
|
-
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
395
|
-
* when you're embedding Skybridge in a host that already manages its own
|
|
396
|
-
* transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
|
|
397
|
-
* which sets the transport up for you. Locks in any middleware registered
|
|
398
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
399
|
-
* throw afterwards.
|
|
400
|
-
*/
|
|
401
|
-
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
402
|
-
/**
|
|
403
|
-
* Build a fresh server for one stateless HTTP request, as
|
|
404
|
-
* `createMcpHandler`'s factory contract requires: every registration is
|
|
405
|
-
* replayed onto the new instance so the SDK's handler closures belong to
|
|
406
|
-
* the instance whose protocol era it stamps. Sharing the singleton's
|
|
407
|
-
* handler maps instead would bind them to an instance that is never
|
|
408
|
-
* marked, pinning every request to the 2025 codec and letting concurrent
|
|
409
|
-
* callers overwrite each other's negotiated version.
|
|
410
|
-
*/
|
|
411
|
-
createStatelessServerInstance(): SdkServer;
|
|
412
|
-
/**
|
|
413
|
-
* Apply an SDK registration to the singleton and remember it, so each
|
|
414
|
-
* per-request instance can be built with the same surface.
|
|
415
|
-
*/
|
|
416
|
-
private record;
|
|
417
|
-
/** Records a raw request handler (used for methods the SDK has no sugar for). */
|
|
418
|
-
private recordRequestHandler;
|
|
419
500
|
/**
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
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}.
|
|
424
505
|
*
|
|
425
|
-
*
|
|
426
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
427
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
428
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
429
|
-
* Node, returns `undefined` once listening.
|
|
506
|
+
* @internal
|
|
430
507
|
*/
|
|
431
|
-
|
|
432
|
-
fetch: (...args: unknown[]) => unknown;
|
|
433
|
-
} | Express | undefined>;
|
|
508
|
+
protocolMiddlewareEntries(): McpMiddlewareEntry[];
|
|
434
509
|
private enforceOneToolPerView;
|
|
435
510
|
private resolveViewRequestContext;
|
|
436
511
|
private registerViewResources;
|
|
@@ -450,6 +525,104 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
450
525
|
file: string;
|
|
451
526
|
}>): this;
|
|
452
527
|
private readManifest;
|
|
528
|
+
/**
|
|
529
|
+
* @experimental Register an MCP Events type that hosts can subscribe to, per
|
|
530
|
+
* the Triggers & Events working group draft. Skybridge serves `events/list`,
|
|
531
|
+
* `events/subscribe` and `events/unsubscribe`, checks auth and arguments,
|
|
532
|
+
* verifies the callback URL, then hands each subscription to `onSubscribe`.
|
|
533
|
+
* Delivering the events is up to you, for example with {@link deliverEvent}.
|
|
534
|
+
* API may change.
|
|
535
|
+
*
|
|
536
|
+
* @example
|
|
537
|
+
* ```ts
|
|
538
|
+
* server.registerEvent(
|
|
539
|
+
* {
|
|
540
|
+
* name: "comment.created",
|
|
541
|
+
* description: "Fires when someone comments on a document",
|
|
542
|
+
* inputSchema: { documentId: z.string() },
|
|
543
|
+
* payloadSchema: { documentId: z.string(), excerpt: z.string() },
|
|
544
|
+
* },
|
|
545
|
+
* {
|
|
546
|
+
* onSubscribe: ({ documentId }, { subscription }) =>
|
|
547
|
+
* webhooks.upsert({ ...subscription, filter: { documentId } }),
|
|
548
|
+
* onUnsubscribe: (_args, { subscription }) =>
|
|
549
|
+
* webhooks.remove(subscription.id),
|
|
550
|
+
* },
|
|
551
|
+
* );
|
|
552
|
+
* ```
|
|
553
|
+
*
|
|
554
|
+
* @see https://docs.skybridge.tech/api-reference/register-event
|
|
555
|
+
*/
|
|
556
|
+
registerEvent<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON = Record<never, StandardSchemaWithJSON>>(config: EventConfig<TInput>, hooks: EventHooks<InferEventSchema<TInput>, McpExtra<TAuthExtra>>): this;
|
|
557
|
+
/**
|
|
558
|
+
* Register a ChatGPT file viewer, from the OpenAI MCP extensions: a tool
|
|
559
|
+
* with a file entrypoint for `extensions` and a view. ChatGPT desktop calls
|
|
560
|
+
* it with the file the user opened, as `{ file: { name, resourceUri } }`.
|
|
561
|
+
* Read and save the file from the view with `useFileResource`.
|
|
562
|
+
*
|
|
563
|
+
* @example
|
|
564
|
+
* ```ts
|
|
565
|
+
* server.registerFileViewer(
|
|
566
|
+
* {
|
|
567
|
+
* name: "part-viewer",
|
|
568
|
+
* title: "Part Viewer",
|
|
569
|
+
* extensions: [".stl", ".step"],
|
|
570
|
+
* view: { component: "part-viewer" },
|
|
571
|
+
* },
|
|
572
|
+
* async ({ file }) => ({ structuredContent: { name: file.name } }),
|
|
573
|
+
* );
|
|
574
|
+
* ```
|
|
575
|
+
*
|
|
576
|
+
* @see https://docs.skybridge.tech/api-reference/register-file-viewer
|
|
577
|
+
*/
|
|
578
|
+
registerFileViewer<TName extends string, TReturn extends {
|
|
579
|
+
content?: HandlerContent;
|
|
580
|
+
}>(config: OpenAIFileViewerConfig<TName>, cb: ToolHandler<FileEntrypointInput, TReturn, TAuthExtra>): AddTool<TTools, TName, FileEntrypointInput, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
581
|
+
/**
|
|
582
|
+
* Register the composer at-mention search for ChatGPT, from the OpenAI MCP
|
|
583
|
+
* extensions. When the user types `@` and your app name, ChatGPT calls
|
|
584
|
+
* `handler` with the typed text and lists the returned resource links.
|
|
585
|
+
* Skybridge registers it as a tool hidden from the model.
|
|
586
|
+
*
|
|
587
|
+
* @example
|
|
588
|
+
* ```ts
|
|
589
|
+
* server.registerMentions({
|
|
590
|
+
* name: "search_parts",
|
|
591
|
+
* handler: async ({ query }) => ({
|
|
592
|
+
* items: findParts(query).map((part) => ({
|
|
593
|
+
* type: "resource_link",
|
|
594
|
+
* uri: `parts://${part.id}`,
|
|
595
|
+
* name: part.name,
|
|
596
|
+
* })),
|
|
597
|
+
* }),
|
|
598
|
+
* });
|
|
599
|
+
* ```
|
|
600
|
+
*
|
|
601
|
+
* @see https://docs.skybridge.tech/api-reference/register-mentions
|
|
602
|
+
*/
|
|
603
|
+
registerMentions(config: OpenAIMentionsConfig<TAuthExtra>): this;
|
|
604
|
+
/**
|
|
605
|
+
* Register app settings for ChatGPT, from the OpenAI MCP extensions.
|
|
606
|
+
* Skybridge registers a read tool and an update tool from `fields`, and
|
|
607
|
+
* advertises them in the `openai/settings` server capability. ChatGPT shows
|
|
608
|
+
* the settings page and calls `update` with the changed fields only. Store
|
|
609
|
+
* the values yourself, for example per user.
|
|
610
|
+
*
|
|
611
|
+
* @example
|
|
612
|
+
* ```ts
|
|
613
|
+
* server.registerSettings({
|
|
614
|
+
* fields: {
|
|
615
|
+
* units: { title: "Units", schema: z.enum(["mm", "in"]) },
|
|
616
|
+
* showGrid: { title: "Show grid", schema: z.boolean() },
|
|
617
|
+
* },
|
|
618
|
+
* read: (extra) => loadSettings(extra),
|
|
619
|
+
* update: (set, extra) => saveSettings(set, extra),
|
|
620
|
+
* });
|
|
621
|
+
* ```
|
|
622
|
+
*
|
|
623
|
+
* @see https://docs.skybridge.tech/api-reference/register-settings
|
|
624
|
+
*/
|
|
625
|
+
registerSettings<TFields extends Record<string, OpenAISettingsField>>(config: OpenAISettingsConfig<TFields, TAuthExtra>): this;
|
|
453
626
|
/**
|
|
454
627
|
* Register a tool. Pass a `config` describing the tool (name, schemas,
|
|
455
628
|
* optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
|
|
@@ -479,12 +652,12 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
479
652
|
*
|
|
480
653
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
481
654
|
*/
|
|
482
|
-
registerTool<TName extends string, InputArgs extends
|
|
655
|
+
registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
|
|
483
656
|
content?: HandlerContent;
|
|
484
657
|
}>(config: ToolConfig<InputArgs> & {
|
|
485
658
|
name: TName;
|
|
486
659
|
}, cb: ToolHandler<InputArgs, TReturn, TAuthExtra>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
487
|
-
registerTool<InputArgs extends
|
|
660
|
+
registerTool<InputArgs extends Record<string, StandardSchemaWithJSON>>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, {
|
|
488
661
|
content?: HandlerContent;
|
|
489
662
|
}, TAuthExtra>): this;
|
|
490
663
|
}
|