skybridge 0.0.0-dev.7d48f61 → 0.0.0-dev.7d4c70e

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.
Files changed (161) hide show
  1. package/dist/cli/build-helpers.d.ts +7 -0
  2. package/dist/cli/build-helpers.js +82 -0
  3. package/dist/cli/build-helpers.js.map +1 -0
  4. package/dist/cli/build-helpers.test.d.ts +1 -0
  5. package/dist/cli/build-helpers.test.js +64 -0
  6. package/dist/cli/build-helpers.test.js.map +1 -0
  7. package/dist/cli/detect-port.d.ts +2 -2
  8. package/dist/cli/detect-port.js +9 -20
  9. package/dist/cli/detect-port.js.map +1 -1
  10. package/dist/cli/resolve-views-dir.d.ts +1 -0
  11. package/dist/cli/resolve-views-dir.js +17 -0
  12. package/dist/cli/resolve-views-dir.js.map +1 -0
  13. package/dist/cli/use-typescript-check.js +1 -1
  14. package/dist/cli/use-typescript-check.js.map +1 -1
  15. package/dist/commands/build.d.ts +0 -1
  16. package/dist/commands/build.js +18 -30
  17. package/dist/commands/build.js.map +1 -1
  18. package/dist/commands/create.d.ts +9 -0
  19. package/dist/commands/create.js +30 -0
  20. package/dist/commands/create.js.map +1 -0
  21. package/dist/commands/dev.js +16 -0
  22. package/dist/commands/dev.js.map +1 -1
  23. package/dist/commands/start.js +7 -1
  24. package/dist/commands/start.js.map +1 -1
  25. package/dist/server/asset-base-url-transform-plugin.d.ts +1 -0
  26. package/dist/server/asset-base-url-transform-plugin.js +16 -1
  27. package/dist/server/asset-base-url-transform-plugin.js.map +1 -1
  28. package/dist/server/asset-base-url-transform-plugin.test.js +51 -1
  29. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -1
  30. package/dist/server/auth.d.ts +20 -0
  31. package/dist/server/auth.js +28 -0
  32. package/dist/server/auth.js.map +1 -0
  33. package/dist/server/build-manifest.test.d.ts +1 -0
  34. package/dist/server/build-manifest.test.js +27 -0
  35. package/dist/server/build-manifest.test.js.map +1 -0
  36. package/dist/server/content-helpers.d.ts +40 -0
  37. package/dist/server/content-helpers.js +33 -0
  38. package/dist/server/content-helpers.js.map +1 -1
  39. package/dist/server/express.test.js +30 -0
  40. package/dist/server/express.test.js.map +1 -1
  41. package/dist/server/file-ref.d.ts +20 -0
  42. package/dist/server/file-ref.js +19 -0
  43. package/dist/server/file-ref.js.map +1 -1
  44. package/dist/server/index.d.ts +3 -2
  45. package/dist/server/index.js +2 -1
  46. package/dist/server/index.js.map +1 -1
  47. package/dist/server/middleware.d.ts +16 -3
  48. package/dist/server/middleware.js.map +1 -1
  49. package/dist/server/server.d.ts +185 -3
  50. package/dist/server/server.js +190 -58
  51. package/dist/server/server.js.map +1 -1
  52. package/dist/test/view.test.js +45 -0
  53. package/dist/test/view.test.js.map +1 -1
  54. package/dist/web/bridges/apps-sdk/adaptor.d.ts +4 -1
  55. package/dist/web/bridges/apps-sdk/adaptor.js +16 -1
  56. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -1
  57. package/dist/web/bridges/apps-sdk/bridge.d.ts +1 -0
  58. package/dist/web/bridges/apps-sdk/bridge.js +1 -0
  59. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  60. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  61. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  62. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  63. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  64. package/dist/web/bridges/get-adaptor.js +7 -0
  65. package/dist/web/bridges/get-adaptor.js.map +1 -1
  66. package/dist/web/bridges/mcp-app/adaptor.d.ts +4 -1
  67. package/dist/web/bridges/mcp-app/adaptor.js +12 -0
  68. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -1
  69. package/dist/web/bridges/mcp-app/bridge.d.ts +4 -2
  70. package/dist/web/bridges/mcp-app/bridge.js +23 -1
  71. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  72. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +12 -0
  73. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +12 -0
  74. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  75. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  76. package/dist/web/bridges/mcp-app/view-tools.test.js +144 -0
  77. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  78. package/dist/web/bridges/types.d.ts +88 -1
  79. package/dist/web/bridges/types.js.map +1 -1
  80. package/dist/web/bridges/use-host-context.d.ts +5 -0
  81. package/dist/web/bridges/use-host-context.js +5 -0
  82. package/dist/web/bridges/use-host-context.js.map +1 -1
  83. package/dist/web/create-store.d.ts +26 -0
  84. package/dist/web/create-store.js +26 -0
  85. package/dist/web/create-store.js.map +1 -1
  86. package/dist/web/data-llm.d.ts +33 -0
  87. package/dist/web/data-llm.js +28 -0
  88. package/dist/web/data-llm.js.map +1 -1
  89. package/dist/web/generate-helpers.d.ts +2 -0
  90. package/dist/web/generate-helpers.js +2 -0
  91. package/dist/web/generate-helpers.js.map +1 -1
  92. package/dist/web/generate-helpers.test-d.js +4 -2
  93. package/dist/web/generate-helpers.test-d.js.map +1 -1
  94. package/dist/web/hooks/index.d.ts +2 -0
  95. package/dist/web/hooks/index.js +2 -0
  96. package/dist/web/hooks/index.js.map +1 -1
  97. package/dist/web/hooks/test/utils.d.ts +6 -2
  98. package/dist/web/hooks/test/utils.js +13 -2
  99. package/dist/web/hooks/test/utils.js.map +1 -1
  100. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  101. package/dist/web/hooks/use-call-tool.js +28 -0
  102. package/dist/web/hooks/use-call-tool.js.map +1 -1
  103. package/dist/web/hooks/use-call-tool.test.js +27 -2
  104. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  105. package/dist/web/hooks/use-display-mode.d.ts +20 -0
  106. package/dist/web/hooks/use-display-mode.js +20 -0
  107. package/dist/web/hooks/use-display-mode.js.map +1 -1
  108. package/dist/web/hooks/use-download.d.ts +5 -0
  109. package/dist/web/hooks/use-download.js +8 -0
  110. package/dist/web/hooks/use-download.js.map +1 -0
  111. package/dist/web/hooks/use-download.test.d.ts +1 -0
  112. package/dist/web/hooks/use-download.test.js +95 -0
  113. package/dist/web/hooks/use-download.test.js.map +1 -0
  114. package/dist/web/hooks/use-files.d.ts +32 -0
  115. package/dist/web/hooks/use-files.js +32 -0
  116. package/dist/web/hooks/use-files.js.map +1 -1
  117. package/dist/web/hooks/use-layout.d.ts +2 -0
  118. package/dist/web/hooks/use-layout.js +2 -0
  119. package/dist/web/hooks/use-layout.js.map +1 -1
  120. package/dist/web/hooks/use-open-external.d.ts +17 -0
  121. package/dist/web/hooks/use-open-external.js +16 -0
  122. package/dist/web/hooks/use-open-external.js.map +1 -1
  123. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  124. package/dist/web/hooks/use-register-view-tool.js +50 -0
  125. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  126. package/dist/web/hooks/use-request-close.d.ts +14 -0
  127. package/dist/web/hooks/use-request-close.js +13 -0
  128. package/dist/web/hooks/use-request-close.js.map +1 -1
  129. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  130. package/dist/web/hooks/use-request-modal.js +16 -1
  131. package/dist/web/hooks/use-request-modal.js.map +1 -1
  132. package/dist/web/hooks/use-request-size.d.ts +17 -0
  133. package/dist/web/hooks/use-request-size.js +16 -0
  134. package/dist/web/hooks/use-request-size.js.map +1 -1
  135. package/dist/web/hooks/use-send-follow-up-message.d.ts +17 -0
  136. package/dist/web/hooks/use-send-follow-up-message.js +17 -0
  137. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  138. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  139. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  140. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  141. package/dist/web/hooks/use-tool-info.d.ts +53 -2
  142. package/dist/web/hooks/use-tool-info.js +30 -7
  143. package/dist/web/hooks/use-tool-info.js.map +1 -1
  144. package/dist/web/hooks/use-tool-info.test-d.js +11 -29
  145. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  146. package/dist/web/hooks/use-tool-info.test.js +5 -5
  147. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  148. package/dist/web/hooks/use-user.d.ts +2 -0
  149. package/dist/web/hooks/use-user.js +2 -0
  150. package/dist/web/hooks/use-user.js.map +1 -1
  151. package/dist/web/hooks/use-view-state.d.ts +21 -0
  152. package/dist/web/hooks/use-view-state.js.map +1 -1
  153. package/dist/web/mount-view.d.ts +19 -0
  154. package/dist/web/mount-view.js +19 -0
  155. package/dist/web/mount-view.js.map +1 -1
  156. package/dist/web/plugin/plugin.d.ts +28 -0
  157. package/dist/web/plugin/plugin.js +26 -0
  158. package/dist/web/plugin/plugin.js.map +1 -1
  159. package/dist/web/types.d.ts +4 -0
  160. package/dist/web/types.js.map +1 -1
  161. package/package.json +21 -15
@@ -3,15 +3,28 @@ import { type ServerOptions } from "@modelcontextprotocol/sdk/server/index.js";
3
3
  import { McpServer as McpServerBase } from "@modelcontextprotocol/sdk/server/mcp.js";
4
4
  import type { AnySchema, SchemaOutput, ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
5
5
  import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
6
- import type { ContentBlock, Implementation, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
6
+ import type { ContentBlock, Implementation, RequestMeta, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
7
7
  import { type ErrorRequestHandler, type Express, type RequestHandler } from "express";
8
8
  import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
9
+ /**
10
+ * Type marker for a registered tool — carries its input, output, and response
11
+ * metadata shapes so views can infer types from `typeof server`.
12
+ *
13
+ * You normally never construct this by hand; it is produced by `registerTool`
14
+ * and consumed by helpers like {@link InferTools} and {@link generateHelpers}.
15
+ */
9
16
  export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unknown> = {
10
17
  input: TInput;
11
18
  output: TOutput;
12
19
  responseMetadata: TResponseMetadata;
13
20
  };
21
+ /** Which host runtime a view targets — `"apps-sdk"` (ChatGPT) or `"mcp-app"` (MCP Apps spec). */
14
22
  export type ViewHostType = "apps-sdk" | "mcp-app";
23
+ /**
24
+ * Content Security Policy origins attached to a view's resource. Each list is
25
+ * passed through to the host's CSP for the view iframe; omit a field to inherit
26
+ * the host's default for that directive.
27
+ */
15
28
  export interface ViewCsp {
16
29
  /** Origins for static assets (images, fonts, scripts, styles). */
17
30
  resourceDomains?: string[];
@@ -24,26 +37,67 @@ export interface ViewCsp {
24
37
  /** Origins allowed in `<base href>` tags (mcp-apps only). */
25
38
  baseUriDomains?: string[];
26
39
  }
40
+ /**
41
+ * Registry of view component names. The Skybridge Vite plugin augments this
42
+ * interface in the generated `.skybridge/views.d.ts` with one key per view
43
+ * file, which narrows {@link ViewName} from `string` to the concrete union.
44
+ */
27
45
  export interface ViewNameRegistry {
28
46
  }
47
+ /** Union of valid view component names. Narrowed by {@link ViewNameRegistry}. */
29
48
  export type ViewName = keyof ViewNameRegistry & string;
49
+ /**
50
+ * Pass under `view` in a tool's `registerTool` config to render the tool's
51
+ * result through a Skybridge view instead of a plain text response.
52
+ */
30
53
  export interface ViewConfig {
54
+ /** Filename of the view module (without extension) — matches a file in your `viewsDir`. */
31
55
  component: ViewName;
56
+ /** Human-readable label the host may show alongside the view. */
32
57
  description?: string;
58
+ /** Restrict where the view is rendered. Defaults to all known hosts. */
33
59
  hosts?: ViewHostType[];
60
+ /** Apps SDK only: request a visible border around the widget. */
34
61
  prefersBorder?: boolean;
62
+ /** Apps SDK only: override the iframe's served domain (advanced). */
35
63
  domain?: string;
64
+ /** Per-view CSP overrides — see {@link ViewCsp}. */
36
65
  csp?: ViewCsp;
66
+ /** Free-form metadata forwarded on the view resource's `_meta`. */
37
67
  _meta?: Record<string, unknown>;
38
68
  }
69
+ export type SecurityScheme = {
70
+ type: "noauth";
71
+ } | {
72
+ type: "oauth2";
73
+ scopes?: string[];
74
+ };
75
+ /**
76
+ * Well-known keys recognized by host runtimes when set on a tool's `_meta`.
77
+ * Use {@link ToolMeta} to also pass arbitrary custom metadata alongside these.
78
+ *
79
+ * @see https://developers.openai.com/apps-sdk/reference#tool-descriptor-parameters
80
+ */
39
81
  export interface KnownToolMeta {
82
+ /** Apps SDK: allow the rendered view to call this tool from inside its iframe. */
40
83
  "openai/widgetAccessible"?: boolean;
84
+ /** Apps SDK: status text shown while the tool is running (e.g. `"Searching trips"`). */
41
85
  "openai/toolInvocation/invoking"?: string;
86
+ /** Apps SDK: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
42
87
  "openai/toolInvocation/invoked"?: string;
88
+ /** Apps SDK: input parameters that hold file references — the host attaches uploaded files to them. */
43
89
  "openai/fileParams"?: string[];
90
+ /** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
44
91
  ui?: Pick<McpUiToolMeta, "visibility">;
92
+ securitySchemes?: SecurityScheme[];
45
93
  }
94
+ /** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
46
95
  export type ToolMeta = KnownToolMeta & Record<string, unknown>;
96
+ /**
97
+ * Convenient return type for tool handlers — a plain string, a single
98
+ * {@link ContentBlock}, or an array. Skybridge normalizes it to the MCP
99
+ * `content: ContentBlock[]` shape before responding.
100
+ */
47
101
  export type HandlerContent = string | ContentBlock | ContentBlock[];
48
102
  /**
49
103
  * Type-level marker interface for cross-package type inference.
@@ -87,17 +141,73 @@ interface ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> {
87
141
  outputSchema?: ZodRawShapeCompat | AnySchema;
88
142
  annotations?: ToolAnnotations;
89
143
  view?: ViewConfig;
144
+ /**
145
+ * Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
146
+ * Lets clients label tools that require sign-in before calling, and pass
147
+ * the right scopes through the OAuth flow. Listing both `noauth` and
148
+ * `oauth2` signals that the tool works for anonymous callers and gives
149
+ * enhanced behavior to authenticated ones.
150
+ */
151
+ securitySchemes?: SecurityScheme[];
90
152
  _meta?: ToolMeta;
91
153
  }
154
+ /**
155
+ * Optional client-supplied hints attached to `params._meta` on every tool call
156
+ * by the Apps SDK host. Hints only: never use for authorization, and tolerate
157
+ * absence.
158
+ * @see https://developers.openai.com/apps-sdk/reference#_meta-fields-the-client-provides
159
+ */
160
+ export interface ClientHintsMeta {
161
+ /** Requested locale (BCP-47, e.g. `"en-US"`). */
162
+ "openai/locale"?: string;
163
+ /** Browser user-agent */
164
+ "openai/userAgent"?: string;
165
+ /** Coarse user location. May be partially populated. */
166
+ "openai/userLocation"?: {
167
+ city?: string;
168
+ region?: string;
169
+ country?: string;
170
+ timezone?: string;
171
+ longitude?: number;
172
+ latitude?: number;
173
+ };
174
+ /** Anonymized user id. */
175
+ "openai/subject"?: string;
176
+ /** Anonymized conversation id, stable within a ChatGPT session. */
177
+ "openai/session"?: string;
178
+ /** Anonymized organization id, when the user account is part of an organization. */
179
+ "openai/organization"?: string;
180
+ /** Stable id for the currently mounted widget instance. */
181
+ "openai/widgetSessionId"?: string;
182
+ }
183
+ type ToolHandlerExtra = Omit<RequestHandlerExtra<ServerRequest, ServerNotification>, "_meta"> & {
184
+ _meta?: RequestMeta & ClientHintsMeta;
185
+ };
92
186
  type ToolHandler<TInput extends ZodRawShapeCompat, TReturn extends {
93
187
  content?: HandlerContent;
94
188
  } = {
95
189
  content?: HandlerContent;
96
- }> = (args: ShapeOutput<TInput>, extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => TReturn | Promise<TReturn>;
190
+ }> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
191
+ /**
192
+ * Coerce a tool handler's return value into an MCP `content` array. Strings
193
+ * become a single `TextContent`; a single block is wrapped in an array;
194
+ * `undefined` produces `[]`. Mostly used internally — exported so consumers
195
+ * who build content lazily can apply the same normalization.
196
+ */
97
197
  export declare function normalizeContent(content: HandlerContent | undefined): ContentBlock[];
98
198
  interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "connect"> {
99
199
  }
100
200
  declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof McpServerBase>) => McpServerBaseOmitted;
201
+ /**
202
+ * Prime the build-time Vite manifest before user code constructs its
203
+ * `McpServer`. Called from the generated `dist/__entry.js`; not part of the
204
+ * user-facing API.
205
+ *
206
+ * @internal
207
+ */
208
+ export declare function __setBuildManifest(manifest: Record<string, {
209
+ file: string;
210
+ }>): void;
101
211
  export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>> extends McpServerBaseOmitted {
102
212
  readonly $types: McpServerTypes<TTools>;
103
213
  /**
@@ -117,12 +227,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
117
227
  private mcpMiddlewareEntries;
118
228
  private mcpMiddlewareApplied;
119
229
  private claimedViews;
230
+ private viewMetaBuilders;
120
231
  private viteManifest;
121
232
  private readonly serverInfo;
122
233
  private readonly serverOptions?;
123
234
  constructor(serverInfo: Implementation, options?: ServerOptions);
235
+ /**
236
+ * Register Express middleware on the underlying app. Mirrors `app.use` —
237
+ * pass handlers directly or a path-prefixed handler list. Register before
238
+ * {@link McpServer.run}; ordering matches Express.
239
+ *
240
+ * Note: Alpic Cloud only routes traffic to `/mcp`. Custom paths work
241
+ * locally and on self-hosted deployments.
242
+ */
124
243
  use(...handlers: RequestHandler[]): this;
125
244
  use(path: string, ...handlers: RequestHandler[]): this;
245
+ /**
246
+ * Register Express error-handling middleware to run after the built-in
247
+ * `/mcp` route (or your custom route). Use this to log or transform errors
248
+ * thrown by tool handlers before the default error handler responds.
249
+ *
250
+ * @example
251
+ * ```ts
252
+ * server.useOnError((err, _req, _res, next) => {
253
+ * logger.error(err);
254
+ * next(err);
255
+ * });
256
+ * ```
257
+ */
126
258
  useOnError(...handlers: ErrorRequestHandler[]): this;
127
259
  useOnError(path: string, ...handlers: ErrorRequestHandler[]): this;
128
260
  /** Register MCP protocol-level middleware (catch-all). */
@@ -157,6 +289,14 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
157
289
  */
158
290
  mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
159
291
  private applyMcpMiddleware;
292
+ /**
293
+ * Connect to an MCP transport (override of the SDK's `connect`). Use this
294
+ * when you're embedding Skybridge in a host that already manages its own
295
+ * transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
296
+ * which sets the transport up for you. Locks in any middleware registered
297
+ * via {@link McpServer.mcpMiddleware} — further calls to that method will
298
+ * throw afterwards.
299
+ */
160
300
  connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
161
301
  /**
162
302
  * Per-request stateless connect. The SDK's `Protocol` only allows one
@@ -169,10 +309,23 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
169
309
  * read side and fails fast on SDK field renames.
170
310
  */
171
311
  connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
312
+ /**
313
+ * Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
314
+ * mounts the `/mcp` route, applies any custom Express middleware registered
315
+ * via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
316
+ * any MCP middleware registered via {@link McpServer.mcpMiddleware}.
317
+ *
318
+ * On Cloudflare Workers / workerd, returns an object exposing `fetch` so
319
+ * the runtime can bridge incoming requests to the Node HTTP server. On
320
+ * Vercel (`VERCEL === "1"`), returns the Express app directly so the
321
+ * serverless function entry can call it as a `(req, res)` handler. On
322
+ * Node, returns `undefined` once listening.
323
+ */
172
324
  run(): Promise<{
173
325
  fetch: (...args: unknown[]) => unknown;
174
- } | undefined>;
326
+ } | Express | undefined>;
175
327
  private enforceOneToolPerView;
328
+ private resolveViewRequestContext;
176
329
  private registerViewResources;
177
330
  private registerViewResource;
178
331
  private wrapHandler;
@@ -189,6 +342,35 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
189
342
  file: string;
190
343
  }>): this;
191
344
  private readManifest;
345
+ /**
346
+ * Register a tool. Pass a `config` describing the tool (name, schemas,
347
+ * optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
348
+ * returns the tool's result.
349
+ *
350
+ * Chain calls to build up a server: each call returns a new `McpServer`
351
+ * type that captures the tool's input/output/`_meta` shape so the
352
+ * resulting `typeof server` can drive {@link generateHelpers}.
353
+ *
354
+ * The handler's return shape determines the output types: the
355
+ * `structuredContent` field becomes the tool's typed output, and `_meta`
356
+ * becomes its `responseMetadata`. The `content` field is normalized through
357
+ * {@link normalizeContent}.
358
+ *
359
+ * @example
360
+ * ```ts
361
+ * server.registerTool({
362
+ * name: "search",
363
+ * inputSchema: { query: z.string() },
364
+ * outputSchema: { results: z.array(z.string()) },
365
+ * view: { component: "search" },
366
+ * }, async ({ query }) => ({
367
+ * content: `Found results for ${query}`,
368
+ * structuredContent: { results: [...] },
369
+ * }));
370
+ * ```
371
+ *
372
+ * @see https://docs.skybridge.tech/api-reference/register-tool
373
+ */
192
374
  registerTool<TName extends string, InputArgs extends ZodRawShapeCompat, TReturn extends {
193
375
  content?: HandlerContent;
194
376
  }>(config: ToolConfig<InputArgs> & {
@@ -17,6 +17,12 @@ const mergeWithUnion = (target, source) => {
17
17
  }
18
18
  });
19
19
  };
20
+ /**
21
+ * Coerce a tool handler's return value into an MCP `content` array. Strings
22
+ * become a single `TextContent`; a single block is wrapped in an array;
23
+ * `undefined` produces `[]`. Mostly used internally — exported so consumers
24
+ * who build content lazily can apply the same normalization.
25
+ */
20
26
  export function normalizeContent(content) {
21
27
  if (content === undefined) {
22
28
  return [];
@@ -30,6 +36,51 @@ export function normalizeContent(content) {
30
36
  return [content];
31
37
  }
32
38
  const McpServerBaseOmitted = McpServerBase;
39
+ /**
40
+ * The Skybridge server. Extends the MCP SDK's `McpServer` with a typed tool
41
+ * registry, view resources, an embedded Express app, and protocol-level
42
+ * middleware. Construct it with the same `Implementation` info you would pass
43
+ * to the SDK, chain {@link McpServer.registerTool} calls to declare tools,
44
+ * then call {@link McpServer.run} to start the HTTP server.
45
+ *
46
+ * The `TTools` generic accumulates each registered tool's input/output/meta
47
+ * shape, so `typeof server` carries enough information for view-side helpers
48
+ * like {@link generateHelpers} to produce fully-typed hooks.
49
+ *
50
+ * @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
51
+ * chaining; you almost never set this manually.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const server = new McpServer({ name: "my-app", version: "1.0.0" }, {})
56
+ * .registerTool({
57
+ * name: "search",
58
+ * inputSchema: { query: z.string() },
59
+ * view: { component: "search" },
60
+ * }, async ({ query }) => ({ content: `Results for ${query}` }));
61
+ *
62
+ * await server.run();
63
+ * export type AppType = typeof server;
64
+ * ```
65
+ *
66
+ * @see https://docs.skybridge.tech/api-reference/mcp-server
67
+ */
68
+ // Side channel populated by `dist/__entry.js` before user code is imported.
69
+ // Set at module scope rather than passed through the constructor because the
70
+ // wrapper has the manifest before the user's `new McpServer(...)` runs, and
71
+ // threading it through every call site (including user templates) is exactly
72
+ // the boilerplate this design is trying to hide.
73
+ let pendingBuildManifest = null;
74
+ /**
75
+ * Prime the build-time Vite manifest before user code constructs its
76
+ * `McpServer`. Called from the generated `dist/__entry.js`; not part of the
77
+ * user-facing API.
78
+ *
79
+ * @internal
80
+ */
81
+ export function __setBuildManifest(manifest) {
82
+ pendingBuildManifest = manifest;
83
+ }
33
84
  export class McpServer extends McpServerBaseOmitted {
34
85
  /**
35
86
  * The underlying Express app. Use this to extend the HTTP server with
@@ -48,6 +99,7 @@ export class McpServer extends McpServerBaseOmitted {
48
99
  mcpMiddlewareEntries = [];
49
100
  mcpMiddlewareApplied = false;
50
101
  claimedViews = new Map();
102
+ viewMetaBuilders = new Map();
51
103
  viteManifest = null;
52
104
  serverInfo;
53
105
  serverOptions;
@@ -57,6 +109,15 @@ export class McpServer extends McpServerBaseOmitted {
57
109
  this.serverOptions = options;
58
110
  this.express = express();
59
111
  this.express.use(express.json());
112
+ // Pick up the manifest if `dist/__entry.js` primed it before importing
113
+ // user code. Consume-once: clear after the first construction so a
114
+ // subsequent test that doesn't prime can't inherit stale state.
115
+ // Explicit `setViteManifest` calls still win because they happen after
116
+ // construction.
117
+ if (pendingBuildManifest) {
118
+ this.setViteManifest(pendingBuildManifest);
119
+ pendingBuildManifest = null;
120
+ }
60
121
  }
61
122
  use(pathOrHandler, ...handlers) {
62
123
  // Branching is load-bearing: Express's `app.use` overloads can't be
@@ -109,10 +170,32 @@ export class McpServer extends McpServerBaseOmitted {
109
170
  return;
110
171
  }
111
172
  this.mcpMiddlewareApplied = true;
173
+ // Surface view-resource _meta on `resources/list` (per ext-apps spec:
174
+ // hosts/checkers read CSP & domain at list time before fetching content).
175
+ const viewListMetaEntry = {
176
+ filter: "resources/list",
177
+ handler: async (_req, extra, next) => {
178
+ const result = (await next());
179
+ for (const resource of result.resources) {
180
+ const builder = this.viewMetaBuilders.get(resource.uri);
181
+ if (!builder) {
182
+ continue;
183
+ }
184
+ const meta = builder(extra);
185
+ resource._meta = {
186
+ ...(resource._meta ?? {}),
187
+ ...meta,
188
+ };
189
+ }
190
+ return result;
191
+ },
192
+ };
112
193
  const monitoringEntry = createMiddlewareEntry();
113
- const entries = monitoringEntry
114
- ? [monitoringEntry, ...this.mcpMiddlewareEntries]
115
- : this.mcpMiddlewareEntries;
194
+ const entries = [
195
+ ...(monitoringEntry ? [monitoringEntry] : []),
196
+ viewListMetaEntry,
197
+ ...this.mcpMiddlewareEntries,
198
+ ];
116
199
  if (entries.length === 0) {
117
200
  return;
118
201
  }
@@ -127,6 +210,14 @@ export class McpServer extends McpServerBaseOmitted {
127
210
  instrumentMap(requestHandlers, false);
128
211
  instrumentMap(notificationHandlers, true);
129
212
  }
213
+ /**
214
+ * Connect to an MCP transport (override of the SDK's `connect`). Use this
215
+ * when you're embedding Skybridge in a host that already manages its own
216
+ * transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
217
+ * which sets the transport up for you. Locks in any middleware registered
218
+ * via {@link McpServer.mcpMiddleware} — further calls to that method will
219
+ * throw afterwards.
220
+ */
130
221
  async connect(transport) {
131
222
  this.applyMcpMiddleware();
132
223
  return McpServerBase.prototype.connect.call(this, transport);
@@ -150,8 +241,32 @@ export class McpServer extends McpServerBaseOmitted {
150
241
  target._notificationHandlers = notificationHandlers;
151
242
  await fresh.connect(transport);
152
243
  }
244
+ /**
245
+ * Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
246
+ * mounts the `/mcp` route, applies any custom Express middleware registered
247
+ * via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
248
+ * any MCP middleware registered via {@link McpServer.mcpMiddleware}.
249
+ *
250
+ * On Cloudflare Workers / workerd, returns an object exposing `fetch` so
251
+ * the runtime can bridge incoming requests to the Node HTTP server. On
252
+ * Vercel (`VERCEL === "1"`), returns the Express app directly so the
253
+ * serverless function entry can call it as a `(req, res)` handler. On
254
+ * Node, returns `undefined` once listening.
255
+ */
153
256
  async run() {
154
257
  this.applyMcpMiddleware();
258
+ if (process.env.VERCEL === "1") {
259
+ // createApp only reads httpServer inside its dev-only branch
260
+ // (viewsDevServer); under VERCEL=1 + NODE_ENV=production it's a
261
+ // bare object passed to satisfy the required parameter.
262
+ const httpServer = http.createServer();
263
+ await createApp({
264
+ mcpServer: this,
265
+ httpServer,
266
+ errorMiddleware: this.customErrorMiddleware,
267
+ });
268
+ return this.express;
269
+ }
155
270
  const httpServer = http.createServer();
156
271
  await createApp({
157
272
  mcpServer: this,
@@ -199,6 +314,57 @@ export class McpServer extends McpServerBaseOmitted {
199
314
  }
200
315
  this.claimedViews.set(component, toolName);
201
316
  }
317
+ resolveViewRequestContext(extra) {
318
+ const isProduction = process.env.NODE_ENV === "production";
319
+ const headers = extra?.requestInfo?.headers || {};
320
+ const header = (key) => {
321
+ const val = headers[key];
322
+ return Array.isArray(val) ? val[0] : val;
323
+ };
324
+ const isClaude = header("user-agent") === "Claude-User";
325
+ let serverUrl;
326
+ const forwardedHost = header("x-forwarded-host");
327
+ const origin = header("origin");
328
+ const host = header("host");
329
+ if (forwardedHost) {
330
+ const proto = header("x-forwarded-proto") || "https";
331
+ serverUrl = `${proto}://${forwardedHost}`;
332
+ }
333
+ else if (origin) {
334
+ serverUrl = origin;
335
+ }
336
+ else if (host) {
337
+ const proto = ["127.0.0.1:", "localhost:"].some((p) => host.startsWith(p))
338
+ ? "http"
339
+ : "https";
340
+ serverUrl = `${proto}://${host}`;
341
+ }
342
+ else {
343
+ const devPort = process.env.__PORT || "3000";
344
+ serverUrl = `http://localhost:${devPort}`;
345
+ }
346
+ const connectDomains = [serverUrl];
347
+ if (!isProduction) {
348
+ const wsUrl = new URL(serverUrl);
349
+ wsUrl.protocol = wsUrl.protocol === "https:" ? "wss:" : "ws:";
350
+ connectDomains.push(wsUrl.origin);
351
+ }
352
+ let contentMetaOverrides = {};
353
+ if (isClaude) {
354
+ const pathname = extra?.requestInfo?.url?.pathname ?? "";
355
+ const rawUrl = header("x-alpic-forwarded-url") ?? `${serverUrl}${pathname}`;
356
+ // Strip a lone trailing slash so the hash matches the connector URL
357
+ // as registered with Claude (which has no trailing slash on bare origins).
358
+ const url = rawUrl.endsWith("/") ? rawUrl.slice(0, -1) : rawUrl;
359
+ const hash = crypto
360
+ .createHash("sha256")
361
+ .update(url)
362
+ .digest("hex")
363
+ .slice(0, 32);
364
+ contentMetaOverrides = { domain: `${hash}.claudemcpcontent.com` };
365
+ }
366
+ return { serverUrl, connectDomains, contentMetaOverrides };
367
+ }
202
368
  registerViewResources(toolName, view, toolMeta) {
203
369
  const hosts = view.hosts ?? ["apps-sdk", "mcp-app"];
204
370
  // Append a content-derived version param so hosts (e.g. ChatGPT) bust
@@ -308,35 +474,19 @@ export class McpServer extends McpServerBaseOmitted {
308
474
  }
309
475
  registerViewResource({ name, viewResource, view, }) {
310
476
  const { hostType, uri: viewUri, mimeType, buildContentMeta } = viewResource;
477
+ const buildMeta = (extra) => {
478
+ const { serverUrl, connectDomains, contentMetaOverrides } = this.resolveViewRequestContext(extra);
479
+ return buildContentMeta({
480
+ resourceDomains: [serverUrl],
481
+ connectDomains,
482
+ domain: serverUrl,
483
+ baseUriDomains: [serverUrl],
484
+ }, contentMetaOverrides);
485
+ };
486
+ this.viewMetaBuilders.set(viewUri, buildMeta);
311
487
  this.registerResource(name, viewUri, { description: view.description }, async (uri, extra) => {
312
488
  const isProduction = process.env.NODE_ENV === "production";
313
- const isClaude = extra?.requestInfo?.headers?.["user-agent"] === "Claude-User";
314
- const headers = extra?.requestInfo?.headers || {};
315
- const header = (key) => {
316
- const val = headers[key];
317
- return Array.isArray(val) ? val[0] : val;
318
- };
319
- let serverUrl;
320
- const forwardedHost = header("x-forwarded-host");
321
- const origin = header("origin");
322
- const host = header("host");
323
- if (forwardedHost) {
324
- const proto = header("x-forwarded-proto") || "https";
325
- serverUrl = `${proto}://${forwardedHost}`;
326
- }
327
- else if (origin) {
328
- serverUrl = origin;
329
- }
330
- else if (host) {
331
- const proto = ["127.0.0.1:", "localhost:"].some((p) => host.startsWith(p))
332
- ? "http"
333
- : "https";
334
- serverUrl = `${proto}://${host}`;
335
- }
336
- else {
337
- const devPort = process.env.__PORT || "3000";
338
- serverUrl = `http://localhost:${devPort}`;
339
- }
489
+ const { serverUrl } = this.resolveViewRequestContext(extra);
340
490
  const html = isProduction
341
491
  ? templateHelper.renderProduction({
342
492
  hostType,
@@ -349,35 +499,9 @@ export class McpServer extends McpServerBaseOmitted {
349
499
  serverUrl,
350
500
  viewName: view.component,
351
501
  });
352
- const connectDomains = [serverUrl];
353
- if (!isProduction) {
354
- const wsUrl = new URL(serverUrl);
355
- wsUrl.protocol = wsUrl.protocol === "https:" ? "wss:" : "ws:";
356
- connectDomains.push(wsUrl.origin);
357
- }
358
- let contentMetaOverrides = {};
359
- if (isClaude) {
360
- const pathname = extra?.requestInfo?.url?.pathname ?? "";
361
- const rawUrl = header("x-alpic-forwarded-url") ?? `${serverUrl}${pathname}`;
362
- // Strip a lone trailing slash so the hash matches the connector URL
363
- // as registered with Claude (which has no trailing slash on bare origins).
364
- const url = rawUrl.endsWith("/") ? rawUrl.slice(0, -1) : rawUrl;
365
- const hash = crypto
366
- .createHash("sha256")
367
- .update(url)
368
- .digest("hex")
369
- .slice(0, 32);
370
- contentMetaOverrides = { domain: `${hash}.claudemcpcontent.com` };
371
- }
372
- const contentMeta = buildContentMeta({
373
- resourceDomains: [serverUrl],
374
- connectDomains,
375
- domain: serverUrl,
376
- baseUriDomains: [serverUrl],
377
- }, contentMetaOverrides);
378
502
  return {
379
503
  contents: [
380
- { uri: uri.href, mimeType, text: html, _meta: contentMeta },
504
+ { uri: uri.href, mimeType, text: html, _meta: buildMeta(extra) },
381
505
  ],
382
506
  };
383
507
  });
@@ -454,8 +578,16 @@ export class McpServer extends McpServerBaseOmitted {
454
578
  }
455
579
  const config = args[0];
456
580
  const cb = args[1];
457
- const { name, view, _meta: userToolMeta, ...toolFields } = config;
581
+ const { name, view, securitySchemes, _meta: userToolMeta, ...toolFields } = config;
458
582
  const toolMeta = { ...userToolMeta };
583
+ if (securitySchemes) {
584
+ // SEP-1488 puts `securitySchemes` at the top level of the tool
585
+ // descriptor, but the SDK's `registerTool` drops unknown top-level
586
+ // fields, so the canonical spot isn't reachable without intercepting
587
+ // `tools/list`. Use the `_meta` back-compat mirror documented in the
588
+ // Apps SDK reference until SEP-1488 lands in the spec.
589
+ toolMeta.securitySchemes = securitySchemes;
590
+ }
459
591
  if (view) {
460
592
  this.enforceOneToolPerView(view.component, name);
461
593
  this.registerViewResources(name, view, toolMeta);