skybridge 0.0.0-dev.81dc563 → 0.0.0-dev.81fd90a
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 +3 -0
- package/dist/cli/build-helpers.d.ts +6 -2
- package/dist/cli/build-helpers.js +37 -12
- package/dist/cli/build-helpers.js.map +1 -1
- package/dist/cli/build-helpers.test.js +71 -3
- package/dist/cli/build-helpers.test.js.map +1 -1
- package/dist/cli/build-steps.d.ts +2 -0
- package/dist/cli/build-steps.js +73 -0
- package/dist/cli/build-steps.js.map +1 -0
- package/dist/cli/build-steps.test.js +52 -0
- package/dist/cli/build-steps.test.js.map +1 -0
- package/dist/cli/header.d.ts +1 -1
- package/dist/cli/resolve-skybridge-config.d.ts +5 -0
- package/dist/cli/{resolve-views-dir.js → resolve-skybridge-config.js} +4 -3
- package/dist/cli/resolve-skybridge-config.js.map +1 -0
- package/dist/cli/run-plain.d.ts +18 -0
- package/dist/cli/run-plain.js +89 -0
- package/dist/cli/run-plain.js.map +1 -0
- package/dist/cli/use-execute-steps.d.ts +1 -1
- package/dist/cli/use-nodemon.d.ts +14 -0
- package/dist/cli/use-nodemon.js +71 -60
- package/dist/cli/use-nodemon.js.map +1 -1
- package/dist/cli/use-typescript-check.d.ts +8 -2
- package/dist/cli/use-typescript-check.js +70 -67
- package/dist/cli/use-typescript-check.js.map +1 -1
- package/dist/commands/build.d.ts +0 -2
- package/dist/commands/build.js +2 -61
- package/dist/commands/build.js.map +1 -1
- package/dist/commands/dev.d.ts +1 -0
- package/dist/commands/dev.js +34 -2
- package/dist/commands/dev.js.map +1 -1
- package/dist/context-warnings.d.ts +5 -0
- package/dist/context-warnings.js +31 -0
- package/dist/context-warnings.js.map +1 -0
- package/dist/context-warnings.test.d.ts +1 -0
- package/dist/context-warnings.test.js +28 -0
- package/dist/context-warnings.test.js.map +1 -0
- package/dist/server/auth/discovery.d.ts +33 -0
- package/dist/server/auth/discovery.js +56 -0
- package/dist/server/auth/discovery.js.map +1 -0
- package/dist/server/auth/discovery.test.d.ts +1 -0
- package/dist/server/auth/discovery.test.js +93 -0
- package/dist/server/auth/discovery.test.js.map +1 -0
- package/dist/server/auth/index.d.ts +17 -7
- package/dist/server/auth/index.js.map +1 -1
- package/dist/server/auth/providers/auth0.d.ts +40 -0
- package/dist/server/auth/providers/auth0.js +31 -0
- package/dist/server/auth/providers/auth0.js.map +1 -0
- package/dist/server/auth/providers/auth0.test.d.ts +1 -0
- package/dist/server/auth/providers/auth0.test.js +50 -0
- package/dist/server/auth/providers/auth0.test.js.map +1 -0
- package/dist/server/auth/providers/authplane.d.ts +49 -0
- package/dist/server/auth/providers/authplane.js +57 -0
- package/dist/server/auth/providers/authplane.js.map +1 -0
- package/dist/server/auth/providers/authplane.test.d.ts +1 -0
- package/dist/server/auth/providers/authplane.test.js +140 -0
- package/dist/server/auth/providers/authplane.test.js.map +1 -0
- package/dist/server/auth/providers/clerk.d.ts +51 -0
- package/dist/server/auth/providers/clerk.js +19 -0
- package/dist/server/auth/providers/clerk.js.map +1 -0
- package/dist/server/auth/providers/clerk.test.d.ts +1 -0
- package/dist/server/auth/providers/clerk.test.js +30 -0
- package/dist/server/auth/providers/clerk.test.js.map +1 -0
- package/dist/server/auth/providers/custom.d.ts +40 -0
- package/dist/server/auth/providers/custom.js +56 -0
- package/dist/server/auth/providers/custom.js.map +1 -0
- package/dist/server/auth/providers/custom.test.d.ts +1 -0
- package/dist/server/auth/providers/custom.test.js +158 -0
- package/dist/server/auth/providers/custom.test.js.map +1 -0
- package/dist/server/auth/providers/descope.d.ts +44 -0
- package/dist/server/auth/providers/descope.js +44 -0
- package/dist/server/auth/providers/descope.js.map +1 -0
- package/dist/server/auth/providers/descope.test.d.ts +1 -0
- package/dist/server/auth/providers/descope.test.js +62 -0
- package/dist/server/auth/providers/descope.test.js.map +1 -0
- package/dist/server/auth/providers/shared.d.ts +2 -0
- package/dist/server/auth/providers/shared.js +6 -0
- package/dist/server/auth/providers/shared.js.map +1 -0
- package/dist/server/auth/providers/shared.test.d.ts +1 -0
- package/dist/server/auth/providers/shared.test.js +10 -0
- package/dist/server/auth/providers/shared.test.js.map +1 -0
- package/dist/server/auth/providers/stytch.d.ts +25 -0
- package/dist/server/auth/providers/stytch.js +16 -0
- package/dist/server/auth/providers/stytch.js.map +1 -0
- package/dist/server/auth/providers/verify-spy.d.ts +12 -0
- package/dist/server/auth/providers/verify-spy.js +21 -0
- package/dist/server/auth/providers/verify-spy.js.map +1 -0
- package/dist/server/auth/providers/workos.d.ts +33 -0
- package/dist/server/auth/providers/workos.js +15 -0
- package/dist/server/auth/providers/workos.js.map +1 -0
- package/dist/server/auth/security-schemes.d.ts +23 -0
- package/dist/server/auth/security-schemes.js +64 -0
- package/dist/server/auth/security-schemes.js.map +1 -0
- package/dist/server/auth/security-schemes.test.d.ts +1 -0
- package/dist/server/auth/security-schemes.test.js +99 -0
- package/dist/server/auth/security-schemes.test.js.map +1 -0
- package/dist/server/auth/setup.d.ts +3 -1
- package/dist/server/auth/setup.js +64 -25
- package/dist/server/auth/setup.js.map +1 -1
- package/dist/server/auth/setup.test.js +330 -19
- package/dist/server/auth/setup.test.js.map +1 -1
- package/dist/server/auth/verify.d.ts +40 -5
- package/dist/server/auth/verify.js +29 -4
- package/dist/server/auth/verify.js.map +1 -1
- package/dist/server/auth/verify.test.js +62 -0
- package/dist/server/auth/verify.test.js.map +1 -1
- package/dist/server/auth-extra.test-d.d.ts +1 -0
- package/dist/server/auth-extra.test-d.js +71 -0
- package/dist/server/auth-extra.test-d.js.map +1 -0
- package/dist/server/auth.d.ts +42 -5
- package/dist/server/auth.js +3 -4
- package/dist/server/auth.js.map +1 -1
- package/dist/server/content-helpers.d.ts +1 -1
- package/dist/server/content-helpers.js.map +1 -1
- package/dist/server/express.js +9 -28
- package/dist/server/express.js.map +1 -1
- package/dist/server/express.test.js +42 -7
- package/dist/server/express.test.js.map +1 -1
- package/dist/server/host.d.ts +2 -0
- package/dist/server/host.js +11 -0
- package/dist/server/host.js.map +1 -0
- package/dist/server/host.test.d.ts +1 -0
- package/dist/server/host.test.js +13 -0
- package/dist/server/host.test.js.map +1 -0
- package/dist/server/index.d.ts +14 -3
- package/dist/server/index.js +12 -2
- package/dist/server/index.js.map +1 -1
- package/dist/server/mcp-errors.test.d.ts +1 -0
- package/dist/server/mcp-errors.test.js +37 -0
- package/dist/server/mcp-errors.test.js.map +1 -0
- package/dist/server/middleware.d.ts +35 -10
- package/dist/server/middleware.js +33 -0
- package/dist/server/middleware.js.map +1 -1
- package/dist/server/middleware.test-d.js +1 -1
- package/dist/server/middleware.test-d.js.map +1 -1
- package/dist/server/middleware.test.js +38 -3
- package/dist/server/middleware.test.js.map +1 -1
- package/dist/server/register-tool.test.d.ts +1 -0
- package/dist/server/register-tool.test.js +25 -0
- package/dist/server/register-tool.test.js.map +1 -0
- package/dist/server/requestOrigin.d.ts +3 -2
- package/dist/server/requestOrigin.js +8 -8
- package/dist/server/requestOrigin.js.map +1 -1
- package/dist/server/server.d.ts +138 -50
- package/dist/server/server.js +280 -147
- package/dist/server/server.js.map +1 -1
- package/dist/server/skills-integration.test.d.ts +1 -0
- package/dist/server/skills-integration.test.js +79 -0
- package/dist/server/skills-integration.test.js.map +1 -0
- package/dist/server/skills.d.ts +27 -0
- package/dist/server/skills.js +188 -0
- package/dist/server/skills.js.map +1 -0
- package/dist/server/skills.test.d.ts +1 -0
- package/dist/server/skills.test.js +243 -0
- package/dist/server/skills.test.js.map +1 -0
- package/dist/server/tool-extra.test.d.ts +1 -0
- package/dist/server/tool-extra.test.js +72 -0
- package/dist/server/tool-extra.test.js.map +1 -0
- package/dist/server/view-name.test-d.d.ts +1 -0
- package/dist/server/view-name.test-d.js +8 -0
- package/dist/server/view-name.test-d.js.map +1 -0
- package/dist/server/view-resource-resolution.test.js +93 -12
- package/dist/server/view-resource-resolution.test.js.map +1 -1
- package/dist/server/viewsDevServer.js +4 -1
- package/dist/server/viewsDevServer.js.map +1 -1
- package/dist/standard-schema.d.ts +3 -0
- package/dist/standard-schema.js +2 -0
- package/dist/standard-schema.js.map +1 -0
- package/dist/test/utils.d.ts +5 -8
- package/dist/test/utils.js +8 -4
- package/dist/test/utils.js.map +1 -1
- package/dist/test/view.test.js +82 -114
- package/dist/test/view.test.js.map +1 -1
- package/dist/web/bridges/adaptor.d.ts +51 -0
- package/dist/web/bridges/adaptor.js +327 -0
- package/dist/web/bridges/adaptor.js.map +1 -0
- package/dist/web/bridges/adaptor.test.d.ts +1 -0
- package/dist/web/bridges/adaptor.test.js +225 -0
- package/dist/web/bridges/adaptor.test.js.map +1 -0
- package/dist/web/bridges/apps-sdk/bridge.d.ts +6 -2
- package/dist/web/bridges/apps-sdk/bridge.js +15 -4
- package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
- package/dist/web/bridges/apps-sdk/index.d.ts +0 -1
- package/dist/web/bridges/apps-sdk/index.js +0 -1
- package/dist/web/bridges/apps-sdk/index.js.map +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
- package/dist/web/bridges/get-adaptor.d.ts +4 -4
- package/dist/web/bridges/get-adaptor.js +6 -11
- package/dist/web/bridges/get-adaptor.js.map +1 -1
- package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
- package/dist/web/bridges/get-adaptor.test.js +32 -0
- package/dist/web/bridges/get-adaptor.test.js.map +1 -0
- package/dist/web/bridges/mcp-app/bridge.d.ts +13 -2
- package/dist/web/bridges/mcp-app/bridge.js +51 -7
- package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
- package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
- package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
- package/dist/web/bridges/mcp-app/index.d.ts +0 -1
- package/dist/web/bridges/mcp-app/index.js +0 -1
- package/dist/web/bridges/mcp-app/index.js.map +1 -1
- package/dist/web/bridges/mcp-app/types.d.ts +2 -0
- package/dist/web/bridges/mcp-app/types.js.map +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +1 -1
- 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/view-tools.test.js +5 -6
- package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -1
- package/dist/web/bridges/types.d.ts +27 -9
- package/dist/web/bridges/types.js +14 -1
- package/dist/web/bridges/types.js.map +1 -1
- package/dist/web/bridges/types.test.d.ts +1 -0
- package/dist/web/bridges/types.test.js +19 -0
- package/dist/web/bridges/types.test.js.map +1 -0
- package/dist/web/components/modal-provider.d.ts +1 -1
- package/dist/web/components/modal-provider.js +4 -3
- package/dist/web/components/modal-provider.js.map +1 -1
- package/dist/web/create-store.test.js +9 -6
- package/dist/web/create-store.test.js.map +1 -1
- package/dist/web/data-llm.d.ts +1 -1
- package/dist/web/data-llm.test.js +19 -6
- package/dist/web/data-llm.test.js.map +1 -1
- package/dist/web/hooks/index.d.ts +2 -1
- package/dist/web/hooks/index.js +2 -1
- package/dist/web/hooks/index.js.map +1 -1
- package/dist/web/hooks/test/utils.d.ts +2 -1
- package/dist/web/hooks/test/utils.js +1 -1
- package/dist/web/hooks/test/utils.js.map +1 -1
- package/dist/web/hooks/use-call-tool.test.js +39 -25
- package/dist/web/hooks/use-call-tool.test.js.map +1 -1
- 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 +57 -21
- 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 +16 -8
- package/dist/web/hooks/use-download.test.js.map +1 -1
- package/dist/web/hooks/use-files.test.js +11 -3
- package/dist/web/hooks/use-files.test.js.map +1 -1
- package/dist/web/hooks/use-host.d.ts +22 -0
- package/dist/web/hooks/use-host.js +30 -0
- package/dist/web/hooks/use-host.js.map +1 -0
- package/dist/web/hooks/use-host.test.d.ts +1 -0
- package/dist/web/hooks/use-host.test.js +59 -0
- package/dist/web/hooks/use-host.test.js.map +1 -0
- package/dist/web/hooks/use-open-external.test.js +14 -4
- package/dist/web/hooks/use-open-external.test.js.map +1 -1
- package/dist/web/hooks/use-register-view-tool.d.ts +2 -3
- package/dist/web/hooks/use-register-view-tool.js.map +1 -1
- package/dist/web/hooks/use-request-close.test.js +35 -40
- package/dist/web/hooks/use-request-close.test.js.map +1 -1
- package/dist/web/hooks/use-request-modal.test.js +11 -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 +35 -53
- package/dist/web/hooks/use-request-size.test.js.map +1 -1
- package/dist/web/hooks/use-set-open-in-app-url.test.js +29 -9
- 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 +37 -32
- 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 +84 -36
- package/dist/web/hooks/use-user.test.js.map +1 -1
- package/dist/web/hooks/use-view-state.js +19 -9
- package/dist/web/hooks/use-view-state.js.map +1 -1
- package/dist/web/hooks/use-view-state.test.js +38 -3
- 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-viewport.test.js +109 -0
- package/dist/web/hooks/use-viewport.test.js.map +1 -0
- package/dist/web/index.d.ts +1 -0
- package/dist/web/index.js.map +1 -1
- package/dist/web/mount-view.d.ts +3 -2
- package/dist/web/mount-view.js +3 -2
- package/dist/web/mount-view.js.map +1 -1
- package/dist/web/plugin/plugin-build.test.d.ts +1 -0
- package/dist/web/plugin/plugin-build.test.js +54 -0
- package/dist/web/plugin/plugin-build.test.js.map +1 -0
- package/dist/web/plugin/plugin.d.ts +6 -0
- package/dist/web/plugin/plugin.js +18 -7
- package/dist/web/plugin/plugin.js.map +1 -1
- package/dist/web/plugin/plugin.test.d.ts +1 -0
- package/dist/web/plugin/plugin.test.js +61 -0
- package/dist/web/plugin/plugin.test.js.map +1 -0
- package/package.json +28 -23
- package/dist/cli/resolve-views-dir.d.ts +0 -1
- package/dist/cli/resolve-views-dir.js.map +0 -1
- package/dist/web/bridges/apps-sdk/adaptor.d.ts +0 -29
- package/dist/web/bridges/apps-sdk/adaptor.js +0 -117
- package/dist/web/bridges/apps-sdk/adaptor.js.map +0 -1
- package/dist/web/bridges/mcp-app/adaptor.d.ts +0 -53
- package/dist/web/bridges/mcp-app/adaptor.js +0 -283
- package/dist/web/bridges/mcp-app/adaptor.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 +0 -96
- package/dist/web/hooks/use-layout.test.js.map +0 -1
- /package/dist/{web/hooks/use-layout.test.d.ts → cli/build-steps.test.d.ts} +0 -0
package/dist/server/server.d.ts
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
|
|
2
|
-
import { type ServerOptions } from "@modelcontextprotocol/
|
|
3
|
-
import { McpServer as McpServerBase } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
4
|
-
import type { AnySchema, SchemaOutput, ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
|
|
5
|
-
import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
|
|
6
|
-
import type { ContentBlock, Implementation, RequestMeta, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
|
|
2
|
+
import { type CacheHint, type ContentBlock, type Icon, type Implementation, McpServer as McpServerBase, type PromptCallback, type ReadResourceCallback, type ReadResourceTemplateCallback, type RegisteredPrompt, type RegisteredResource, type RegisteredResourceTemplate, type RequestMeta, type ResourceMetadata, type ResourceTemplate, type Server as SdkServer, type ServerOptions, type ServerResult, type StandardSchemaV1, type StandardSchemaWithJSON, type ToolAnnotations } from "@modelcontextprotocol/server";
|
|
7
3
|
import express, { type ErrorRequestHandler, type Express, type RequestHandler } from "express";
|
|
4
|
+
import type { InferSchemaOutput, RawInputShape } from "../standard-schema.js";
|
|
8
5
|
import type { OAuthConfig } from "./auth/index.js";
|
|
6
|
+
import type { ExtraClaims } from "./auth.js";
|
|
9
7
|
import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
|
|
8
|
+
import { type SkillsManifest } from "./skills.js";
|
|
10
9
|
/**
|
|
11
10
|
* Type marker for a registered tool — carries its input, output, and response
|
|
12
11
|
* metadata shapes so views can infer types from `typeof server`.
|
|
@@ -19,8 +18,12 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
|
|
|
19
18
|
output: TOutput;
|
|
20
19
|
responseMetadata: TResponseMetadata;
|
|
21
20
|
};
|
|
22
|
-
/**
|
|
23
|
-
|
|
21
|
+
/**
|
|
22
|
+
* The runtime a served view page declares on `window.skybridge`. Every view
|
|
23
|
+
* emits a single ext-apps resource, so this is always `"mcp-app"`; the Apps
|
|
24
|
+
* SDK runtime is detected at load time via `window.openai` instead.
|
|
25
|
+
*/
|
|
26
|
+
export type ViewHostType = "mcp-app";
|
|
24
27
|
/**
|
|
25
28
|
* Content Security Policy origins attached to a view's resource. Each list is
|
|
26
29
|
* passed through to the host's CSP for the view iframe; omit a field to inherit
|
|
@@ -45,8 +48,16 @@ export interface ViewCsp {
|
|
|
45
48
|
*/
|
|
46
49
|
export interface ViewNameRegistry {
|
|
47
50
|
}
|
|
51
|
+
/**
|
|
52
|
+
* Resolve view component names from a registry: the union of its keys, or
|
|
53
|
+
* `string` when the registry is empty. The empty case happens before
|
|
54
|
+
* `.skybridge/views.d.ts` is generated; falling back to `string` keeps valid
|
|
55
|
+
* view names from erroring on a fresh checkout, and narrowing kicks in once
|
|
56
|
+
* the generated file augments the registry.
|
|
57
|
+
*/
|
|
58
|
+
export type ViewNameFor<Registry> = [keyof Registry & string] extends [never] ? string : keyof Registry & string;
|
|
48
59
|
/** Union of valid view component names. Narrowed by {@link ViewNameRegistry}. */
|
|
49
|
-
export type ViewName =
|
|
60
|
+
export type ViewName = ViewNameFor<ViewNameRegistry>;
|
|
50
61
|
/**
|
|
51
62
|
* Pass under `view` in a tool's `registerTool` config to render the tool's
|
|
52
63
|
* result through a Skybridge view instead of a plain text response.
|
|
@@ -56,11 +67,9 @@ export interface ViewConfig {
|
|
|
56
67
|
component: ViewName;
|
|
57
68
|
/** Human-readable label the host may show alongside the view. */
|
|
58
69
|
description?: string;
|
|
59
|
-
/**
|
|
60
|
-
hosts?: ViewHostType[];
|
|
61
|
-
/** Apps SDK only: request a visible border around the widget. */
|
|
70
|
+
/** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
|
|
62
71
|
prefersBorder?: boolean;
|
|
63
|
-
/**
|
|
72
|
+
/** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
|
|
64
73
|
domain?: string;
|
|
65
74
|
/** Per-view CSP overrides — see {@link ViewCsp}. */
|
|
66
75
|
csp?: ViewCsp;
|
|
@@ -73,17 +82,42 @@ export type SecurityScheme = {
|
|
|
73
82
|
type: "oauth2";
|
|
74
83
|
scopes?: string[];
|
|
75
84
|
};
|
|
85
|
+
/**
|
|
86
|
+
* Declarative per-tool auth. Enforced when the server has an `oauth` provider:
|
|
87
|
+
* anonymous or under-scoped calls are rejected before the handler runs. Omit
|
|
88
|
+
* `auth` entirely for the secure default (sign-in required, no specific scope).
|
|
89
|
+
*/
|
|
90
|
+
export type ToolAuth = {
|
|
91
|
+
/**
|
|
92
|
+
* When `true`, the tool is callable signed out; the token is still used when
|
|
93
|
+
* one is present. Omit (or `false`) to require sign-in.
|
|
94
|
+
*/
|
|
95
|
+
allowsAnonymous?: boolean;
|
|
96
|
+
/** OAuth scopes the caller's token must carry to invoke the tool. */
|
|
97
|
+
scopes?: string[];
|
|
98
|
+
};
|
|
76
99
|
/**
|
|
77
100
|
* Options forwarded to the built-in `express.json()` body parser. Derived
|
|
78
101
|
* from Express's own types so the public API doesn't depend on `body-parser`.
|
|
79
102
|
*/
|
|
80
103
|
export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
|
|
81
|
-
/**
|
|
82
|
-
|
|
104
|
+
/**
|
|
105
|
+
* Skybridge-specific server options, passed as the third `McpServer` constructor
|
|
106
|
+
* argument.
|
|
107
|
+
*
|
|
108
|
+
* @typeParam TAuthExtra - Claims the `oauth` verifier populates. Inferred from
|
|
109
|
+
* the config a provider returns, and carried on to tool handlers.
|
|
110
|
+
*/
|
|
111
|
+
export interface SkybridgeServerOptions<TAuthExtra extends ExtraClaims = ExtraClaims> {
|
|
83
112
|
/** Options for the built-in `express.json()` middleware, e.g. `{ limit: "10mb" }`. */
|
|
84
113
|
json?: JsonOptions;
|
|
85
114
|
/** Resource-server OAuth config. When set, mounts well-known metadata and bearer auth on `/mcp`. */
|
|
86
|
-
oauth?: OAuthConfig
|
|
115
|
+
oauth?: OAuthConfig<TAuthExtra>;
|
|
116
|
+
/**
|
|
117
|
+
* @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
|
|
118
|
+
* API may change.
|
|
119
|
+
*/
|
|
120
|
+
skills?: boolean;
|
|
87
121
|
}
|
|
88
122
|
/**
|
|
89
123
|
* Well-known keys recognized by host runtimes when set on a tool's `_meta`.
|
|
@@ -102,7 +136,6 @@ export interface KnownToolMeta {
|
|
|
102
136
|
"openai/fileParams"?: string[];
|
|
103
137
|
/** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
|
|
104
138
|
ui?: Pick<McpUiToolMeta, "visibility">;
|
|
105
|
-
securitySchemes?: SecurityScheme[];
|
|
106
139
|
}
|
|
107
140
|
/** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
|
|
108
141
|
export type ToolMeta = KnownToolMeta & Record<string, unknown>;
|
|
@@ -128,10 +161,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
|
|
|
128
161
|
type Simplify<T> = {
|
|
129
162
|
[K in keyof T]: T[K];
|
|
130
163
|
};
|
|
131
|
-
type ShapeOutput<Shape extends
|
|
132
|
-
[K in keyof Shape as undefined extends
|
|
164
|
+
type ShapeOutput<Shape extends RawInputShape> = Simplify<{
|
|
165
|
+
[K in keyof Shape as undefined extends InferSchemaOutput<Shape[K]> ? never : K]: InferSchemaOutput<Shape[K]>;
|
|
133
166
|
} & {
|
|
134
|
-
[K in keyof Shape as undefined extends
|
|
167
|
+
[K in keyof Shape as undefined extends InferSchemaOutput<Shape[K]> ? K : never]?: InferSchemaOutput<Shape[K]>;
|
|
135
168
|
}>;
|
|
136
169
|
type ExtractStructuredContent<T> = T extends {
|
|
137
170
|
structuredContent: infer SC;
|
|
@@ -143,17 +176,28 @@ type ExtractMeta<T> = [Extract<T, {
|
|
|
143
176
|
}> extends {
|
|
144
177
|
_meta: infer M;
|
|
145
178
|
} ? Simplify<M> : unknown;
|
|
146
|
-
type AddTool<TTools, TName extends string, TInput extends
|
|
179
|
+
type AddTool<TTools, TName extends string, TInput extends RawInputShape, TOutput, TResponseMetadata = unknown, TAuthExtra extends ExtraClaims = ExtraClaims> = McpServer<TTools & {
|
|
147
180
|
[K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
|
|
148
|
-
}>;
|
|
149
|
-
interface
|
|
181
|
+
}, TAuthExtra>;
|
|
182
|
+
interface ToolConfigBase<TInput extends RawInputShape | StandardSchemaV1> {
|
|
150
183
|
name: string;
|
|
151
184
|
title?: string;
|
|
152
185
|
description?: string;
|
|
153
186
|
inputSchema?: TInput;
|
|
154
|
-
outputSchema?:
|
|
187
|
+
outputSchema?: RawInputShape | StandardSchemaV1;
|
|
155
188
|
annotations?: ToolAnnotations;
|
|
156
189
|
view?: ViewConfig;
|
|
190
|
+
_meta?: ToolMeta;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* The auth face of a tool config: either the high-level `auth` shorthand or the
|
|
194
|
+
* low-level `securitySchemes` escape hatch, never both.
|
|
195
|
+
*/
|
|
196
|
+
type ToolAuthConfig = {
|
|
197
|
+
auth?: ToolAuth;
|
|
198
|
+
securitySchemes?: never;
|
|
199
|
+
} | {
|
|
200
|
+
auth?: never;
|
|
157
201
|
/**
|
|
158
202
|
* Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
|
|
159
203
|
* Lets clients label tools that require sign-in before calling, and pass
|
|
@@ -162,8 +206,8 @@ interface ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> {
|
|
|
162
206
|
* enhanced behavior to authenticated ones.
|
|
163
207
|
*/
|
|
164
208
|
securitySchemes?: SecurityScheme[];
|
|
165
|
-
|
|
166
|
-
|
|
209
|
+
};
|
|
210
|
+
type ToolConfig<TInput extends RawInputShape | StandardSchemaV1> = ToolConfigBase<TInput> & ToolAuthConfig;
|
|
167
211
|
/**
|
|
168
212
|
* Optional client-supplied hints attached to `params._meta` on every tool call
|
|
169
213
|
* by the Apps SDK host. Hints only: never use for authorization, and tolerate
|
|
@@ -193,14 +237,16 @@ export interface ClientHintsMeta {
|
|
|
193
237
|
/** Stable id for the currently mounted widget instance. */
|
|
194
238
|
"openai/widgetSessionId"?: string;
|
|
195
239
|
}
|
|
196
|
-
type ToolHandlerExtra = Omit<
|
|
197
|
-
_meta
|
|
240
|
+
type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
|
|
241
|
+
mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
|
|
242
|
+
_meta?: RequestMeta & ClientHintsMeta;
|
|
243
|
+
};
|
|
198
244
|
};
|
|
199
|
-
type ToolHandler<TInput extends
|
|
245
|
+
type ToolHandler<TInput extends RawInputShape, TReturn extends {
|
|
200
246
|
content?: HandlerContent;
|
|
201
247
|
} = {
|
|
202
248
|
content?: HandlerContent;
|
|
203
|
-
}> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
|
|
249
|
+
}, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | Promise<TReturn>;
|
|
204
250
|
/**
|
|
205
251
|
* Coerce a tool handler's return value into an MCP `content` array. Strings
|
|
206
252
|
* become a single `TextContent`; a single block is wrapped in an array;
|
|
@@ -208,7 +254,7 @@ type ToolHandler<TInput extends ZodRawShapeCompat, TReturn extends {
|
|
|
208
254
|
* who build content lazily can apply the same normalization.
|
|
209
255
|
*/
|
|
210
256
|
export declare function normalizeContent(content: HandlerContent | undefined): ContentBlock[];
|
|
211
|
-
interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "connect"> {
|
|
257
|
+
interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "registerResource" | "registerPrompt" | "connect"> {
|
|
212
258
|
}
|
|
213
259
|
declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof McpServerBase>) => McpServerBaseOmitted;
|
|
214
260
|
/**
|
|
@@ -221,7 +267,8 @@ declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof M
|
|
|
221
267
|
export declare function __setBuildManifest(manifest: Record<string, {
|
|
222
268
|
file: string;
|
|
223
269
|
}>): void;
|
|
224
|
-
export declare
|
|
270
|
+
export declare function __setSkillsManifest(manifest: SkillsManifest): void;
|
|
271
|
+
export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>, TAuthExtra extends ExtraClaims = ExtraClaims> extends McpServerBaseOmitted {
|
|
225
272
|
readonly $types: McpServerTypes<TTools>;
|
|
226
273
|
/**
|
|
227
274
|
* The underlying Express app. Use this to extend the HTTP server with
|
|
@@ -241,6 +288,8 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
241
288
|
private customErrorMiddleware;
|
|
242
289
|
private mcpMiddlewareEntries;
|
|
243
290
|
private mcpMiddlewareApplied;
|
|
291
|
+
private middlewareEntriesCache;
|
|
292
|
+
private readonly registrations;
|
|
244
293
|
private claimedViews;
|
|
245
294
|
private viewMetaBuilders;
|
|
246
295
|
/**
|
|
@@ -253,7 +302,36 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
253
302
|
private viteManifest;
|
|
254
303
|
private readonly serverInfo;
|
|
255
304
|
private readonly serverOptions?;
|
|
256
|
-
|
|
305
|
+
private oauthEnabled;
|
|
306
|
+
private resolveResourceMetadataUrl?;
|
|
307
|
+
private securitySchemesByTool;
|
|
308
|
+
constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions<TAuthExtra>);
|
|
309
|
+
/**
|
|
310
|
+
* Register a resource, recorded so every per-request instance carries it.
|
|
311
|
+
* Signature owned by Skybridge (not inherited) so a typed wrapper can land
|
|
312
|
+
* in a minor without a type-level break.
|
|
313
|
+
*/
|
|
314
|
+
registerResource(name: string, uri: string, config: ResourceMetadata & {
|
|
315
|
+
cacheHint?: CacheHint;
|
|
316
|
+
}, readCallback: ReadResourceCallback): RegisteredResource;
|
|
317
|
+
registerResource(name: string, template: ResourceTemplate, config: ResourceMetadata & {
|
|
318
|
+
cacheHint?: CacheHint;
|
|
319
|
+
}, readCallback: ReadResourceTemplateCallback): RegisteredResourceTemplate;
|
|
320
|
+
/**
|
|
321
|
+
* Register a prompt, recorded so every per-request instance carries it.
|
|
322
|
+
* Signature owned by Skybridge (not inherited) so a typed wrapper can land
|
|
323
|
+
* in a minor without a type-level break.
|
|
324
|
+
*/
|
|
325
|
+
registerPrompt<Args extends StandardSchemaWithJSON>(name: string, config: {
|
|
326
|
+
title?: string;
|
|
327
|
+
description?: string;
|
|
328
|
+
argsSchema?: Args;
|
|
329
|
+
icons?: Icon[];
|
|
330
|
+
_meta?: Record<string, unknown>;
|
|
331
|
+
}, cb: PromptCallback<Args>): RegisteredPrompt;
|
|
332
|
+
private recordInherited;
|
|
333
|
+
private skillRegistrar;
|
|
334
|
+
private setupSkills;
|
|
257
335
|
/**
|
|
258
336
|
* Register Express middleware on the underlying app. Mirrors `app.use` —
|
|
259
337
|
* pass handlers directly or a path-prefixed handler list. Register before
|
|
@@ -280,12 +358,12 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
280
358
|
useOnError(...handlers: ErrorRequestHandler[]): this;
|
|
281
359
|
useOnError(path: string, ...handlers: ErrorRequestHandler[]): this;
|
|
282
360
|
/** Register MCP protocol-level middleware (catch-all). */
|
|
283
|
-
mcpMiddleware(handler: McpMiddlewareFn): this;
|
|
361
|
+
mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
284
362
|
/** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
|
|
285
363
|
mcpMiddleware(filter: "request", handler: (request: {
|
|
286
364
|
method: string;
|
|
287
365
|
params: Record<string, unknown>;
|
|
288
|
-
}, extra: McpExtra
|
|
366
|
+
}, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
|
|
289
367
|
/** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
|
|
290
368
|
mcpMiddleware(filter: "notification", handler: (request: {
|
|
291
369
|
method: string;
|
|
@@ -295,7 +373,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
295
373
|
* Register MCP protocol-level middleware for an exact method.
|
|
296
374
|
* Narrows `params`, `extra`, and `next()` result based on the method string.
|
|
297
375
|
*/
|
|
298
|
-
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
|
|
376
|
+
mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
|
|
299
377
|
/**
|
|
300
378
|
* Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
|
|
301
379
|
* `next()` returns the union of result types for matching methods.
|
|
@@ -303,14 +381,15 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
303
381
|
mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
|
|
304
382
|
method: string;
|
|
305
383
|
params: Record<string, unknown>;
|
|
306
|
-
}, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
384
|
+
}, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
|
|
307
385
|
/**
|
|
308
386
|
* Register MCP protocol-level middleware with a method filter.
|
|
309
387
|
* Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
|
|
310
388
|
* category (`"request"` | `"notification"`), or an array of those.
|
|
311
389
|
*/
|
|
312
|
-
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
|
|
390
|
+
mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
|
|
313
391
|
private applyMcpMiddleware;
|
|
392
|
+
private instrumentHandlers;
|
|
314
393
|
/**
|
|
315
394
|
* Connect to an MCP transport (override of the SDK's `connect`). Use this
|
|
316
395
|
* when you're embedding Skybridge in a host that already manages its own
|
|
@@ -321,16 +400,22 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
321
400
|
*/
|
|
322
401
|
connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
|
|
323
402
|
/**
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
|
|
403
|
+
* Build a fresh server for one stateless HTTP request, as
|
|
404
|
+
* `createMcpHandler`'s factory contract requires: every registration is
|
|
405
|
+
* replayed onto the new instance so the SDK's handler closures belong to
|
|
406
|
+
* the instance whose protocol era it stamps. Sharing the singleton's
|
|
407
|
+
* handler maps instead would bind them to an instance that is never
|
|
408
|
+
* marked, pinning every request to the 2025 codec and letting concurrent
|
|
409
|
+
* callers overwrite each other's negotiated version.
|
|
410
|
+
*/
|
|
411
|
+
createStatelessServerInstance(): SdkServer;
|
|
412
|
+
/**
|
|
413
|
+
* Apply an SDK registration to the singleton and remember it, so each
|
|
414
|
+
* per-request instance can be built with the same surface.
|
|
332
415
|
*/
|
|
333
|
-
|
|
416
|
+
private record;
|
|
417
|
+
/** Records a raw request handler (used for methods the SDK has no sugar for). */
|
|
418
|
+
private recordRequestHandler;
|
|
334
419
|
/**
|
|
335
420
|
* Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
|
|
336
421
|
* mounts the `/mcp` route, applies any custom Express middleware registered
|
|
@@ -350,7 +435,8 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
350
435
|
private resolveViewRequestContext;
|
|
351
436
|
private registerViewResources;
|
|
352
437
|
private registerViewResource;
|
|
353
|
-
private
|
|
438
|
+
private serveLegacyAppsSdkUrl;
|
|
439
|
+
private decorateToolHandler;
|
|
354
440
|
private computeViewVersionParam;
|
|
355
441
|
private lookupViewFile;
|
|
356
442
|
private lookupDistFile;
|
|
@@ -393,11 +479,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
|
|
|
393
479
|
*
|
|
394
480
|
* @see https://docs.skybridge.tech/api-reference/register-tool
|
|
395
481
|
*/
|
|
396
|
-
registerTool<TName extends string, InputArgs extends
|
|
482
|
+
registerTool<TName extends string, InputArgs extends RawInputShape, TReturn extends {
|
|
397
483
|
content?: HandlerContent;
|
|
398
484
|
}>(config: ToolConfig<InputArgs> & {
|
|
399
485
|
name: TName;
|
|
400
|
-
}, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn
|
|
401
|
-
registerTool<InputArgs extends
|
|
486
|
+
}, cb: ToolHandler<InputArgs, TReturn, TAuthExtra>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
|
|
487
|
+
registerTool<InputArgs extends RawInputShape>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, {
|
|
488
|
+
content?: HandlerContent;
|
|
489
|
+
}, TAuthExtra>): this;
|
|
402
490
|
}
|
|
403
491
|
export {};
|