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