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.js
CHANGED
|
@@ -1,27 +1,32 @@
|
|
|
1
1
|
import crypto from "node:crypto";
|
|
2
2
|
import { readFileSync } from "node:fs";
|
|
3
|
-
import http from "node:http";
|
|
4
3
|
import path from "node:path";
|
|
5
|
-
import { McpServer as McpServerBase, } from "@modelcontextprotocol/server";
|
|
6
|
-
import {
|
|
7
|
-
import express, {} from "express";
|
|
4
|
+
import { isInputRequiredResult, McpServer as McpServerBase, } from "@modelcontextprotocol/server";
|
|
5
|
+
import { z } from "zod/v4";
|
|
8
6
|
import { warnOnLargeToolOutput } from "../context-warnings.js";
|
|
9
7
|
import { authToSecuritySchemes, evaluateSecuritySchemes, inBandChallengeResult, } from "./auth/security-schemes.js";
|
|
10
|
-
import {
|
|
11
|
-
import { createApp } from "./express.js";
|
|
8
|
+
import { EventRegistry, } from "./events.js";
|
|
12
9
|
import { hostFromUserAgent } from "./host.js";
|
|
13
|
-
import {
|
|
14
|
-
import { buildMiddlewareChain, captureToolError, getHandlerMaps, } from "./middleware.js";
|
|
10
|
+
import { captureToolError } from "./middleware.js";
|
|
15
11
|
import { resolveServerOrigin } from "./requestOrigin.js";
|
|
16
12
|
import { discoverSkills, registerSkills, SKILLS_EXTENSION_KEY, } from "./skills.js";
|
|
17
13
|
import { templateHelper } from "./templateHelper.js";
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
}
|
|
14
|
+
const unionOf = (base, extra) => extra ? [...new Set([...base, ...extra])] : base;
|
|
15
|
+
function mergeOpenAIUi(meta, values) {
|
|
16
|
+
const defined = Object.fromEntries(Object.entries(values).filter(([, value]) => value !== undefined));
|
|
17
|
+
if (Object.keys(defined).length > 0) {
|
|
18
|
+
meta["openai/ui"] = { ...meta["openai/ui"], ...defined };
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
function acceptsEmptyInput(inputSchema) {
|
|
22
|
+
if (inputSchema === undefined) {
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
const checks = "~standard" in inputSchema
|
|
26
|
+
? [inputSchema["~standard"].validate({})]
|
|
27
|
+
: Object.values(inputSchema).map((schema) => schema["~standard"].validate(undefined));
|
|
28
|
+
return checks.every((result) => result instanceof Promise || result.issues === undefined);
|
|
29
|
+
}
|
|
25
30
|
const SKILLS_DIR = "src/skills";
|
|
26
31
|
/**
|
|
27
32
|
* Normalize an `x-forwarded-prefix` value into a leading-slash, no-trailing-slash
|
|
@@ -36,6 +41,12 @@ function normalizeForwardedPrefix(raw) {
|
|
|
36
41
|
}
|
|
37
42
|
return trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
|
|
38
43
|
}
|
|
44
|
+
const fileEntrypointInput = {
|
|
45
|
+
file: z.object({
|
|
46
|
+
name: z.string().min(1),
|
|
47
|
+
resourceUri: z.string().trim().min(1),
|
|
48
|
+
}),
|
|
49
|
+
};
|
|
39
50
|
/**
|
|
40
51
|
* Drop the query string from a `ui://` view URI, leaving the bare path. The
|
|
41
52
|
* `?v=` cache key is the only query we append, so a plain split is enough and
|
|
@@ -64,35 +75,6 @@ export function normalizeContent(content) {
|
|
|
64
75
|
return [content];
|
|
65
76
|
}
|
|
66
77
|
const McpServerBaseOmitted = McpServerBase;
|
|
67
|
-
/**
|
|
68
|
-
* The Skybridge server. Extends the MCP SDK's `McpServer` with a typed tool
|
|
69
|
-
* registry, view resources, an embedded Express app, and protocol-level
|
|
70
|
-
* middleware. Construct it with the same `Implementation` info you would pass
|
|
71
|
-
* to the SDK, chain {@link McpServer.registerTool} calls to declare tools,
|
|
72
|
-
* then call {@link McpServer.run} to start the HTTP server.
|
|
73
|
-
*
|
|
74
|
-
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
75
|
-
* shape, so `typeof server` carries enough information for view-side helpers
|
|
76
|
-
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
77
|
-
*
|
|
78
|
-
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
79
|
-
* chaining; you almost never set this manually.
|
|
80
|
-
*
|
|
81
|
-
* @example
|
|
82
|
-
* ```ts
|
|
83
|
-
* const server = new McpServer({ name: "my-app", version: "1.0.0" }, {})
|
|
84
|
-
* .registerTool({
|
|
85
|
-
* name: "search",
|
|
86
|
-
* inputSchema: { query: z.string() },
|
|
87
|
-
* view: { component: "search" },
|
|
88
|
-
* }, async ({ query }) => ({ content: `Results for ${query}` }));
|
|
89
|
-
*
|
|
90
|
-
* await server.run();
|
|
91
|
-
* export type AppType = typeof server;
|
|
92
|
-
* ```
|
|
93
|
-
*
|
|
94
|
-
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
95
|
-
*/
|
|
96
78
|
// Side channel populated by `dist/__entry.js` before user code is imported.
|
|
97
79
|
// Set at module scope rather than passed through the constructor because the
|
|
98
80
|
// wrapper has the manifest before the user's `new McpServer(...)` runs, and
|
|
@@ -110,8 +92,12 @@ export function __setBuildManifest(manifest) {
|
|
|
110
92
|
pendingBuildManifest = manifest;
|
|
111
93
|
}
|
|
112
94
|
let pendingSkillsManifest = null;
|
|
95
|
+
let cachedDiskManifest = null;
|
|
96
|
+
let discoveredSkills = null;
|
|
97
|
+
let warnedOnMissingSkills = false;
|
|
113
98
|
export function __setSkillsManifest(manifest) {
|
|
114
99
|
pendingSkillsManifest = manifest;
|
|
100
|
+
discoveredSkills = null;
|
|
115
101
|
}
|
|
116
102
|
// Pure and `this`-free so it can run inside the `super(...)` call, before `this`
|
|
117
103
|
// exists — the capability must be present for the `initialize` response.
|
|
@@ -130,27 +116,37 @@ function withSkillsCapability(options, skybridgeOptions) {
|
|
|
130
116
|
},
|
|
131
117
|
};
|
|
132
118
|
}
|
|
119
|
+
/**
|
|
120
|
+
* Typed registration sugar over the MCP SDK's `McpServer`: a tool registry
|
|
121
|
+
* that carries input/output/meta shapes, view resources, per-tool security
|
|
122
|
+
* schemes, and prompt/resource registration. A {@link Skybridge} app builds
|
|
123
|
+
* one of these per request and hands it to your `handler`; chain
|
|
124
|
+
* {@link McpServer.registerTool} calls on it and return the result.
|
|
125
|
+
*
|
|
126
|
+
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
127
|
+
* shape, so `typeof app` carries enough information for view-side helpers
|
|
128
|
+
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
129
|
+
*
|
|
130
|
+
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
131
|
+
* chaining; you almost never set this manually.
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* ```ts
|
|
135
|
+
* export const app = new Skybridge({
|
|
136
|
+
* name: "my-app",
|
|
137
|
+
* version: "1.0.0",
|
|
138
|
+
* handler: (server) =>
|
|
139
|
+
* server.registerTool({
|
|
140
|
+
* name: "search",
|
|
141
|
+
* inputSchema: { query: z.string() },
|
|
142
|
+
* view: { component: "search" },
|
|
143
|
+
* }, async ({ query }) => ({ content: `Results for ${query}` })),
|
|
144
|
+
* });
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
148
|
+
*/
|
|
133
149
|
export class McpServer extends McpServerBaseOmitted {
|
|
134
|
-
/**
|
|
135
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
136
|
-
* custom routes, middleware, or settings — e.g.
|
|
137
|
-
* `server.express.get("/health", ...)`.
|
|
138
|
-
*
|
|
139
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
140
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
141
|
-
* Register your handlers before `run()`;
|
|
142
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
143
|
-
* error handler are appended in that order.
|
|
144
|
-
*
|
|
145
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
146
|
-
* locally and on self-hosted deployments.
|
|
147
|
-
*/
|
|
148
|
-
express;
|
|
149
|
-
customErrorMiddleware = [];
|
|
150
|
-
mcpMiddlewareEntries = [];
|
|
151
|
-
mcpMiddlewareApplied = false;
|
|
152
|
-
middlewareEntriesCache = null;
|
|
153
|
-
registrations = [];
|
|
154
150
|
claimedViews = new Map();
|
|
155
151
|
viewMetaBuilders = new Map();
|
|
156
152
|
/**
|
|
@@ -161,119 +157,65 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
161
157
|
*/
|
|
162
158
|
viewUriByPath = new Map();
|
|
163
159
|
viteManifest = null;
|
|
164
|
-
serverInfo;
|
|
165
|
-
serverOptions;
|
|
166
160
|
oauthEnabled = false;
|
|
167
161
|
resolveResourceMetadataUrl;
|
|
168
|
-
|
|
162
|
+
toolSecuritySchemes = new Map();
|
|
163
|
+
userMiddlewareEntries = [];
|
|
164
|
+
eventRegistry;
|
|
169
165
|
constructor(serverInfo, options, skybridgeOptions) {
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
this.serverInfo = serverInfo;
|
|
173
|
-
this.serverOptions = mergedOptions;
|
|
174
|
-
this.express = express();
|
|
175
|
-
this.express.use(express.json(skybridgeOptions?.json));
|
|
176
|
-
if (skybridgeOptions?.oauth) {
|
|
177
|
-
this.oauthEnabled = true;
|
|
178
|
-
this.resolveResourceMetadataUrl = setupOAuth(this.express, skybridgeOptions.oauth, this.securitySchemesByTool);
|
|
179
|
-
}
|
|
166
|
+
super(serverInfo, withSkillsCapability(options, skybridgeOptions));
|
|
167
|
+
this.oauthEnabled = Boolean(skybridgeOptions?.oauth);
|
|
180
168
|
// Pick up the manifest if `dist/__entry.js` primed it before importing
|
|
181
|
-
// user code.
|
|
182
|
-
//
|
|
183
|
-
// Explicit `setViteManifest` calls still win because they happen after
|
|
184
|
-
// construction.
|
|
169
|
+
// user code. Explicit `setViteManifest` calls still win because they
|
|
170
|
+
// happen after construction.
|
|
185
171
|
if (pendingBuildManifest) {
|
|
186
172
|
this.setViteManifest(pendingBuildManifest);
|
|
187
|
-
pendingBuildManifest = null;
|
|
188
173
|
}
|
|
189
174
|
this.setupSkills(Boolean(skybridgeOptions?.skills));
|
|
190
175
|
}
|
|
191
|
-
registerResource(...args) {
|
|
192
|
-
return this.recordInherited("registerResource", args);
|
|
193
|
-
}
|
|
194
176
|
/**
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
177
|
+
* The per-tool security schemes collected during registration, keyed by tool
|
|
178
|
+
* name. Read by the OAuth layer to decide whether anonymous requests are
|
|
179
|
+
* allowed and which schemes gate a given `tools/call`.
|
|
180
|
+
*
|
|
181
|
+
* @internal
|
|
198
182
|
*/
|
|
199
|
-
|
|
200
|
-
return this.
|
|
201
|
-
name,
|
|
202
|
-
config,
|
|
203
|
-
cb,
|
|
204
|
-
]);
|
|
205
|
-
}
|
|
206
|
-
recordInherited(method, args) {
|
|
207
|
-
const base = McpServerBase.prototype[method];
|
|
208
|
-
let registered;
|
|
209
|
-
this.record((target) => {
|
|
210
|
-
const result = base.apply(target, args);
|
|
211
|
-
if (target === this) {
|
|
212
|
-
registered = result;
|
|
213
|
-
}
|
|
214
|
-
});
|
|
215
|
-
return registered;
|
|
183
|
+
get securitySchemesByTool() {
|
|
184
|
+
return this.toolSecuritySchemes;
|
|
216
185
|
}
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
};
|
|
186
|
+
/**
|
|
187
|
+
* Inject the resolver the app uses to build the protected-resource metadata
|
|
188
|
+
* URL, so tool handlers can emit in-band auth challenges.
|
|
189
|
+
*
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
setResourceMetadataUrlResolver(resolve) {
|
|
193
|
+
this.resolveResourceMetadataUrl = resolve;
|
|
194
|
+
return this;
|
|
227
195
|
}
|
|
228
196
|
setupSkills(enabled) {
|
|
229
|
-
const manifest = pendingSkillsManifest;
|
|
230
|
-
pendingSkillsManifest = null;
|
|
231
197
|
if (!enabled) {
|
|
232
198
|
return;
|
|
233
199
|
}
|
|
234
|
-
|
|
235
|
-
if (
|
|
200
|
+
discoveredSkills ??= pendingSkillsManifest ?? discoverSkills(SKILLS_DIR);
|
|
201
|
+
if (discoveredSkills.length === 0 && !warnedOnMissingSkills) {
|
|
202
|
+
warnedOnMissingSkills = true;
|
|
236
203
|
console.warn(`skybridge: the "skills" option is enabled but no skills were found in "${SKILLS_DIR}". Add a <name>/SKILL.md there, or remove the option.`);
|
|
237
204
|
}
|
|
238
|
-
registerSkills(this
|
|
239
|
-
}
|
|
240
|
-
use(pathOrHandler, ...handlers) {
|
|
241
|
-
// Branching is load-bearing: Express's `app.use` overloads can't be
|
|
242
|
-
// resolved against a `string | RequestHandler` union, so we narrow.
|
|
243
|
-
if (typeof pathOrHandler === "string") {
|
|
244
|
-
this.express.use(pathOrHandler, ...handlers);
|
|
245
|
-
}
|
|
246
|
-
else {
|
|
247
|
-
this.express.use(pathOrHandler, ...handlers);
|
|
248
|
-
}
|
|
249
|
-
return this;
|
|
250
|
-
}
|
|
251
|
-
useOnError(pathOrHandler, ...handlers) {
|
|
252
|
-
if (typeof pathOrHandler === "string") {
|
|
253
|
-
this.customErrorMiddleware.push({ path: pathOrHandler, handlers });
|
|
254
|
-
}
|
|
255
|
-
else {
|
|
256
|
-
this.customErrorMiddleware.push({
|
|
257
|
-
handlers: [pathOrHandler, ...handlers],
|
|
258
|
-
});
|
|
259
|
-
}
|
|
260
|
-
return this;
|
|
205
|
+
registerSkills(this, discoveredSkills);
|
|
261
206
|
}
|
|
262
207
|
mcpMiddleware(filterOrHandler,
|
|
263
208
|
// biome-ignore lint/suspicious/noExplicitAny: overloads narrow the handler type at call sites; implementation must accept all variants
|
|
264
209
|
maybeHandler) {
|
|
265
|
-
if (this.mcpMiddlewareApplied) {
|
|
266
|
-
throw new Error("Cannot register MCP middleware after run() or connect() has been called");
|
|
267
|
-
}
|
|
268
210
|
const handler = maybeHandler;
|
|
269
211
|
if (typeof filterOrHandler === "function") {
|
|
270
|
-
this.
|
|
212
|
+
this.userMiddlewareEntries.push({
|
|
271
213
|
filter: null,
|
|
272
214
|
handler: filterOrHandler,
|
|
273
215
|
});
|
|
274
216
|
}
|
|
275
217
|
else if (handler) {
|
|
276
|
-
this.
|
|
218
|
+
this.userMiddlewareEntries.push({
|
|
277
219
|
filter: filterOrHandler,
|
|
278
220
|
handler,
|
|
279
221
|
});
|
|
@@ -283,11 +225,15 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
283
225
|
}
|
|
284
226
|
return this;
|
|
285
227
|
}
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
228
|
+
/**
|
|
229
|
+
* This instance's protocol-level middleware: the framework's own entries
|
|
230
|
+
* (view `_meta` on `resources/list`, version-agnostic view resolution on
|
|
231
|
+
* `resources/read`, the top-level `securitySchemes` mirror on `tools/list`)
|
|
232
|
+
* followed by the ones registered via {@link McpServer.mcpMiddleware}.
|
|
233
|
+
*
|
|
234
|
+
* @internal
|
|
235
|
+
*/
|
|
236
|
+
protocolMiddlewareEntries() {
|
|
291
237
|
// Surface view-resource _meta on `resources/list` (per ext-apps spec:
|
|
292
238
|
// hosts/checkers read CSP & domain at list time before fetching content).
|
|
293
239
|
const viewListMetaEntry = {
|
|
@@ -363,139 +309,12 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
363
309
|
return result;
|
|
364
310
|
},
|
|
365
311
|
};
|
|
366
|
-
|
|
367
|
-
const entries = [
|
|
368
|
-
...(monitoringEntry ? [monitoringEntry] : []),
|
|
312
|
+
return [
|
|
369
313
|
viewListMetaEntry,
|
|
370
314
|
viewReadResolveEntry,
|
|
371
315
|
toolsListSecuritySchemesEntry,
|
|
372
|
-
...this.
|
|
316
|
+
...this.userMiddlewareEntries,
|
|
373
317
|
];
|
|
374
|
-
this.middlewareEntriesCache = entries;
|
|
375
|
-
this.instrumentHandlers(this.server);
|
|
376
|
-
}
|
|
377
|
-
instrumentHandlers(server) {
|
|
378
|
-
const entries = this.middlewareEntriesCache ?? [];
|
|
379
|
-
const { requestHandlers, notificationHandlers } = getHandlerMaps(server);
|
|
380
|
-
const instrumentMap = (map, isNotification) => {
|
|
381
|
-
for (const [method, handler] of map) {
|
|
382
|
-
map.set(method, buildMiddlewareChain(method, isNotification, handler, entries));
|
|
383
|
-
}
|
|
384
|
-
const originalSet = map.set.bind(map);
|
|
385
|
-
map.set = (method, handler) => originalSet(method, buildMiddlewareChain(method, isNotification, handler, entries));
|
|
386
|
-
};
|
|
387
|
-
instrumentMap(requestHandlers, false);
|
|
388
|
-
instrumentMap(notificationHandlers, true);
|
|
389
|
-
}
|
|
390
|
-
/**
|
|
391
|
-
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
392
|
-
* when you're embedding Skybridge in a host that already manages its own
|
|
393
|
-
* transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
|
|
394
|
-
* which sets the transport up for you. Locks in any middleware registered
|
|
395
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
396
|
-
* throw afterwards.
|
|
397
|
-
*/
|
|
398
|
-
async connect(transport) {
|
|
399
|
-
this.applyMcpMiddleware();
|
|
400
|
-
return McpServerBase.prototype.connect.call(this, transport);
|
|
401
|
-
}
|
|
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() {
|
|
412
|
-
this.applyMcpMiddleware();
|
|
413
|
-
const fresh = new McpServerBase(this.serverInfo, this.serverOptions);
|
|
414
|
-
for (const apply of this.registrations) {
|
|
415
|
-
apply(fresh);
|
|
416
|
-
}
|
|
417
|
-
this.instrumentHandlers(fresh.server);
|
|
418
|
-
return fresh.server;
|
|
419
|
-
}
|
|
420
|
-
/**
|
|
421
|
-
* Apply an SDK registration to the singleton and remember it, so each
|
|
422
|
-
* per-request instance can be built with the same surface.
|
|
423
|
-
*/
|
|
424
|
-
record(apply) {
|
|
425
|
-
this.registrations.push(apply);
|
|
426
|
-
apply(this);
|
|
427
|
-
}
|
|
428
|
-
/** Records a raw request handler (used for methods the SDK has no sugar for). */
|
|
429
|
-
recordRequestHandler(...args) {
|
|
430
|
-
this.record((target) => {
|
|
431
|
-
target.server.setRequestHandler(...args);
|
|
432
|
-
});
|
|
433
|
-
}
|
|
434
|
-
/**
|
|
435
|
-
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
436
|
-
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
437
|
-
* via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
|
|
438
|
-
* any MCP middleware registered via {@link McpServer.mcpMiddleware}.
|
|
439
|
-
*
|
|
440
|
-
* On Cloudflare Workers / workerd, returns an object exposing `fetch` so
|
|
441
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
442
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
443
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
444
|
-
* Node, returns `undefined` once listening.
|
|
445
|
-
*/
|
|
446
|
-
async run() {
|
|
447
|
-
this.applyMcpMiddleware();
|
|
448
|
-
if (process.env.VERCEL === "1") {
|
|
449
|
-
// createApp only reads httpServer inside its dev-only branch
|
|
450
|
-
// (viewsDevServer); under VERCEL=1 + NODE_ENV=production it's a
|
|
451
|
-
// bare object passed to satisfy the required parameter.
|
|
452
|
-
const httpServer = http.createServer();
|
|
453
|
-
await createApp({
|
|
454
|
-
mcpServer: this,
|
|
455
|
-
httpServer,
|
|
456
|
-
errorMiddleware: this.customErrorMiddleware,
|
|
457
|
-
});
|
|
458
|
-
return this.express;
|
|
459
|
-
}
|
|
460
|
-
const httpServer = http.createServer();
|
|
461
|
-
await createApp({
|
|
462
|
-
mcpServer: this,
|
|
463
|
-
httpServer,
|
|
464
|
-
errorMiddleware: this.customErrorMiddleware,
|
|
465
|
-
});
|
|
466
|
-
httpServer.on("request", this.express);
|
|
467
|
-
const port = parseInt(process.env.__PORT ?? "3000", 10);
|
|
468
|
-
await new Promise((resolve, reject) => {
|
|
469
|
-
httpServer.on("error", (error) => {
|
|
470
|
-
console.error("Failed to start server:", error);
|
|
471
|
-
reject(error);
|
|
472
|
-
});
|
|
473
|
-
httpServer.listen(port, () => {
|
|
474
|
-
resolve();
|
|
475
|
-
});
|
|
476
|
-
});
|
|
477
|
-
// On workerd, bridge the Node http server to a Workers fetch handler.
|
|
478
|
-
// The specifier is held in a variable to sidestep tsc's module resolution
|
|
479
|
-
// (`cloudflare:node` only exists under wrangler/workerd).
|
|
480
|
-
if (typeof navigator !== "undefined" &&
|
|
481
|
-
navigator.userAgent === "Cloudflare-Workers") {
|
|
482
|
-
const cloudflareNode = "cloudflare:node";
|
|
483
|
-
const { httpServerHandler } = await import(cloudflareNode);
|
|
484
|
-
return httpServerHandler({ port });
|
|
485
|
-
}
|
|
486
|
-
const shutdown = () => {
|
|
487
|
-
// Drop both handlers so a second signal falls through to Node's default
|
|
488
|
-
// (force-quit on a second Ctrl+C while drain is hanging).
|
|
489
|
-
process.off("SIGTERM", shutdown);
|
|
490
|
-
process.off("SIGINT", shutdown);
|
|
491
|
-
httpServer.close(() => process.exit(0));
|
|
492
|
-
// Force exit if connections don't drain in time so the port is still
|
|
493
|
-
// released promptly (e.g. for nodemon restarts).
|
|
494
|
-
setTimeout(() => process.exit(0), 3000).unref();
|
|
495
|
-
};
|
|
496
|
-
process.on("SIGTERM", shutdown);
|
|
497
|
-
process.on("SIGINT", shutdown);
|
|
498
|
-
return undefined;
|
|
499
318
|
}
|
|
500
319
|
enforceOneToolPerView(component, toolName) {
|
|
501
320
|
const existingTool = this.claimedViews.get(component);
|
|
@@ -536,52 +355,32 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
536
355
|
}
|
|
537
356
|
return { serverUrl, assetsBasePath, connectDomains, contentMetaOverrides };
|
|
538
357
|
}
|
|
539
|
-
registerViewResources(toolName, view, toolMeta) {
|
|
358
|
+
registerViewResources(toolName, view, toolMeta, openai) {
|
|
540
359
|
// Append a content-derived version param so hosts (e.g. ChatGPT) bust
|
|
541
360
|
// their cache when the bundle changes, but keep the URI stable across
|
|
542
361
|
// `tools/list` calls when the bundle hasn't changed.
|
|
543
362
|
const versionParam = this.computeViewVersionParam(view.component);
|
|
544
363
|
const viewResource = {
|
|
545
|
-
hostType: "mcp-app",
|
|
546
364
|
uri: `ui://views/ext-apps/${view.component}.html${versionParam}`,
|
|
547
365
|
mimeType: "text/html;profile=mcp-app",
|
|
548
366
|
buildContentMeta: ({ resourceDomains, connectDomains, domain, baseUriDomains }, overrides) => {
|
|
549
|
-
const
|
|
550
|
-
ui: {
|
|
551
|
-
csp: {
|
|
552
|
-
resourceDomains,
|
|
553
|
-
connectDomains,
|
|
554
|
-
baseUriDomains,
|
|
555
|
-
},
|
|
556
|
-
domain,
|
|
557
|
-
},
|
|
558
|
-
};
|
|
559
|
-
const fromView = {
|
|
367
|
+
const ui = {
|
|
560
368
|
ui: {
|
|
561
369
|
...(view.description && { description: view.description }),
|
|
562
370
|
...(view.prefersBorder !== undefined && {
|
|
563
371
|
prefersBorder: view.prefersBorder,
|
|
564
372
|
}),
|
|
565
|
-
|
|
373
|
+
domain: overrides.domain ?? view.domain ?? domain,
|
|
566
374
|
csp: {
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
...(view.csp?.connectDomains && {
|
|
571
|
-
connectDomains: view.csp.connectDomains,
|
|
572
|
-
}),
|
|
375
|
+
resourceDomains: unionOf(resourceDomains, view.csp?.resourceDomains),
|
|
376
|
+
connectDomains: unionOf(connectDomains, view.csp?.connectDomains),
|
|
377
|
+
baseUriDomains: unionOf(baseUriDomains, view.csp?.baseUriDomains),
|
|
573
378
|
...(view.csp?.frameDomains && {
|
|
574
379
|
frameDomains: view.csp.frameDomains,
|
|
575
380
|
}),
|
|
576
|
-
...(view.csp?.baseUriDomains && {
|
|
577
|
-
baseUriDomains: view.csp.baseUriDomains,
|
|
578
|
-
}),
|
|
579
381
|
},
|
|
580
382
|
},
|
|
581
383
|
};
|
|
582
|
-
const ui = mergeWithUnion(mergeWithUnion(defaults, fromView), {
|
|
583
|
-
ui: overrides,
|
|
584
|
-
});
|
|
585
384
|
const base = {
|
|
586
385
|
...ui,
|
|
587
386
|
...(view.description && {
|
|
@@ -591,10 +390,12 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
591
390
|
"openai/widgetCSP": { redirect_domains: view.csp.redirectDomains },
|
|
592
391
|
}),
|
|
593
392
|
};
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
393
|
+
const meta = { ...base, ...view._meta };
|
|
394
|
+
mergeOpenAIUi(meta, {
|
|
395
|
+
availableDisplayModes: openai?.availableDisplayModes,
|
|
396
|
+
preferredDisplayMode: openai?.preferredDisplayMode,
|
|
397
|
+
});
|
|
398
|
+
return meta;
|
|
598
399
|
},
|
|
599
400
|
};
|
|
600
401
|
this.registerViewResource({ name: toolName, viewResource, view });
|
|
@@ -607,7 +408,7 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
607
408
|
toolMeta.ui = { ...toolMeta.ui, resourceUri: viewResource.uri };
|
|
608
409
|
}
|
|
609
410
|
registerViewResource({ name, viewResource, view, }) {
|
|
610
|
-
const {
|
|
411
|
+
const { uri: viewUri, mimeType, buildContentMeta } = viewResource;
|
|
611
412
|
const buildMeta = (extra) => {
|
|
612
413
|
const { serverUrl, connectDomains, contentMetaOverrides } = this.resolveViewRequestContext(extra);
|
|
613
414
|
return buildContentMeta({
|
|
@@ -629,13 +430,11 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
629
430
|
const viewBase = `${serverUrl}${assetsBasePath}`;
|
|
630
431
|
const html = isProduction
|
|
631
432
|
? templateHelper.renderProduction({
|
|
632
|
-
hostType,
|
|
633
433
|
serverUrl: viewBase,
|
|
634
434
|
viewFile: this.lookupViewFile(view.component),
|
|
635
435
|
styleFile: this.lookupDistFile("style.css") ?? "",
|
|
636
436
|
})
|
|
637
437
|
: templateHelper.renderDevelopment({
|
|
638
|
-
hostType,
|
|
639
438
|
serverUrl: viewBase,
|
|
640
439
|
viewName: view.component,
|
|
641
440
|
});
|
|
@@ -668,6 +467,9 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
668
467
|
captureToolError(extra, error);
|
|
669
468
|
throw error;
|
|
670
469
|
}
|
|
470
|
+
if (isInputRequiredResult(result)) {
|
|
471
|
+
return result;
|
|
472
|
+
}
|
|
671
473
|
warnOnLargeToolOutput(result, toolName);
|
|
672
474
|
return {
|
|
673
475
|
...result,
|
|
@@ -728,13 +530,219 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
728
530
|
if (this.viteManifest) {
|
|
729
531
|
return this.viteManifest;
|
|
730
532
|
}
|
|
731
|
-
|
|
533
|
+
cachedDiskManifest ??= JSON.parse(readFileSync(path.join(process.cwd(), "dist", "assets", ".vite", "manifest.json"), "utf-8"));
|
|
534
|
+
return cachedDiskManifest ?? {};
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* @experimental Register an MCP Events type that hosts can subscribe to, per
|
|
538
|
+
* the Triggers & Events working group draft. Skybridge serves `events/list`,
|
|
539
|
+
* `events/subscribe` and `events/unsubscribe`, checks auth and arguments,
|
|
540
|
+
* verifies the callback URL, then hands each subscription to `onSubscribe`.
|
|
541
|
+
* Delivering the events is up to you, for example with {@link deliverEvent}.
|
|
542
|
+
* API may change.
|
|
543
|
+
*
|
|
544
|
+
* @example
|
|
545
|
+
* ```ts
|
|
546
|
+
* server.registerEvent(
|
|
547
|
+
* {
|
|
548
|
+
* name: "comment.created",
|
|
549
|
+
* description: "Fires when someone comments on a document",
|
|
550
|
+
* inputSchema: { documentId: z.string() },
|
|
551
|
+
* payloadSchema: { documentId: z.string(), excerpt: z.string() },
|
|
552
|
+
* },
|
|
553
|
+
* {
|
|
554
|
+
* onSubscribe: ({ documentId }, { subscription }) =>
|
|
555
|
+
* webhooks.upsert({ ...subscription, filter: { documentId } }),
|
|
556
|
+
* onUnsubscribe: (_args, { subscription }) =>
|
|
557
|
+
* webhooks.remove(subscription.id),
|
|
558
|
+
* },
|
|
559
|
+
* );
|
|
560
|
+
* ```
|
|
561
|
+
*
|
|
562
|
+
* @see https://docs.skybridge.tech/api-reference/register-event
|
|
563
|
+
*/
|
|
564
|
+
registerEvent(config, hooks) {
|
|
565
|
+
if (!this.eventRegistry) {
|
|
566
|
+
this.server.registerCapabilities({ events: {} });
|
|
567
|
+
this.eventRegistry = new EventRegistry(this.server);
|
|
568
|
+
}
|
|
569
|
+
this.eventRegistry.add(config, hooks);
|
|
570
|
+
return this;
|
|
571
|
+
}
|
|
572
|
+
/**
|
|
573
|
+
* Register a ChatGPT file viewer, from the OpenAI MCP extensions: a tool
|
|
574
|
+
* with a file entrypoint for `extensions` and a view. ChatGPT desktop calls
|
|
575
|
+
* it with the file the user opened, as `{ file: { name, resourceUri } }`.
|
|
576
|
+
* Read and save the file from the view with `useFileResource`.
|
|
577
|
+
*
|
|
578
|
+
* @example
|
|
579
|
+
* ```ts
|
|
580
|
+
* server.registerFileViewer(
|
|
581
|
+
* {
|
|
582
|
+
* name: "part-viewer",
|
|
583
|
+
* title: "Part Viewer",
|
|
584
|
+
* extensions: [".stl", ".step"],
|
|
585
|
+
* view: { component: "part-viewer" },
|
|
586
|
+
* },
|
|
587
|
+
* async ({ file }) => ({ structuredContent: { name: file.name } }),
|
|
588
|
+
* );
|
|
589
|
+
* ```
|
|
590
|
+
*
|
|
591
|
+
* @see https://docs.skybridge.tech/api-reference/register-file-viewer
|
|
592
|
+
*/
|
|
593
|
+
registerFileViewer(config, cb) {
|
|
594
|
+
const { extensions, openai, ...toolConfig } = config;
|
|
595
|
+
return this.registerTool({
|
|
596
|
+
...toolConfig,
|
|
597
|
+
inputSchema: fileEntrypointInput,
|
|
598
|
+
openai: { ...openai, entrypoints: [{ type: "file", extensions }] },
|
|
599
|
+
}, cb);
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* Register the composer at-mention search for ChatGPT, from the OpenAI MCP
|
|
603
|
+
* extensions. When the user types `@` and your app name, ChatGPT calls
|
|
604
|
+
* `handler` with the typed text and lists the returned resource links.
|
|
605
|
+
* Skybridge registers it as a tool hidden from the model.
|
|
606
|
+
*
|
|
607
|
+
* @example
|
|
608
|
+
* ```ts
|
|
609
|
+
* server.registerMentions({
|
|
610
|
+
* name: "search_parts",
|
|
611
|
+
* handler: async ({ query }) => ({
|
|
612
|
+
* items: findParts(query).map((part) => ({
|
|
613
|
+
* type: "resource_link",
|
|
614
|
+
* uri: `parts://${part.id}`,
|
|
615
|
+
* name: part.name,
|
|
616
|
+
* })),
|
|
617
|
+
* }),
|
|
618
|
+
* });
|
|
619
|
+
* ```
|
|
620
|
+
*
|
|
621
|
+
* @see https://docs.skybridge.tech/api-reference/register-mentions
|
|
622
|
+
*/
|
|
623
|
+
registerMentions(config) {
|
|
624
|
+
this.registerTool({
|
|
625
|
+
name: config.name,
|
|
626
|
+
description: config.description ?? "Search items to mention.",
|
|
627
|
+
annotations: { readOnlyHint: true },
|
|
628
|
+
inputSchema: { query: z.string() },
|
|
629
|
+
_meta: {
|
|
630
|
+
"openai/extensions": { "mentions/search": {} },
|
|
631
|
+
ui: { visibility: ["app"] },
|
|
632
|
+
},
|
|
633
|
+
}, async ({ query }, extra) => ({
|
|
634
|
+
content: [],
|
|
635
|
+
structuredContent: await config.handler({ query }, extra),
|
|
636
|
+
}));
|
|
637
|
+
return this;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* Register app settings for ChatGPT, from the OpenAI MCP extensions.
|
|
641
|
+
* Skybridge registers a read tool and an update tool from `fields`, and
|
|
642
|
+
* advertises them in the `openai/settings` server capability. ChatGPT shows
|
|
643
|
+
* the settings page and calls `update` with the changed fields only. Store
|
|
644
|
+
* the values yourself, for example per user.
|
|
645
|
+
*
|
|
646
|
+
* @example
|
|
647
|
+
* ```ts
|
|
648
|
+
* server.registerSettings({
|
|
649
|
+
* fields: {
|
|
650
|
+
* units: { title: "Units", schema: z.enum(["mm", "in"]) },
|
|
651
|
+
* showGrid: { title: "Show grid", schema: z.boolean() },
|
|
652
|
+
* },
|
|
653
|
+
* read: (extra) => loadSettings(extra),
|
|
654
|
+
* update: (set, extra) => saveSettings(set, extra),
|
|
655
|
+
* });
|
|
656
|
+
* ```
|
|
657
|
+
*
|
|
658
|
+
* @see https://docs.skybridge.tech/api-reference/register-settings
|
|
659
|
+
*/
|
|
660
|
+
registerSettings(config) {
|
|
661
|
+
const { fields, layout, readTool = "settings.read", updateTool = "settings.update", } = config;
|
|
662
|
+
const values = z
|
|
663
|
+
.strictObject(Object.fromEntries(Object.entries(fields).map(([name, { schema, title, description }]) => [
|
|
664
|
+
name,
|
|
665
|
+
schema.meta({
|
|
666
|
+
title,
|
|
667
|
+
...(description !== undefined && { description }),
|
|
668
|
+
}),
|
|
669
|
+
])))
|
|
670
|
+
.required();
|
|
671
|
+
const { $schema: _, ...schema } = z.toJSONSchema(values);
|
|
672
|
+
for (const [name, property] of Object.entries(schema.properties ?? {})) {
|
|
673
|
+
if (fields[name]?.schema.safeParse(undefined).data !== undefined) {
|
|
674
|
+
throw new Error(`Setting "${name}" declares a default: return current values from \`read\` instead.`);
|
|
675
|
+
}
|
|
676
|
+
if (typeof property === "boolean" ||
|
|
677
|
+
!["boolean", "string", "number", "integer"].includes(String(property.type)) ||
|
|
678
|
+
(property.enum !== undefined && property.type !== "string")) {
|
|
679
|
+
throw new Error(`Setting "${name}" must be a boolean, string, string enum, number or integer.`);
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
const placed = new Set();
|
|
683
|
+
for (const group of layout ?? []) {
|
|
684
|
+
for (const item of group.items) {
|
|
685
|
+
if (item.kind !== "property") {
|
|
686
|
+
continue;
|
|
687
|
+
}
|
|
688
|
+
if (!Object.hasOwn(fields, item.property) ||
|
|
689
|
+
placed.has(item.property)) {
|
|
690
|
+
throw new Error(`Settings layout names an unknown or duplicate field "${item.property}".`);
|
|
691
|
+
}
|
|
692
|
+
placed.add(item.property);
|
|
693
|
+
}
|
|
694
|
+
}
|
|
695
|
+
this.registerTool({
|
|
696
|
+
name: readTool,
|
|
697
|
+
description: "Read the app settings.",
|
|
698
|
+
annotations: { readOnlyHint: true, openWorldHint: false },
|
|
699
|
+
inputSchema: {},
|
|
700
|
+
outputSchema: {
|
|
701
|
+
schema: z.record(z.string(), z.unknown()),
|
|
702
|
+
values,
|
|
703
|
+
layout: z.array(z.record(z.string(), z.unknown())).optional(),
|
|
704
|
+
},
|
|
705
|
+
}, async (_args, extra) => ({
|
|
706
|
+
content: [],
|
|
707
|
+
structuredContent: {
|
|
708
|
+
schema,
|
|
709
|
+
values: values.parse(await config.read(extra)),
|
|
710
|
+
layout,
|
|
711
|
+
},
|
|
712
|
+
}));
|
|
713
|
+
this.registerTool({
|
|
714
|
+
name: updateTool,
|
|
715
|
+
description: "Update the app settings.",
|
|
716
|
+
annotations: {
|
|
717
|
+
destructiveHint: false,
|
|
718
|
+
idempotentHint: true,
|
|
719
|
+
openWorldHint: false,
|
|
720
|
+
},
|
|
721
|
+
inputSchema: {
|
|
722
|
+
set: values
|
|
723
|
+
.partial()
|
|
724
|
+
.refine((set) => Object.keys(set).length > 0)
|
|
725
|
+
.meta({ minProperties: 1 }),
|
|
726
|
+
},
|
|
727
|
+
outputSchema: { values },
|
|
728
|
+
}, async ({ set }, extra) => ({
|
|
729
|
+
content: [],
|
|
730
|
+
structuredContent: {
|
|
731
|
+
values: values.parse(await config.update(set, extra)),
|
|
732
|
+
},
|
|
733
|
+
}));
|
|
734
|
+
const capability = { readTool, updateTool };
|
|
735
|
+
this.server.registerCapabilities({
|
|
736
|
+
extensions: { "openai/settings": capability },
|
|
737
|
+
experimental: { "openai/settings": capability },
|
|
738
|
+
});
|
|
739
|
+
return this;
|
|
732
740
|
}
|
|
733
741
|
registerTool(rawConfig, rawCb) {
|
|
734
742
|
const baseFn = McpServerBase.prototype.registerTool;
|
|
735
743
|
const config = rawConfig;
|
|
736
744
|
const cb = rawCb;
|
|
737
|
-
const { name, view, auth, securitySchemes: rawSecuritySchemes, _meta: userToolMeta, ...toolFields } = config;
|
|
745
|
+
const { name, view, auth, securitySchemes: rawSecuritySchemes, openai, _meta: userToolMeta, ...toolFields } = config;
|
|
738
746
|
const authNeedsProvider = auth !== undefined &&
|
|
739
747
|
(!auth.allowsAnonymous || Boolean(auth.scopes?.length));
|
|
740
748
|
if (rawSecuritySchemes === undefined &&
|
|
@@ -745,29 +753,46 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
745
753
|
const securitySchemes = rawSecuritySchemes ??
|
|
746
754
|
(auth && this.oauthEnabled ? authToSecuritySchemes(auth) : undefined);
|
|
747
755
|
const toolMeta = { ...userToolMeta };
|
|
748
|
-
this.
|
|
756
|
+
this.toolSecuritySchemes.set(name, securitySchemes);
|
|
749
757
|
if (securitySchemes) {
|
|
750
758
|
// SEP-1488 puts `securitySchemes` at the top level of the tool
|
|
751
759
|
// descriptor, but the SDK's `registerTool` drops unknown top-level
|
|
752
760
|
// fields, so the canonical spot isn't reachable without intercepting
|
|
753
761
|
// `tools/list`. Use the `_meta` back-compat mirror documented in the
|
|
754
|
-
//
|
|
762
|
+
// ChatGPT plugin reference until SEP-1488 lands in the spec.
|
|
755
763
|
toolMeta.securitySchemes = securitySchemes;
|
|
756
764
|
}
|
|
765
|
+
if (openai) {
|
|
766
|
+
if (!view) {
|
|
767
|
+
throw new Error(`skybridge: tool "${name}" sets \`openai\` options but has no \`view\`.`);
|
|
768
|
+
}
|
|
769
|
+
const opensWithoutInput = openai.entrypoints?.some(({ type }) => type === "global" || type === "thread");
|
|
770
|
+
if (opensWithoutInput && !acceptsEmptyInput(toolFields.inputSchema)) {
|
|
771
|
+
throw new Error(`skybridge: tool "${name}" has a global or thread entrypoint, so ChatGPT calls it with \`{}\`, but its input schema rejects \`{}\`. Make every input optional.`);
|
|
772
|
+
}
|
|
773
|
+
const badExtension = openai.entrypoints
|
|
774
|
+
?.flatMap((entrypoint) => entrypoint.type === "file" ? entrypoint.extensions : [])
|
|
775
|
+
.find((extension) => !extension.startsWith("."));
|
|
776
|
+
if (badExtension !== undefined) {
|
|
777
|
+
throw new Error(`skybridge: tool "${name}" has a file entrypoint extension "${badExtension}" that doesn't start with ".".`);
|
|
778
|
+
}
|
|
779
|
+
mergeOpenAIUi(toolMeta, {
|
|
780
|
+
entrypoints: openai.entrypoints,
|
|
781
|
+
preferredModelDisplayMode: openai.preferredModelDisplayMode,
|
|
782
|
+
});
|
|
783
|
+
}
|
|
757
784
|
if (view) {
|
|
758
785
|
this.enforceOneToolPerView(view.component, name);
|
|
759
|
-
this.registerViewResources(name, view, toolMeta);
|
|
786
|
+
this.registerViewResources(name, view, toolMeta, openai);
|
|
760
787
|
}
|
|
761
788
|
const wrappedCb = this.decorateToolHandler(cb, {
|
|
762
789
|
attachViewUUID: Boolean(view),
|
|
763
790
|
securitySchemes,
|
|
764
791
|
toolName: name,
|
|
765
792
|
});
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
: wrappedCb);
|
|
770
|
-
});
|
|
793
|
+
baseFn.call(this, name, { ...toolFields, _meta: toolMeta }, toolFields.inputSchema === undefined
|
|
794
|
+
? (extra) => wrappedCb({}, extra)
|
|
795
|
+
: wrappedCb);
|
|
771
796
|
return this;
|
|
772
797
|
}
|
|
773
798
|
}
|