skybridge 0.0.0-dev.97c9ddf → 0.0.0-dev.97e4bf7
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 +15 -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-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 +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 +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 +21 -17
- 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 +8 -6
- 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 +3 -4
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +83 -77
- 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 +2 -2
- 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 +97 -49
- package/dist/server/auth-extra.test-d.js.map +1 -1
- package/dist/server/auth.d.ts +7 -8
- 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 +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 +43 -32
- package/dist/server/express.js.map +1 -1
- package/dist/server/express.test.js +221 -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/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 -3
- package/dist/server/index.js +5 -1
- package/dist/server/index.js.map +1 -1
- package/dist/server/mcp-errors.test.js +41 -0
- package/dist/server/mcp-errors.test.js.map +1 -0
- package/dist/server/middleware.d.ts +6 -6
- 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 +222 -150
- package/dist/server/middleware.test.js.map +1 -1
- package/dist/server/register-tool.test.js +230 -0
- package/dist/server/register-tool.test.js.map +1 -0
- package/dist/server/server.d.ts +327 -128
- package/dist/server/server.js +362 -305
- package/dist/server/server.js.map +1 -1
- package/dist/server/skills-integration.test.js +19 -12
- package/dist/server/skills-integration.test.js.map +1 -1
- package/dist/server/skills.d.ts +3 -5
- package/dist/server/skills.js +17 -24
- package/dist/server/skills.js.map +1 -1
- package/dist/server/skills.test.js +8 -12
- 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.js +167 -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 +25 -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.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 +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 +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 +74 -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 +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 +6 -2
- package/dist/web/hooks/index.js +6 -2
- 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.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-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.d.ts +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 +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-info.test.js → use-host.test.js} +7 -7
- 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.test.js +2 -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-host-info.d.ts +0 -22
- package/dist/web/hooks/use-host-info.js +0 -30
- package/dist/web/hooks/use-host-info.js.map +0 -1
- package/dist/web/hooks/use-host-info.test.js.map +0 -1
- package/dist/web/hooks/use-layout.d.ts +0 -24
- package/dist/web/hooks/use-layout.js +0 -25
- package/dist/web/hooks/use-layout.js.map +0 -1
- package/dist/web/hooks/use-layout.test.js.map +0 -1
- package/dist/web/plugin/data-llm.test.js +0 -81
- package/dist/web/plugin/data-llm.test.js.map +0 -1
- package/dist/web/plugin/plugin-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/hooks/use-host-info.test.d.ts → server/app.test.d.ts} +0 -0
- /package/dist/{web/hooks/use-layout.test.d.ts → server/events.test.d.ts} +0 -0
- /package/dist/{web/plugin/data-llm.test.d.ts → server/mcp-errors.test.d.ts} +0 -0
- /package/dist/{web/plugin/plugin-build.test.d.ts → server/register-tool.test.d.ts} +0 -0
- /package/dist/{web/plugin/plugin.test.d.ts → server/tool-extra.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/transform-data-llm.test.d.ts → hooks/openai-extensions.test.d.ts} +0 -0
package/dist/server/server.js
CHANGED
|
@@ -1,28 +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 {
|
|
6
|
-
import {
|
|
7
|
-
import { mergeWith, union } from "es-toolkit";
|
|
8
|
-
import express, {} from "express";
|
|
4
|
+
import { isInputRequiredResult, McpServer as McpServerBase, } from "@modelcontextprotocol/server";
|
|
5
|
+
import { z } from "zod/v4";
|
|
9
6
|
import { warnOnLargeToolOutput } from "../context-warnings.js";
|
|
10
7
|
import { authToSecuritySchemes, evaluateSecuritySchemes, inBandChallengeResult, } from "./auth/security-schemes.js";
|
|
11
|
-
import {
|
|
12
|
-
import { createApp } from "./express.js";
|
|
8
|
+
import { EventRegistry, } from "./events.js";
|
|
13
9
|
import { hostFromUserAgent } from "./host.js";
|
|
14
|
-
import {
|
|
15
|
-
import { buildMiddlewareChain, captureToolError, getHandlerMaps, } from "./middleware.js";
|
|
10
|
+
import { captureToolError } from "./middleware.js";
|
|
16
11
|
import { resolveServerOrigin } from "./requestOrigin.js";
|
|
17
12
|
import { discoverSkills, registerSkills, SKILLS_EXTENSION_KEY, } from "./skills.js";
|
|
18
13
|
import { templateHelper } from "./templateHelper.js";
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
}
|
|
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
|
+
}
|
|
26
30
|
const SKILLS_DIR = "src/skills";
|
|
27
31
|
/**
|
|
28
32
|
* Normalize an `x-forwarded-prefix` value into a leading-slash, no-trailing-slash
|
|
@@ -37,6 +41,12 @@ function normalizeForwardedPrefix(raw) {
|
|
|
37
41
|
}
|
|
38
42
|
return trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
|
|
39
43
|
}
|
|
44
|
+
const fileEntrypointInput = {
|
|
45
|
+
file: z.object({
|
|
46
|
+
name: z.string().min(1),
|
|
47
|
+
resourceUri: z.string().trim().min(1),
|
|
48
|
+
}),
|
|
49
|
+
};
|
|
40
50
|
/**
|
|
41
51
|
* Drop the query string from a `ui://` view URI, leaving the bare path. The
|
|
42
52
|
* `?v=` cache key is the only query we append, so a plain split is enough and
|
|
@@ -65,35 +75,6 @@ export function normalizeContent(content) {
|
|
|
65
75
|
return [content];
|
|
66
76
|
}
|
|
67
77
|
const McpServerBaseOmitted = McpServerBase;
|
|
68
|
-
/**
|
|
69
|
-
* The Skybridge server. Extends the MCP SDK's `McpServer` with a typed tool
|
|
70
|
-
* registry, view resources, an embedded Express app, and protocol-level
|
|
71
|
-
* middleware. Construct it with the same `Implementation` info you would pass
|
|
72
|
-
* to the SDK, chain {@link McpServer.registerTool} calls to declare tools,
|
|
73
|
-
* then call {@link McpServer.run} to start the HTTP server.
|
|
74
|
-
*
|
|
75
|
-
* The `TTools` generic accumulates each registered tool's input/output/meta
|
|
76
|
-
* shape, so `typeof server` carries enough information for view-side helpers
|
|
77
|
-
* like {@link generateHelpers} to produce fully-typed hooks.
|
|
78
|
-
*
|
|
79
|
-
* @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
|
|
80
|
-
* chaining; you almost never set this manually.
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* ```ts
|
|
84
|
-
* const server = new McpServer({ name: "my-app", version: "1.0.0" }, {})
|
|
85
|
-
* .registerTool({
|
|
86
|
-
* name: "search",
|
|
87
|
-
* inputSchema: { query: z.string() },
|
|
88
|
-
* view: { component: "search" },
|
|
89
|
-
* }, async ({ query }) => ({ content: `Results for ${query}` }));
|
|
90
|
-
*
|
|
91
|
-
* await server.run();
|
|
92
|
-
* export type AppType = typeof server;
|
|
93
|
-
* ```
|
|
94
|
-
*
|
|
95
|
-
* @see https://docs.skybridge.tech/api-reference/mcp-server
|
|
96
|
-
*/
|
|
97
78
|
// Side channel populated by `dist/__entry.js` before user code is imported.
|
|
98
79
|
// Set at module scope rather than passed through the constructor because the
|
|
99
80
|
// wrapper has the manifest before the user's `new McpServer(...)` runs, and
|
|
@@ -111,8 +92,12 @@ export function __setBuildManifest(manifest) {
|
|
|
111
92
|
pendingBuildManifest = manifest;
|
|
112
93
|
}
|
|
113
94
|
let pendingSkillsManifest = null;
|
|
95
|
+
let cachedDiskManifest = null;
|
|
96
|
+
let discoveredSkills = null;
|
|
97
|
+
let warnedOnMissingSkills = false;
|
|
114
98
|
export function __setSkillsManifest(manifest) {
|
|
115
99
|
pendingSkillsManifest = manifest;
|
|
100
|
+
discoveredSkills = null;
|
|
116
101
|
}
|
|
117
102
|
// Pure and `this`-free so it can run inside the `super(...)` call, before `this`
|
|
118
103
|
// exists — the capability must be present for the `initialize` response.
|
|
@@ -131,45 +116,37 @@ function withSkillsCapability(options, skybridgeOptions) {
|
|
|
131
116
|
},
|
|
132
117
|
};
|
|
133
118
|
}
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
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
|
+
*/
|
|
154
149
|
export class McpServer extends McpServerBaseOmitted {
|
|
155
|
-
/**
|
|
156
|
-
* The underlying Express app. Use this to extend the HTTP server with
|
|
157
|
-
* custom routes, middleware, or settings — e.g.
|
|
158
|
-
* `server.express.get("/health", ...)`.
|
|
159
|
-
*
|
|
160
|
-
* `express.json()` is pre-applied — tune it via the constructor's third
|
|
161
|
-
* argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
|
|
162
|
-
* Register your handlers before `run()`;
|
|
163
|
-
* after `run()`, dev-mode middleware, the `/mcp` route, and the default
|
|
164
|
-
* error handler are appended in that order.
|
|
165
|
-
*
|
|
166
|
-
* Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
|
|
167
|
-
* locally and on self-hosted deployments.
|
|
168
|
-
*/
|
|
169
|
-
express;
|
|
170
|
-
customErrorMiddleware = [];
|
|
171
|
-
mcpMiddlewareEntries = [];
|
|
172
|
-
mcpMiddlewareApplied = false;
|
|
173
150
|
claimedViews = new Map();
|
|
174
151
|
viewMetaBuilders = new Map();
|
|
175
152
|
/**
|
|
@@ -180,82 +157,65 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
180
157
|
*/
|
|
181
158
|
viewUriByPath = new Map();
|
|
182
159
|
viteManifest = null;
|
|
183
|
-
serverInfo;
|
|
184
|
-
serverOptions;
|
|
185
160
|
oauthEnabled = false;
|
|
186
161
|
resolveResourceMetadataUrl;
|
|
187
|
-
|
|
162
|
+
toolSecuritySchemes = new Map();
|
|
163
|
+
userMiddlewareEntries = [];
|
|
164
|
+
eventRegistry;
|
|
188
165
|
constructor(serverInfo, options, skybridgeOptions) {
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
this.serverInfo = serverInfo;
|
|
192
|
-
this.serverOptions = mergedOptions;
|
|
193
|
-
this.express = express();
|
|
194
|
-
this.express.use(express.json(skybridgeOptions?.json));
|
|
195
|
-
if (skybridgeOptions?.oauth) {
|
|
196
|
-
this.oauthEnabled = true;
|
|
197
|
-
this.resolveResourceMetadataUrl = setupOAuth(this.express, skybridgeOptions.oauth, this.securitySchemesByTool);
|
|
198
|
-
}
|
|
166
|
+
super(serverInfo, withSkillsCapability(options, skybridgeOptions));
|
|
167
|
+
this.oauthEnabled = Boolean(skybridgeOptions?.oauth);
|
|
199
168
|
// Pick up the manifest if `dist/__entry.js` primed it before importing
|
|
200
|
-
// user code.
|
|
201
|
-
//
|
|
202
|
-
// Explicit `setViteManifest` calls still win because they happen after
|
|
203
|
-
// construction.
|
|
169
|
+
// user code. Explicit `setViteManifest` calls still win because they
|
|
170
|
+
// happen after construction.
|
|
204
171
|
if (pendingBuildManifest) {
|
|
205
172
|
this.setViteManifest(pendingBuildManifest);
|
|
206
|
-
pendingBuildManifest = null;
|
|
207
173
|
}
|
|
208
174
|
this.setupSkills(Boolean(skybridgeOptions?.skills));
|
|
209
175
|
}
|
|
176
|
+
/**
|
|
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
|
|
182
|
+
*/
|
|
183
|
+
get securitySchemesByTool() {
|
|
184
|
+
return this.toolSecuritySchemes;
|
|
185
|
+
}
|
|
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;
|
|
195
|
+
}
|
|
210
196
|
setupSkills(enabled) {
|
|
211
|
-
const manifest = pendingSkillsManifest;
|
|
212
|
-
pendingSkillsManifest = null;
|
|
213
197
|
if (!enabled) {
|
|
214
198
|
return;
|
|
215
199
|
}
|
|
216
|
-
|
|
217
|
-
if (
|
|
200
|
+
discoveredSkills ??= pendingSkillsManifest ?? discoverSkills(SKILLS_DIR);
|
|
201
|
+
if (discoveredSkills.length === 0 && !warnedOnMissingSkills) {
|
|
202
|
+
warnedOnMissingSkills = true;
|
|
218
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.`);
|
|
219
204
|
}
|
|
220
|
-
registerSkills(this,
|
|
221
|
-
}
|
|
222
|
-
use(pathOrHandler, ...handlers) {
|
|
223
|
-
// Branching is load-bearing: Express's `app.use` overloads can't be
|
|
224
|
-
// resolved against a `string | RequestHandler` union, so we narrow.
|
|
225
|
-
if (typeof pathOrHandler === "string") {
|
|
226
|
-
this.express.use(pathOrHandler, ...handlers);
|
|
227
|
-
}
|
|
228
|
-
else {
|
|
229
|
-
this.express.use(pathOrHandler, ...handlers);
|
|
230
|
-
}
|
|
231
|
-
return this;
|
|
232
|
-
}
|
|
233
|
-
useOnError(pathOrHandler, ...handlers) {
|
|
234
|
-
if (typeof pathOrHandler === "string") {
|
|
235
|
-
this.customErrorMiddleware.push({ path: pathOrHandler, handlers });
|
|
236
|
-
}
|
|
237
|
-
else {
|
|
238
|
-
this.customErrorMiddleware.push({
|
|
239
|
-
handlers: [pathOrHandler, ...handlers],
|
|
240
|
-
});
|
|
241
|
-
}
|
|
242
|
-
return this;
|
|
205
|
+
registerSkills(this, discoveredSkills);
|
|
243
206
|
}
|
|
244
207
|
mcpMiddleware(filterOrHandler,
|
|
245
208
|
// biome-ignore lint/suspicious/noExplicitAny: overloads narrow the handler type at call sites; implementation must accept all variants
|
|
246
209
|
maybeHandler) {
|
|
247
|
-
if (this.mcpMiddlewareApplied) {
|
|
248
|
-
throw new Error("Cannot register MCP middleware after run() or connect() has been called");
|
|
249
|
-
}
|
|
250
210
|
const handler = maybeHandler;
|
|
251
211
|
if (typeof filterOrHandler === "function") {
|
|
252
|
-
this.
|
|
212
|
+
this.userMiddlewareEntries.push({
|
|
253
213
|
filter: null,
|
|
254
214
|
handler: filterOrHandler,
|
|
255
215
|
});
|
|
256
216
|
}
|
|
257
217
|
else if (handler) {
|
|
258
|
-
this.
|
|
218
|
+
this.userMiddlewareEntries.push({
|
|
259
219
|
filter: filterOrHandler,
|
|
260
220
|
handler,
|
|
261
221
|
});
|
|
@@ -265,11 +225,15 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
265
225
|
}
|
|
266
226
|
return this;
|
|
267
227
|
}
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
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() {
|
|
273
237
|
// Surface view-resource _meta on `resources/list` (per ext-apps spec:
|
|
274
238
|
// hosts/checkers read CSP & domain at list time before fetching content).
|
|
275
239
|
const viewListMetaEntry = {
|
|
@@ -345,121 +309,12 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
345
309
|
return result;
|
|
346
310
|
},
|
|
347
311
|
};
|
|
348
|
-
|
|
349
|
-
const entries = [
|
|
350
|
-
...(monitoringEntry ? [monitoringEntry] : []),
|
|
312
|
+
return [
|
|
351
313
|
viewListMetaEntry,
|
|
352
314
|
viewReadResolveEntry,
|
|
353
315
|
toolsListSecuritySchemesEntry,
|
|
354
|
-
...this.
|
|
316
|
+
...this.userMiddlewareEntries,
|
|
355
317
|
];
|
|
356
|
-
const { requestHandlers, notificationHandlers } = getHandlerMaps(this.server);
|
|
357
|
-
const instrumentMap = (map, isNotification) => {
|
|
358
|
-
for (const [method, handler] of map) {
|
|
359
|
-
map.set(method, buildMiddlewareChain(method, isNotification, handler, entries));
|
|
360
|
-
}
|
|
361
|
-
const originalSet = map.set.bind(map);
|
|
362
|
-
map.set = (method, handler) => originalSet(method, buildMiddlewareChain(method, isNotification, handler, entries));
|
|
363
|
-
};
|
|
364
|
-
instrumentMap(requestHandlers, false);
|
|
365
|
-
instrumentMap(notificationHandlers, true);
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
369
|
-
* when you're embedding Skybridge in a host that already manages its own
|
|
370
|
-
* transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
|
|
371
|
-
* which sets the transport up for you. Locks in any middleware registered
|
|
372
|
-
* via {@link McpServer.mcpMiddleware} — further calls to that method will
|
|
373
|
-
* throw afterwards.
|
|
374
|
-
*/
|
|
375
|
-
async connect(transport) {
|
|
376
|
-
this.applyMcpMiddleware();
|
|
377
|
-
return McpServerBase.prototype.connect.call(this, transport);
|
|
378
|
-
}
|
|
379
|
-
/**
|
|
380
|
-
* Per-request stateless connect. The SDK's `Protocol` only allows one
|
|
381
|
-
* transport per instance, so we can't reuse this `McpServer` across
|
|
382
|
-
* concurrent requests. The SDK's idiomatic fix is a `() => McpServer`
|
|
383
|
-
* factory, but that would break Skybridge's singleton API — so instead
|
|
384
|
-
* we build a fresh underlying `Server` per request and share the main
|
|
385
|
-
* server's handler maps by reference. The cast is unavoidable: there's
|
|
386
|
-
* no public API to inject handler maps. `getHandlerMaps` validates the
|
|
387
|
-
* read side and fails fast on SDK field renames.
|
|
388
|
-
*/
|
|
389
|
-
async connectStatelessTransport(transport) {
|
|
390
|
-
this.applyMcpMiddleware();
|
|
391
|
-
const { requestHandlers, notificationHandlers } = getHandlerMaps(this.server);
|
|
392
|
-
const fresh = new SdkServer(this.serverInfo, this.serverOptions);
|
|
393
|
-
const target = fresh;
|
|
394
|
-
target._requestHandlers = requestHandlers;
|
|
395
|
-
target._notificationHandlers = notificationHandlers;
|
|
396
|
-
await fresh.connect(transport);
|
|
397
|
-
}
|
|
398
|
-
/**
|
|
399
|
-
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
400
|
-
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
401
|
-
* via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
|
|
402
|
-
* any MCP middleware registered via {@link McpServer.mcpMiddleware}.
|
|
403
|
-
*
|
|
404
|
-
* On Cloudflare Workers / workerd, returns an object exposing `fetch` so
|
|
405
|
-
* the runtime can bridge incoming requests to the Node HTTP server. On
|
|
406
|
-
* Vercel (`VERCEL === "1"`), returns the Express app directly so the
|
|
407
|
-
* serverless function entry can call it as a `(req, res)` handler. On
|
|
408
|
-
* Node, returns `undefined` once listening.
|
|
409
|
-
*/
|
|
410
|
-
async run() {
|
|
411
|
-
this.applyMcpMiddleware();
|
|
412
|
-
if (process.env.VERCEL === "1") {
|
|
413
|
-
// createApp only reads httpServer inside its dev-only branch
|
|
414
|
-
// (viewsDevServer); under VERCEL=1 + NODE_ENV=production it's a
|
|
415
|
-
// bare object passed to satisfy the required parameter.
|
|
416
|
-
const httpServer = http.createServer();
|
|
417
|
-
await createApp({
|
|
418
|
-
mcpServer: this,
|
|
419
|
-
httpServer,
|
|
420
|
-
errorMiddleware: this.customErrorMiddleware,
|
|
421
|
-
});
|
|
422
|
-
return this.express;
|
|
423
|
-
}
|
|
424
|
-
const httpServer = http.createServer();
|
|
425
|
-
await createApp({
|
|
426
|
-
mcpServer: this,
|
|
427
|
-
httpServer,
|
|
428
|
-
errorMiddleware: this.customErrorMiddleware,
|
|
429
|
-
});
|
|
430
|
-
httpServer.on("request", this.express);
|
|
431
|
-
const port = parseInt(process.env.__PORT ?? "3000", 10);
|
|
432
|
-
await new Promise((resolve, reject) => {
|
|
433
|
-
httpServer.on("error", (error) => {
|
|
434
|
-
console.error("Failed to start server:", error);
|
|
435
|
-
reject(error);
|
|
436
|
-
});
|
|
437
|
-
httpServer.listen(port, () => {
|
|
438
|
-
resolve();
|
|
439
|
-
});
|
|
440
|
-
});
|
|
441
|
-
// On workerd, bridge the Node http server to a Workers fetch handler.
|
|
442
|
-
// The specifier is held in a variable to sidestep tsc's module resolution
|
|
443
|
-
// (`cloudflare:node` only exists under wrangler/workerd).
|
|
444
|
-
if (typeof navigator !== "undefined" &&
|
|
445
|
-
navigator.userAgent === "Cloudflare-Workers") {
|
|
446
|
-
const cloudflareNode = "cloudflare:node";
|
|
447
|
-
const { httpServerHandler } = await import(cloudflareNode);
|
|
448
|
-
return httpServerHandler({ port });
|
|
449
|
-
}
|
|
450
|
-
const shutdown = () => {
|
|
451
|
-
// Drop both handlers so a second signal falls through to Node's default
|
|
452
|
-
// (force-quit on a second Ctrl+C while drain is hanging).
|
|
453
|
-
process.off("SIGTERM", shutdown);
|
|
454
|
-
process.off("SIGINT", shutdown);
|
|
455
|
-
httpServer.close(() => process.exit(0));
|
|
456
|
-
// Force exit if connections don't drain in time so the port is still
|
|
457
|
-
// released promptly (e.g. for nodemon restarts).
|
|
458
|
-
setTimeout(() => process.exit(0), 3000).unref();
|
|
459
|
-
};
|
|
460
|
-
process.on("SIGTERM", shutdown);
|
|
461
|
-
process.on("SIGINT", shutdown);
|
|
462
|
-
return undefined;
|
|
463
318
|
}
|
|
464
319
|
enforceOneToolPerView(component, toolName) {
|
|
465
320
|
const existingTool = this.claimedViews.get(component);
|
|
@@ -468,13 +323,9 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
468
323
|
}
|
|
469
324
|
this.claimedViews.set(component, toolName);
|
|
470
325
|
}
|
|
471
|
-
resolveViewRequestContext(
|
|
326
|
+
resolveViewRequestContext(ctx) {
|
|
472
327
|
const isProduction = process.env.NODE_ENV === "production";
|
|
473
|
-
const
|
|
474
|
-
const header = (key) => {
|
|
475
|
-
const val = headers[key];
|
|
476
|
-
return Array.isArray(val) ? val[0] : val;
|
|
477
|
-
};
|
|
328
|
+
const header = (key) => ctx?.http?.req?.headers.get(key) ?? undefined;
|
|
478
329
|
const isClaude = hostFromUserAgent(header("user-agent")) === "claude";
|
|
479
330
|
const serverUrl = resolveServerOrigin(header);
|
|
480
331
|
// Path prefix the proxy routed this request under (e.g. `foo.com/v1`). Read
|
|
@@ -490,7 +341,7 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
490
341
|
}
|
|
491
342
|
let contentMetaOverrides = {};
|
|
492
343
|
if (isClaude) {
|
|
493
|
-
const pathname =
|
|
344
|
+
const pathname = ctx?.http?.req ? new URL(ctx.http.req.url).pathname : "";
|
|
494
345
|
const rawUrl = header("x-alpic-forwarded-url") ?? `${serverUrl}${pathname}`;
|
|
495
346
|
// Strip a lone trailing slash so the hash matches the connector URL
|
|
496
347
|
// as registered with Claude (which has no trailing slash on bare origins).
|
|
@@ -504,52 +355,32 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
504
355
|
}
|
|
505
356
|
return { serverUrl, assetsBasePath, connectDomains, contentMetaOverrides };
|
|
506
357
|
}
|
|
507
|
-
registerViewResources(toolName, view, toolMeta) {
|
|
358
|
+
registerViewResources(toolName, view, toolMeta, openai) {
|
|
508
359
|
// Append a content-derived version param so hosts (e.g. ChatGPT) bust
|
|
509
360
|
// their cache when the bundle changes, but keep the URI stable across
|
|
510
361
|
// `tools/list` calls when the bundle hasn't changed.
|
|
511
362
|
const versionParam = this.computeViewVersionParam(view.component);
|
|
512
363
|
const viewResource = {
|
|
513
|
-
hostType: "mcp-app",
|
|
514
364
|
uri: `ui://views/ext-apps/${view.component}.html${versionParam}`,
|
|
515
365
|
mimeType: "text/html;profile=mcp-app",
|
|
516
366
|
buildContentMeta: ({ resourceDomains, connectDomains, domain, baseUriDomains }, overrides) => {
|
|
517
|
-
const
|
|
518
|
-
ui: {
|
|
519
|
-
csp: {
|
|
520
|
-
resourceDomains,
|
|
521
|
-
connectDomains,
|
|
522
|
-
baseUriDomains,
|
|
523
|
-
},
|
|
524
|
-
domain,
|
|
525
|
-
},
|
|
526
|
-
};
|
|
527
|
-
const fromView = {
|
|
367
|
+
const ui = {
|
|
528
368
|
ui: {
|
|
529
369
|
...(view.description && { description: view.description }),
|
|
530
370
|
...(view.prefersBorder !== undefined && {
|
|
531
371
|
prefersBorder: view.prefersBorder,
|
|
532
372
|
}),
|
|
533
|
-
|
|
373
|
+
domain: overrides.domain ?? view.domain ?? domain,
|
|
534
374
|
csp: {
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
...(view.csp?.connectDomains && {
|
|
539
|
-
connectDomains: view.csp.connectDomains,
|
|
540
|
-
}),
|
|
375
|
+
resourceDomains: unionOf(resourceDomains, view.csp?.resourceDomains),
|
|
376
|
+
connectDomains: unionOf(connectDomains, view.csp?.connectDomains),
|
|
377
|
+
baseUriDomains: unionOf(baseUriDomains, view.csp?.baseUriDomains),
|
|
541
378
|
...(view.csp?.frameDomains && {
|
|
542
379
|
frameDomains: view.csp.frameDomains,
|
|
543
380
|
}),
|
|
544
|
-
...(view.csp?.baseUriDomains && {
|
|
545
|
-
baseUriDomains: view.csp.baseUriDomains,
|
|
546
|
-
}),
|
|
547
381
|
},
|
|
548
382
|
},
|
|
549
383
|
};
|
|
550
|
-
const ui = mergeWithUnion(mergeWithUnion(defaults, fromView), {
|
|
551
|
-
ui: overrides,
|
|
552
|
-
});
|
|
553
384
|
const base = {
|
|
554
385
|
...ui,
|
|
555
386
|
...(view.description && {
|
|
@@ -559,10 +390,12 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
559
390
|
"openai/widgetCSP": { redirect_domains: view.csp.redirectDomains },
|
|
560
391
|
}),
|
|
561
392
|
};
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
393
|
+
const meta = { ...base, ...view._meta };
|
|
394
|
+
mergeOpenAIUi(meta, {
|
|
395
|
+
availableDisplayModes: openai?.availableDisplayModes,
|
|
396
|
+
preferredDisplayMode: openai?.preferredDisplayMode,
|
|
397
|
+
});
|
|
398
|
+
return meta;
|
|
566
399
|
},
|
|
567
400
|
};
|
|
568
401
|
this.registerViewResource({ name: toolName, viewResource, view });
|
|
@@ -575,7 +408,7 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
575
408
|
toolMeta.ui = { ...toolMeta.ui, resourceUri: viewResource.uri };
|
|
576
409
|
}
|
|
577
410
|
registerViewResource({ name, viewResource, view, }) {
|
|
578
|
-
const {
|
|
411
|
+
const { uri: viewUri, mimeType, buildContentMeta } = viewResource;
|
|
579
412
|
const buildMeta = (extra) => {
|
|
580
413
|
const { serverUrl, connectDomains, contentMetaOverrides } = this.resolveViewRequestContext(extra);
|
|
581
414
|
return buildContentMeta({
|
|
@@ -597,13 +430,11 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
597
430
|
const viewBase = `${serverUrl}${assetsBasePath}`;
|
|
598
431
|
const html = isProduction
|
|
599
432
|
? templateHelper.renderProduction({
|
|
600
|
-
hostType,
|
|
601
433
|
serverUrl: viewBase,
|
|
602
434
|
viewFile: this.lookupViewFile(view.component),
|
|
603
435
|
styleFile: this.lookupDistFile("style.css") ?? "",
|
|
604
436
|
})
|
|
605
437
|
: templateHelper.renderDevelopment({
|
|
606
|
-
hostType,
|
|
607
438
|
serverUrl: viewBase,
|
|
608
439
|
viewName: view.component,
|
|
609
440
|
});
|
|
@@ -621,15 +452,10 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
621
452
|
}
|
|
622
453
|
decorateToolHandler(cb, { attachViewUUID, securitySchemes, toolName, }) {
|
|
623
454
|
return async (args, extra) => {
|
|
624
|
-
const toolExtra = extra ?? args;
|
|
625
455
|
if (this.oauthEnabled) {
|
|
626
|
-
const failure = evaluateSecuritySchemes(securitySchemes,
|
|
456
|
+
const failure = evaluateSecuritySchemes(securitySchemes, extra.http?.authInfo);
|
|
627
457
|
if (failure) {
|
|
628
|
-
const
|
|
629
|
-
const header = (key) => {
|
|
630
|
-
const value = headers[key];
|
|
631
|
-
return Array.isArray(value) ? value[0] : value;
|
|
632
|
-
};
|
|
458
|
+
const header = (key) => extra.http?.req?.headers.get(key) ?? undefined;
|
|
633
459
|
return inBandChallengeResult(failure, this.resolveResourceMetadataUrl?.(header));
|
|
634
460
|
}
|
|
635
461
|
}
|
|
@@ -638,9 +464,12 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
638
464
|
result = await cb(args, extra);
|
|
639
465
|
}
|
|
640
466
|
catch (error) {
|
|
641
|
-
captureToolError(
|
|
467
|
+
captureToolError(extra, error);
|
|
642
468
|
throw error;
|
|
643
469
|
}
|
|
470
|
+
if (isInputRequiredResult(result)) {
|
|
471
|
+
return result;
|
|
472
|
+
}
|
|
644
473
|
warnOnLargeToolOutput(result, toolName);
|
|
645
474
|
return {
|
|
646
475
|
...result,
|
|
@@ -701,12 +530,219 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
701
530
|
if (this.viteManifest) {
|
|
702
531
|
return this.viteManifest;
|
|
703
532
|
}
|
|
704
|
-
|
|
533
|
+
cachedDiskManifest ??= JSON.parse(readFileSync(path.join(process.cwd(), "dist", "assets", ".vite", "manifest.json"), "utf-8"));
|
|
534
|
+
return cachedDiskManifest ?? {};
|
|
705
535
|
}
|
|
706
|
-
|
|
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;
|
|
740
|
+
}
|
|
741
|
+
registerTool(rawConfig, rawCb) {
|
|
707
742
|
const baseFn = McpServerBase.prototype.registerTool;
|
|
708
|
-
const
|
|
709
|
-
const
|
|
743
|
+
const config = rawConfig;
|
|
744
|
+
const cb = rawCb;
|
|
745
|
+
const { name, view, auth, securitySchemes: rawSecuritySchemes, openai, _meta: userToolMeta, ...toolFields } = config;
|
|
710
746
|
const authNeedsProvider = auth !== undefined &&
|
|
711
747
|
(!auth.allowsAnonymous || Boolean(auth.scopes?.length));
|
|
712
748
|
if (rawSecuritySchemes === undefined &&
|
|
@@ -717,25 +753,46 @@ export class McpServer extends McpServerBaseOmitted {
|
|
|
717
753
|
const securitySchemes = rawSecuritySchemes ??
|
|
718
754
|
(auth && this.oauthEnabled ? authToSecuritySchemes(auth) : undefined);
|
|
719
755
|
const toolMeta = { ...userToolMeta };
|
|
720
|
-
this.
|
|
756
|
+
this.toolSecuritySchemes.set(name, securitySchemes);
|
|
721
757
|
if (securitySchemes) {
|
|
722
758
|
// SEP-1488 puts `securitySchemes` at the top level of the tool
|
|
723
759
|
// descriptor, but the SDK's `registerTool` drops unknown top-level
|
|
724
760
|
// fields, so the canonical spot isn't reachable without intercepting
|
|
725
761
|
// `tools/list`. Use the `_meta` back-compat mirror documented in the
|
|
726
|
-
//
|
|
762
|
+
// ChatGPT plugin reference until SEP-1488 lands in the spec.
|
|
727
763
|
toolMeta.securitySchemes = securitySchemes;
|
|
728
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
|
+
}
|
|
729
784
|
if (view) {
|
|
730
785
|
this.enforceOneToolPerView(view.component, name);
|
|
731
|
-
this.registerViewResources(name, view, toolMeta);
|
|
786
|
+
this.registerViewResources(name, view, toolMeta, openai);
|
|
732
787
|
}
|
|
733
788
|
const wrappedCb = this.decorateToolHandler(cb, {
|
|
734
789
|
attachViewUUID: Boolean(view),
|
|
735
790
|
securitySchemes,
|
|
736
791
|
toolName: name,
|
|
737
792
|
});
|
|
738
|
-
baseFn.call(this, name, { ...toolFields, _meta: toolMeta },
|
|
793
|
+
baseFn.call(this, name, { ...toolFields, _meta: toolMeta }, toolFields.inputSchema === undefined
|
|
794
|
+
? (extra) => wrappedCb({}, extra)
|
|
795
|
+
: wrappedCb);
|
|
739
796
|
return this;
|
|
740
797
|
}
|
|
741
798
|
}
|