skybridge 1.0.1 → 1.0.3

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 (128) hide show
  1. package/dist/cli/resolve-views-dir.d.ts +1 -0
  2. package/dist/cli/resolve-views-dir.js +17 -0
  3. package/dist/cli/resolve-views-dir.js.map +1 -0
  4. package/dist/cli/use-open-tunnel-browser.d.ts +6 -0
  5. package/dist/cli/use-open-tunnel-browser.js +19 -0
  6. package/dist/cli/use-open-tunnel-browser.js.map +1 -0
  7. package/dist/cli/use-typescript-check.js +1 -1
  8. package/dist/cli/use-typescript-check.js.map +1 -1
  9. package/dist/commands/build.js +1 -16
  10. package/dist/commands/build.js.map +1 -1
  11. package/dist/commands/create.d.ts +9 -0
  12. package/dist/commands/create.js +30 -0
  13. package/dist/commands/create.js.map +1 -0
  14. package/dist/commands/dev.js +19 -1
  15. package/dist/commands/dev.js.map +1 -1
  16. package/dist/server/auth.d.ts +20 -0
  17. package/dist/server/auth.js +28 -0
  18. package/dist/server/auth.js.map +1 -0
  19. package/dist/server/content-helpers.d.ts +40 -0
  20. package/dist/server/content-helpers.js +33 -0
  21. package/dist/server/content-helpers.js.map +1 -1
  22. package/dist/server/file-ref.d.ts +20 -0
  23. package/dist/server/file-ref.js +19 -0
  24. package/dist/server/file-ref.js.map +1 -1
  25. package/dist/server/index.d.ts +2 -1
  26. package/dist/server/index.js +1 -0
  27. package/dist/server/index.js.map +1 -1
  28. package/dist/server/middleware.d.ts +16 -3
  29. package/dist/server/middleware.js.map +1 -1
  30. package/dist/server/server.d.ts +167 -0
  31. package/dist/server/server.js +151 -58
  32. package/dist/server/server.js.map +1 -1
  33. package/dist/test/view.test.js +45 -0
  34. package/dist/test/view.test.js.map +1 -1
  35. package/dist/web/bridges/apps-sdk/adaptor.d.ts +3 -1
  36. package/dist/web/bridges/apps-sdk/adaptor.js +5 -0
  37. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -1
  38. package/dist/web/bridges/apps-sdk/bridge.d.ts +1 -0
  39. package/dist/web/bridges/apps-sdk/bridge.js +1 -0
  40. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  41. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  42. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  43. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  44. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  45. package/dist/web/bridges/get-adaptor.js +7 -0
  46. package/dist/web/bridges/get-adaptor.js.map +1 -1
  47. package/dist/web/bridges/mcp-app/adaptor.d.ts +3 -1
  48. package/dist/web/bridges/mcp-app/adaptor.js +9 -0
  49. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -1
  50. package/dist/web/bridges/mcp-app/bridge.d.ts +1 -0
  51. package/dist/web/bridges/mcp-app/bridge.js +1 -0
  52. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  53. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +12 -0
  54. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +12 -0
  55. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  56. package/dist/web/bridges/types.d.ts +55 -1
  57. package/dist/web/bridges/types.js.map +1 -1
  58. package/dist/web/bridges/use-host-context.d.ts +5 -0
  59. package/dist/web/bridges/use-host-context.js +5 -0
  60. package/dist/web/bridges/use-host-context.js.map +1 -1
  61. package/dist/web/create-store.d.ts +26 -0
  62. package/dist/web/create-store.js +26 -0
  63. package/dist/web/create-store.js.map +1 -1
  64. package/dist/web/data-llm.d.ts +33 -0
  65. package/dist/web/data-llm.js +28 -0
  66. package/dist/web/data-llm.js.map +1 -1
  67. package/dist/web/generate-helpers.d.ts +2 -0
  68. package/dist/web/generate-helpers.js +2 -0
  69. package/dist/web/generate-helpers.js.map +1 -1
  70. package/dist/web/hooks/index.d.ts +1 -0
  71. package/dist/web/hooks/index.js +1 -0
  72. package/dist/web/hooks/index.js.map +1 -1
  73. package/dist/web/hooks/test/utils.d.ts +6 -2
  74. package/dist/web/hooks/test/utils.js +13 -2
  75. package/dist/web/hooks/test/utils.js.map +1 -1
  76. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  77. package/dist/web/hooks/use-call-tool.js +28 -0
  78. package/dist/web/hooks/use-call-tool.js.map +1 -1
  79. package/dist/web/hooks/use-display-mode.d.ts +20 -0
  80. package/dist/web/hooks/use-display-mode.js +20 -0
  81. package/dist/web/hooks/use-display-mode.js.map +1 -1
  82. package/dist/web/hooks/use-download.d.ts +5 -0
  83. package/dist/web/hooks/use-download.js +8 -0
  84. package/dist/web/hooks/use-download.js.map +1 -0
  85. package/dist/web/hooks/use-download.test.d.ts +1 -0
  86. package/dist/web/hooks/use-download.test.js +95 -0
  87. package/dist/web/hooks/use-download.test.js.map +1 -0
  88. package/dist/web/hooks/use-files.d.ts +32 -0
  89. package/dist/web/hooks/use-files.js +32 -0
  90. package/dist/web/hooks/use-files.js.map +1 -1
  91. package/dist/web/hooks/use-layout.d.ts +2 -0
  92. package/dist/web/hooks/use-layout.js +2 -0
  93. package/dist/web/hooks/use-layout.js.map +1 -1
  94. package/dist/web/hooks/use-open-external.d.ts +17 -0
  95. package/dist/web/hooks/use-open-external.js +16 -0
  96. package/dist/web/hooks/use-open-external.js.map +1 -1
  97. package/dist/web/hooks/use-request-close.d.ts +14 -0
  98. package/dist/web/hooks/use-request-close.js +13 -0
  99. package/dist/web/hooks/use-request-close.js.map +1 -1
  100. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  101. package/dist/web/hooks/use-request-modal.js +16 -1
  102. package/dist/web/hooks/use-request-modal.js.map +1 -1
  103. package/dist/web/hooks/use-request-size.d.ts +17 -0
  104. package/dist/web/hooks/use-request-size.js +16 -0
  105. package/dist/web/hooks/use-request-size.js.map +1 -1
  106. package/dist/web/hooks/use-send-follow-up-message.d.ts +17 -0
  107. package/dist/web/hooks/use-send-follow-up-message.js +17 -0
  108. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  109. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  110. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  111. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  112. package/dist/web/hooks/use-tool-info.d.ts +33 -0
  113. package/dist/web/hooks/use-tool-info.js +26 -0
  114. package/dist/web/hooks/use-tool-info.js.map +1 -1
  115. package/dist/web/hooks/use-user.d.ts +2 -0
  116. package/dist/web/hooks/use-user.js +2 -0
  117. package/dist/web/hooks/use-user.js.map +1 -1
  118. package/dist/web/hooks/use-view-state.d.ts +21 -0
  119. package/dist/web/hooks/use-view-state.js.map +1 -1
  120. package/dist/web/mount-view.d.ts +19 -0
  121. package/dist/web/mount-view.js +19 -0
  122. package/dist/web/mount-view.js.map +1 -1
  123. package/dist/web/plugin/plugin.d.ts +28 -0
  124. package/dist/web/plugin/plugin.js +26 -0
  125. package/dist/web/plugin/plugin.js.map +1 -1
  126. package/dist/web/types.d.ts +4 -0
  127. package/dist/web/types.js.map +1 -1
  128. package/package.json +5 -1
@@ -1,4 +1,23 @@
1
1
  import { z } from "zod";
2
+ /**
3
+ * Zod schema for a host-managed file reference passed between tools and views.
4
+ *
5
+ * Use it inside a tool's `inputSchema` or `outputSchema` so the host can
6
+ * recognize the field as a file and surface attach / preview affordances.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * server.registerTool({
11
+ * name: "summarize-document",
12
+ * inputSchema: { document: FileRef },
13
+ * }, async ({ document }) => {
14
+ * const res = await fetch(document.download_url);
15
+ * // …
16
+ * });
17
+ * ```
18
+ *
19
+ * @see https://docs.skybridge.tech/api-reference/file-ref
20
+ */
2
21
  export const FileRef = z.object({
3
22
  file_id: z.string(),
4
23
  download_url: z.string(),
@@ -1 +1 @@
1
- {"version":3,"file":"file-ref.js","sourceRoot":"","sources":["../../src/server/file-ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC","sourcesContent":["import { z } from \"zod\";\n\nexport const FileRef = z.object({\n file_id: z.string(),\n download_url: z.string(),\n mime_type: z.string().optional(),\n file_name: z.string().optional(),\n});\n\nexport type FileRef = z.infer<typeof FileRef>;\n"]}
1
+ {"version":3,"file":"file-ref.js","sourceRoot":"","sources":["../../src/server/file-ref.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC","sourcesContent":["import { z } from \"zod\";\n\n/**\n * Zod schema for a host-managed file reference passed between tools and views.\n *\n * Use it inside a tool's `inputSchema` or `outputSchema` so the host can\n * recognize the field as a file and surface attach / preview affordances.\n *\n * @example\n * ```ts\n * server.registerTool({\n * name: \"summarize-document\",\n * inputSchema: { document: FileRef },\n * }, async ({ document }) => {\n * const res = await fetch(document.download_url);\n * // …\n * });\n * ```\n *\n * @see https://docs.skybridge.tech/api-reference/file-ref\n */\nexport const FileRef = z.object({\n file_id: z.string(),\n download_url: z.string(),\n mime_type: z.string().optional(),\n file_name: z.string().optional(),\n});\n\n/** Inferred TypeScript type for {@link FileRef}. */\nexport type FileRef = z.infer<typeof FileRef>;\n"]}
@@ -1,7 +1,8 @@
1
+ export { type AuthInfo, type AuthMetadataOptions, type BearerAuthMiddlewareOptions, InvalidTokenError, mcpAuthMetadataRouter, optionalBearerAuth, requireBearerAuth, } from "./auth.js";
1
2
  export { audio, embeddedResource, image, resourceLink, text, } from "./content-helpers.js";
2
3
  export { FileRef } from "./file-ref.js";
3
4
  export type { AnyToolRegistry, InferTools, ToolInput, ToolNames, ToolOutput, ToolResponseMetadata, } from "./inferUtilityTypes.js";
4
5
  export type { McpExtra, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard, } from "./middleware.js";
5
- export type { HandlerContent, KnownToolMeta, McpServerTypes, ToolDef, ToolMeta, ViewConfig, ViewCsp, ViewHostType, ViewName, ViewNameRegistry, } from "./server.js";
6
+ export type { HandlerContent, KnownToolMeta, McpServerTypes, SecurityScheme, ToolDef, ToolMeta, ViewConfig, ViewCsp, ViewHostType, ViewName, ViewNameRegistry, } from "./server.js";
6
7
  export { McpServer, normalizeContent, } from "./server.js";
7
8
  export { viewsDevServer } from "./viewsDevServer.js";
@@ -1,3 +1,4 @@
1
+ export { InvalidTokenError, mcpAuthMetadataRouter, optionalBearerAuth, requireBearerAuth, } from "./auth.js";
1
2
  export { audio, embeddedResource, image, resourceLink, text, } from "./content-helpers.js";
2
3
  export { FileRef } from "./file-ref.js";
3
4
  export { McpServer, normalizeContent, } from "./server.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,gBAAgB,EAChB,KAAK,EACL,YAAY,EACZ,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA8BxC,OAAO,EACL,SAAS,EACT,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export {\n audio,\n embeddedResource,\n image,\n resourceLink,\n text,\n} from \"./content-helpers.js\";\nexport { FileRef } from \"./file-ref.js\";\nexport type {\n AnyToolRegistry,\n InferTools,\n ToolInput,\n ToolNames,\n ToolOutput,\n ToolResponseMetadata,\n} from \"./inferUtilityTypes.js\";\nexport type {\n McpExtra,\n McpMethodString,\n McpMiddlewareFilter,\n McpMiddlewareFn,\n McpResultFor,\n McpTypedMiddlewareFn,\n McpWildcard,\n} from \"./middleware.js\";\nexport type {\n HandlerContent,\n KnownToolMeta,\n McpServerTypes,\n ToolDef,\n ToolMeta,\n ViewConfig,\n ViewCsp,\n ViewHostType,\n ViewName,\n ViewNameRegistry,\n} from \"./server.js\";\nexport {\n McpServer,\n normalizeContent,\n} from \"./server.js\";\nexport { viewsDevServer } from \"./viewsDevServer.js\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,EACL,gBAAgB,EAChB,KAAK,EACL,YAAY,EACZ,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AA+BxC,OAAO,EACL,SAAS,EACT,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export {\n type AuthInfo,\n type AuthMetadataOptions,\n type BearerAuthMiddlewareOptions,\n InvalidTokenError,\n mcpAuthMetadataRouter,\n optionalBearerAuth,\n requireBearerAuth,\n} from \"./auth.js\";\nexport {\n audio,\n embeddedResource,\n image,\n resourceLink,\n text,\n} from \"./content-helpers.js\";\nexport { FileRef } from \"./file-ref.js\";\nexport type {\n AnyToolRegistry,\n InferTools,\n ToolInput,\n ToolNames,\n ToolOutput,\n ToolResponseMetadata,\n} from \"./inferUtilityTypes.js\";\nexport type {\n McpExtra,\n McpMethodString,\n McpMiddlewareFilter,\n McpMiddlewareFn,\n McpResultFor,\n McpTypedMiddlewareFn,\n McpWildcard,\n} from \"./middleware.js\";\nexport type {\n HandlerContent,\n KnownToolMeta,\n McpServerTypes,\n SecurityScheme,\n ToolDef,\n ToolMeta,\n ViewConfig,\n ViewCsp,\n ViewHostType,\n ViewName,\n ViewNameRegistry,\n} from \"./server.js\";\nexport {\n McpServer,\n normalizeContent,\n} from \"./server.js\";\nexport { viewsDevServer } from \"./viewsDevServer.js\";\n"]}
@@ -19,7 +19,12 @@ export type McpMiddlewareFn = (request: {
19
19
  * MCP methods the server handles (incoming from client).
20
20
  */
21
21
  export type McpMethodString = ClientRequest["method"] | ClientNotification["method"];
22
- /** Extract params type for a specific MCP method from SDK unions. */
22
+ /**
23
+ * Resolve the `params` type for a specific MCP method (request or notification)
24
+ * from the SDK's typed unions. Falls back to `Record<string, unknown>` for
25
+ * unknown methods. Used by {@link McpTypedMiddlewareFn} to narrow the request
26
+ * shape in typed middleware.
27
+ */
23
28
  export type McpRequestParams<M extends string> = Extract<ClientRequest, {
24
29
  method: M;
25
30
  }> extends {
@@ -29,7 +34,11 @@ export type McpRequestParams<M extends string> = Extract<ClientRequest, {
29
34
  }> extends {
30
35
  params: infer P;
31
36
  } ? P : Record<string, unknown>;
32
- /** Resolve extra type: McpExtra for requests, undefined for notifications. */
37
+ /**
38
+ * Resolve the `extra` arg type for a specific MCP method: {@link McpExtra} for
39
+ * request methods, `undefined` for notification methods (the SDK does not
40
+ * pass extra context for notifications).
41
+ */
33
42
  export type McpExtraFor<M extends string> = M extends ClientRequest["method"] ? McpExtra : M extends ClientNotification["method"] ? undefined : McpExtra | undefined;
34
43
  /** Maps each MCP request method to its SDK result type. */
35
44
  interface McpResultMap {
@@ -59,7 +68,11 @@ interface McpResultMap {
59
68
  * For unknown/unmatched methods, falls back to `ServerResult`.
60
69
  */
61
70
  export type McpResultFor<M extends string> = M extends keyof McpResultMap ? McpResultMap[M] : M extends `${infer Prefix}/*` ? [McpResultMap[keyof McpResultMap & `${Prefix}/${string}`]] extends [never] ? M extends ToWildcard<ClientNotification["method"]> ? undefined : ServerResult : McpResultMap[keyof McpResultMap & `${Prefix}/${string}`] : M extends ClientNotification["method"] ? undefined : ServerResult;
62
- /** Typed middleware fn for a specific method — narrows params, extra, and next() result. */
71
+ /**
72
+ * Typed middleware function for a specific method. Narrows `request.params`
73
+ * via {@link McpRequestParams}, `extra` via {@link McpExtraFor}, and the
74
+ * resolved value of `next()` via {@link McpResultFor}.
75
+ */
63
76
  export type McpTypedMiddlewareFn<M extends string> = (request: {
64
77
  method: M;
65
78
  params: McpRequestParams<M>;
@@ -1 +1 @@
1
- {"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/server/middleware.ts"],"names":[],"mappings":"AAyJA;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,MAAM,GAAG,GAAW,MAAM,CAAC;IAE3B,IACE,CAAC,CAAC,kBAAkB,IAAI,GAAG,IAAI,GAAG,CAAC,gBAAgB,YAAY,GAAG,CAAC;QACnE,CAAC,CACC,uBAAuB,IAAI,GAAG,IAAI,GAAG,CAAC,qBAAqB,YAAY,GAAG,CAC3E,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,eAAe,EAAE,GAAG,CAAC,gBAA8B;QACnD,oBAAoB,EAAE,GAAG,CAAC,qBAAmC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAc,EACd,MAAc,EACd,cAAuB;IAEvB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,cAAc,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAC9B,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAC3D,OAAO,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,KAAK,MAAM,CAAC;AAC3B,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAc,EACd,MAAkC,EAClC,cAAuB;IAEvB,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAC7B,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,cAAuB,EACvB,eAAyD,EACzD,OAA6B;IAE7B,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC1C,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CACvD,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAwC,CAAC;QAClE,4DAA4D;QAC5D,iEAAiE;QACjE,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAc,CAAC;QACjE,MAAM,UAAU,GAAG;YACjB,MAAM;YACN,MAAM,EAAG,UAAU,EAAE,MAAkC,IAAI,EAAE;SAC9D,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,MAAM,YAAY,GAAG,GAAqB,EAAE;YAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;gBACxC,CAAC;gBACD,OAAO,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC;YAClC,CAAC;YAED,IAAI,UAAU,GAAG,KAAK,CAAC;YAEvB,MAAM,IAAI,GAAG,GAAqB,EAAE;gBAClC,IAAI,UAAU,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,GAAG,CAC7D,CAAC;gBACJ,CAAC;gBACD,UAAU,GAAG,IAAI,CAAC;gBAClB,OAAO,YAAY,EAAE,CAAC;YACxB,CAAC,CAAC;YAEF,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QACjE,CAAC,CAAC;QAEF,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { Server } from \"@modelcontextprotocol/sdk/server/index.js\";\nimport type { RequestHandlerExtra } from \"@modelcontextprotocol/sdk/shared/protocol.js\";\nimport type {\n CallToolResult,\n CancelTaskResult,\n ClientNotification,\n ClientRequest,\n CompleteResult,\n EmptyResult,\n GetPromptResult,\n GetTaskPayloadResult,\n GetTaskResult,\n InitializeResult,\n ListPromptsResult,\n ListResourcesResult,\n ListResourceTemplatesResult,\n ListTasksResult,\n ListToolsResult,\n ReadResourceResult,\n ServerNotification,\n ServerRequest,\n ServerResult,\n} from \"@modelcontextprotocol/sdk/types.js\";\n\n/**\n * The `extra` context object provided by the MCP SDK to request handlers.\n */\nexport type McpExtra = RequestHandlerExtra<ServerRequest, ServerNotification>;\n\n/**\n * A single MCP middleware function following the onion model.\n * Call `next()` to invoke the next middleware or the final handler.\n * For notifications, `extra` is `undefined` (SDK does not provide extra context)\n * and `next()` resolves to `undefined`.\n */\nexport type McpMiddlewareFn = (\n request: { method: string; params: Record<string, unknown> },\n extra: McpExtra | undefined,\n next: () => Promise<unknown>,\n) => Promise<unknown> | unknown;\n\n/**\n * MCP methods the server handles (incoming from client).\n */\nexport type McpMethodString =\n | ClientRequest[\"method\"]\n | ClientNotification[\"method\"];\n\n/** Extract params type for a specific MCP method from SDK unions. */\nexport type McpRequestParams<M extends string> =\n Extract<ClientRequest, { method: M }> extends { params: infer P }\n ? P\n : Extract<ClientNotification, { method: M }> extends { params: infer P }\n ? P\n : Record<string, unknown>;\n\n/** Resolve extra type: McpExtra for requests, undefined for notifications. */\nexport type McpExtraFor<M extends string> = M extends ClientRequest[\"method\"]\n ? McpExtra\n : M extends ClientNotification[\"method\"]\n ? undefined\n : McpExtra | undefined;\n\n/** Maps each MCP request method to its SDK result type. */\ninterface McpResultMap {\n ping: EmptyResult;\n initialize: InitializeResult;\n \"tools/list\": ListToolsResult;\n \"tools/call\": CallToolResult;\n \"resources/list\": ListResourcesResult;\n \"resources/templates/list\": ListResourceTemplatesResult;\n \"resources/read\": ReadResourceResult;\n \"resources/subscribe\": EmptyResult;\n \"resources/unsubscribe\": EmptyResult;\n \"prompts/list\": ListPromptsResult;\n \"prompts/get\": GetPromptResult;\n \"completion/complete\": CompleteResult;\n \"logging/setLevel\": EmptyResult;\n \"tasks/get\": GetTaskResult;\n \"tasks/result\": GetTaskPayloadResult;\n \"tasks/list\": ListTasksResult;\n \"tasks/cancel\": CancelTaskResult;\n}\n\n/**\n * Map an MCP method string to its corresponding result type.\n * For request methods, resolves to the specific SDK result type.\n * For wildcard patterns (e.g. `\"tools/*\"`), resolves to the union of matching result types.\n * For notification methods, resolves to `undefined`.\n * For unknown/unmatched methods, falls back to `ServerResult`.\n */\nexport type McpResultFor<M extends string> = M extends keyof McpResultMap\n ? McpResultMap[M]\n : M extends `${infer Prefix}/*`\n ? [McpResultMap[keyof McpResultMap & `${Prefix}/${string}`]] extends [never]\n ? M extends ToWildcard<ClientNotification[\"method\"]>\n ? undefined\n : ServerResult\n : McpResultMap[keyof McpResultMap & `${Prefix}/${string}`]\n : M extends ClientNotification[\"method\"]\n ? undefined\n : ServerResult;\n\n/** Typed middleware fn for a specific method — narrows params, extra, and next() result. */\nexport type McpTypedMiddlewareFn<M extends string> = (\n request: { method: M; params: McpRequestParams<M> },\n extra: McpExtraFor<M>,\n next: () => Promise<McpResultFor<M>>,\n) => Promise<unknown> | unknown;\n\n/** Extracts `\"prefix/*\"` from `\"prefix/anything\"` — distributive over unions. */\ntype ToWildcard<T extends string> = T extends `${infer Prefix}/${string}`\n ? `${Prefix}/*`\n : never;\n\n/** Wildcard prefixes derived from method strings (e.g. `\"tools/*\"` from `\"tools/call\"`). */\nexport type McpWildcard = ToWildcard<McpMethodString>;\n\n/** Category keywords matching all requests or all notifications. */\ntype McpCategory = \"request\" | \"notification\";\n\n/**\n * A single filter pattern for MCP middleware:\n * - Exact method: `\"tools/call\"`\n * - Wildcard: `\"tools/*\"`\n * - Category: `\"request\"` | `\"notification\"`\n * - Escape hatch: arbitrary string via `string & {}`\n */\ntype McpMiddlewareFilterPattern =\n | McpMethodString\n | McpWildcard\n | McpCategory\n | (string & {});\n\n/**\n * Filter determining which MCP methods a middleware applies to.\n * A single pattern or an array of patterns (OR logic).\n */\nexport type McpMiddlewareFilter =\n | McpMiddlewareFilterPattern\n | McpMiddlewareFilterPattern[];\n\n/**\n * Internal entry stored for each registered middleware.\n * `filter: null` means catch-all (matches everything).\n */\nexport type McpMiddlewareEntry = {\n filter: McpMiddlewareFilter | null;\n handler: McpMiddlewareFn;\n};\n\ntype HandlerMap = Map<string, (...args: unknown[]) => Promise<unknown>>;\n\n/**\n * Extract the TS-private `_requestHandlers` and `_notificationHandlers` maps\n * from the SDK's `Server` (extends `Protocol`). These are runtime-accessible\n * but declared `private` in TypeScript.\n *\n * Validates with `instanceof Map` so an incompatible SDK version fails fast\n * instead of silently breaking.\n */\nexport function getHandlerMaps(server: Server) {\n const obj: object = server;\n\n if (\n !(\"_requestHandlers\" in obj && obj._requestHandlers instanceof Map) ||\n !(\n \"_notificationHandlers\" in obj && obj._notificationHandlers instanceof Map\n )\n ) {\n throw new Error(\n \"Incompatible MCP SDK version: expected _requestHandlers and _notificationHandlers on Server\",\n );\n }\n\n return {\n requestHandlers: obj._requestHandlers as HandlerMap,\n notificationHandlers: obj._notificationHandlers as HandlerMap,\n };\n}\n\n/**\n * Check if a single filter pattern matches a given method.\n *\n * - Exact: `\"tools/call\"` matches only `\"tools/call\"`\n * - Wildcard: `\"tools/*\"` matches any method starting with `\"tools/\"`\n * - Category `\"request\"`: matches when `isNotification` is false\n * - Category `\"notification\"`: matches when `isNotification` is true\n */\nexport function matchesFilter(\n method: string,\n filter: string,\n isNotification: boolean,\n): boolean {\n if (filter === \"request\") {\n return !isNotification;\n }\n if (filter === \"notification\") {\n return isNotification;\n }\n if (filter.endsWith(\"/*\")) {\n const prefix = filter.slice(0, -1); // \"tools/*\" → \"tools/\"\n return method.startsWith(prefix);\n }\n return method === filter;\n}\n\nfunction matchesAnyFilter(\n method: string,\n filter: McpMiddlewareFilter | null,\n isNotification: boolean,\n): boolean {\n if (filter === null) {\n return true;\n }\n if (typeof filter === \"string\") {\n return matchesFilter(method, filter, isNotification);\n }\n return filter.some((pattern) =>\n matchesFilter(method, pattern, isNotification),\n );\n}\n\n/**\n * Build an onion-model middleware chain for a specific method.\n *\n * Filters `entries` to those matching `method`, then composes them\n * so the first registered middleware is the outermost layer.\n * `next()` is guarded against multiple calls within a single middleware.\n */\nexport function buildMiddlewareChain(\n method: string,\n isNotification: boolean,\n originalHandler: (...args: unknown[]) => Promise<unknown>,\n entries: McpMiddlewareEntry[],\n) {\n const applicable = entries.filter((entry) =>\n matchesAnyFilter(method, entry.filter, isNotification),\n );\n\n if (applicable.length === 0) {\n return originalHandler;\n }\n\n return (...args: unknown[]) => {\n const rawRequest = args[0] as Record<string, unknown> | undefined;\n // SDK calls request handlers as handler(request, extra) but\n // notification handlers as handler(notification) — no extra arg.\n const extra = isNotification ? undefined : (args[1] as McpExtra);\n const mcpRequest = {\n method,\n params: (rawRequest?.params as Record<string, unknown>) ?? {},\n };\n\n let index = 0;\n\n const executeLayer = (): Promise<unknown> => {\n const entry = applicable[index++];\n if (!entry) {\n if (rawRequest) {\n rawRequest.params = mcpRequest.params;\n }\n return originalHandler(...args);\n }\n\n let nextCalled = false;\n\n const next = (): Promise<unknown> => {\n if (nextCalled) {\n throw new Error(\n `next() called multiple times in middleware for \"${method}\"`,\n );\n }\n nextCalled = true;\n return executeLayer();\n };\n\n return Promise.resolve(entry.handler(mcpRequest, extra, next));\n };\n\n return executeLayer();\n };\n}\n"]}
1
+ {"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/server/middleware.ts"],"names":[],"mappings":"AAsKA;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,MAAM,GAAG,GAAW,MAAM,CAAC;IAE3B,IACE,CAAC,CAAC,kBAAkB,IAAI,GAAG,IAAI,GAAG,CAAC,gBAAgB,YAAY,GAAG,CAAC;QACnE,CAAC,CACC,uBAAuB,IAAI,GAAG,IAAI,GAAG,CAAC,qBAAqB,YAAY,GAAG,CAC3E,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,eAAe,EAAE,GAAG,CAAC,gBAA8B;QACnD,oBAAoB,EAAE,GAAG,CAAC,qBAAmC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAc,EACd,MAAc,EACd,cAAuB;IAEvB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,CAAC,cAAc,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAC9B,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB;QAC3D,OAAO,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,KAAK,MAAM,CAAC;AAC3B,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAc,EACd,MAAkC,EAClC,cAAuB;IAEvB,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAC7B,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,cAAuB,EACvB,eAAyD,EACzD,OAA6B;IAE7B,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC1C,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CACvD,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAwC,CAAC;QAClE,4DAA4D;QAC5D,iEAAiE;QACjE,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAc,CAAC;QACjE,MAAM,UAAU,GAAG;YACjB,MAAM;YACN,MAAM,EAAG,UAAU,EAAE,MAAkC,IAAI,EAAE;SAC9D,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,MAAM,YAAY,GAAG,GAAqB,EAAE;YAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;gBACxC,CAAC;gBACD,OAAO,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC;YAClC,CAAC;YAED,IAAI,UAAU,GAAG,KAAK,CAAC;YAEvB,MAAM,IAAI,GAAG,GAAqB,EAAE;gBAClC,IAAI,UAAU,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,GAAG,CAC7D,CAAC;gBACJ,CAAC;gBACD,UAAU,GAAG,IAAI,CAAC;gBAClB,OAAO,YAAY,EAAE,CAAC;YACxB,CAAC,CAAC;YAEF,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QACjE,CAAC,CAAC;QAEF,OAAO,YAAY,EAAE,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { Server } from \"@modelcontextprotocol/sdk/server/index.js\";\nimport type { RequestHandlerExtra } from \"@modelcontextprotocol/sdk/shared/protocol.js\";\nimport type {\n CallToolResult,\n CancelTaskResult,\n ClientNotification,\n ClientRequest,\n CompleteResult,\n EmptyResult,\n GetPromptResult,\n GetTaskPayloadResult,\n GetTaskResult,\n InitializeResult,\n ListPromptsResult,\n ListResourcesResult,\n ListResourceTemplatesResult,\n ListTasksResult,\n ListToolsResult,\n ReadResourceResult,\n ServerNotification,\n ServerRequest,\n ServerResult,\n} from \"@modelcontextprotocol/sdk/types.js\";\n\n/**\n * The `extra` context object provided by the MCP SDK to request handlers.\n */\nexport type McpExtra = RequestHandlerExtra<ServerRequest, ServerNotification>;\n\n/**\n * A single MCP middleware function following the onion model.\n * Call `next()` to invoke the next middleware or the final handler.\n * For notifications, `extra` is `undefined` (SDK does not provide extra context)\n * and `next()` resolves to `undefined`.\n */\nexport type McpMiddlewareFn = (\n request: { method: string; params: Record<string, unknown> },\n extra: McpExtra | undefined,\n next: () => Promise<unknown>,\n) => Promise<unknown> | unknown;\n\n/**\n * MCP methods the server handles (incoming from client).\n */\nexport type McpMethodString =\n | ClientRequest[\"method\"]\n | ClientNotification[\"method\"];\n\n/**\n * Resolve the `params` type for a specific MCP method (request or notification)\n * from the SDK's typed unions. Falls back to `Record<string, unknown>` for\n * unknown methods. Used by {@link McpTypedMiddlewareFn} to narrow the request\n * shape in typed middleware.\n */\nexport type McpRequestParams<M extends string> =\n Extract<ClientRequest, { method: M }> extends { params: infer P }\n ? P\n : Extract<ClientNotification, { method: M }> extends { params: infer P }\n ? P\n : Record<string, unknown>;\n\n/**\n * Resolve the `extra` arg type for a specific MCP method: {@link McpExtra} for\n * request methods, `undefined` for notification methods (the SDK does not\n * pass extra context for notifications).\n */\nexport type McpExtraFor<M extends string> = M extends ClientRequest[\"method\"]\n ? McpExtra\n : M extends ClientNotification[\"method\"]\n ? undefined\n : McpExtra | undefined;\n\n/** Maps each MCP request method to its SDK result type. */\ninterface McpResultMap {\n ping: EmptyResult;\n initialize: InitializeResult;\n \"tools/list\": ListToolsResult;\n \"tools/call\": CallToolResult;\n \"resources/list\": ListResourcesResult;\n \"resources/templates/list\": ListResourceTemplatesResult;\n \"resources/read\": ReadResourceResult;\n \"resources/subscribe\": EmptyResult;\n \"resources/unsubscribe\": EmptyResult;\n \"prompts/list\": ListPromptsResult;\n \"prompts/get\": GetPromptResult;\n \"completion/complete\": CompleteResult;\n \"logging/setLevel\": EmptyResult;\n \"tasks/get\": GetTaskResult;\n \"tasks/result\": GetTaskPayloadResult;\n \"tasks/list\": ListTasksResult;\n \"tasks/cancel\": CancelTaskResult;\n}\n\n/**\n * Map an MCP method string to its corresponding result type.\n * For request methods, resolves to the specific SDK result type.\n * For wildcard patterns (e.g. `\"tools/*\"`), resolves to the union of matching result types.\n * For notification methods, resolves to `undefined`.\n * For unknown/unmatched methods, falls back to `ServerResult`.\n */\nexport type McpResultFor<M extends string> = M extends keyof McpResultMap\n ? McpResultMap[M]\n : M extends `${infer Prefix}/*`\n ? [McpResultMap[keyof McpResultMap & `${Prefix}/${string}`]] extends [never]\n ? M extends ToWildcard<ClientNotification[\"method\"]>\n ? undefined\n : ServerResult\n : McpResultMap[keyof McpResultMap & `${Prefix}/${string}`]\n : M extends ClientNotification[\"method\"]\n ? undefined\n : ServerResult;\n\n/**\n * Typed middleware function for a specific method. Narrows `request.params`\n * via {@link McpRequestParams}, `extra` via {@link McpExtraFor}, and the\n * resolved value of `next()` via {@link McpResultFor}.\n */\nexport type McpTypedMiddlewareFn<M extends string> = (\n request: { method: M; params: McpRequestParams<M> },\n extra: McpExtraFor<M>,\n next: () => Promise<McpResultFor<M>>,\n) => Promise<unknown> | unknown;\n\n/** Extracts `\"prefix/*\"` from `\"prefix/anything\"` — distributive over unions. */\ntype ToWildcard<T extends string> = T extends `${infer Prefix}/${string}`\n ? `${Prefix}/*`\n : never;\n\n/** Wildcard prefixes derived from method strings (e.g. `\"tools/*\"` from `\"tools/call\"`). */\nexport type McpWildcard = ToWildcard<McpMethodString>;\n\n/** Category keywords matching all requests or all notifications. */\ntype McpCategory = \"request\" | \"notification\";\n\n/**\n * A single filter pattern for MCP middleware:\n * - Exact method: `\"tools/call\"`\n * - Wildcard: `\"tools/*\"`\n * - Category: `\"request\"` | `\"notification\"`\n * - Escape hatch: arbitrary string via `string & {}`\n */\ntype McpMiddlewareFilterPattern =\n | McpMethodString\n | McpWildcard\n | McpCategory\n | (string & {});\n\n/**\n * Filter determining which MCP methods a middleware applies to.\n * A single pattern or an array of patterns (OR logic).\n */\nexport type McpMiddlewareFilter =\n | McpMiddlewareFilterPattern\n | McpMiddlewareFilterPattern[];\n\n/**\n * Internal entry stored for each registered middleware.\n * `filter: null` means catch-all (matches everything).\n */\nexport type McpMiddlewareEntry = {\n filter: McpMiddlewareFilter | null;\n handler: McpMiddlewareFn;\n};\n\ntype HandlerMap = Map<string, (...args: unknown[]) => Promise<unknown>>;\n\n/**\n * Extract the TS-private `_requestHandlers` and `_notificationHandlers` maps\n * from the SDK's `Server` (extends `Protocol`). These are runtime-accessible\n * but declared `private` in TypeScript.\n *\n * Validates with `instanceof Map` so an incompatible SDK version fails fast\n * instead of silently breaking.\n */\nexport function getHandlerMaps(server: Server) {\n const obj: object = server;\n\n if (\n !(\"_requestHandlers\" in obj && obj._requestHandlers instanceof Map) ||\n !(\n \"_notificationHandlers\" in obj && obj._notificationHandlers instanceof Map\n )\n ) {\n throw new Error(\n \"Incompatible MCP SDK version: expected _requestHandlers and _notificationHandlers on Server\",\n );\n }\n\n return {\n requestHandlers: obj._requestHandlers as HandlerMap,\n notificationHandlers: obj._notificationHandlers as HandlerMap,\n };\n}\n\n/**\n * Check if a single filter pattern matches a given method.\n *\n * - Exact: `\"tools/call\"` matches only `\"tools/call\"`\n * - Wildcard: `\"tools/*\"` matches any method starting with `\"tools/\"`\n * - Category `\"request\"`: matches when `isNotification` is false\n * - Category `\"notification\"`: matches when `isNotification` is true\n */\nexport function matchesFilter(\n method: string,\n filter: string,\n isNotification: boolean,\n): boolean {\n if (filter === \"request\") {\n return !isNotification;\n }\n if (filter === \"notification\") {\n return isNotification;\n }\n if (filter.endsWith(\"/*\")) {\n const prefix = filter.slice(0, -1); // \"tools/*\" → \"tools/\"\n return method.startsWith(prefix);\n }\n return method === filter;\n}\n\nfunction matchesAnyFilter(\n method: string,\n filter: McpMiddlewareFilter | null,\n isNotification: boolean,\n): boolean {\n if (filter === null) {\n return true;\n }\n if (typeof filter === \"string\") {\n return matchesFilter(method, filter, isNotification);\n }\n return filter.some((pattern) =>\n matchesFilter(method, pattern, isNotification),\n );\n}\n\n/**\n * Build an onion-model middleware chain for a specific method.\n *\n * Filters `entries` to those matching `method`, then composes them\n * so the first registered middleware is the outermost layer.\n * `next()` is guarded against multiple calls within a single middleware.\n */\nexport function buildMiddlewareChain(\n method: string,\n isNotification: boolean,\n originalHandler: (...args: unknown[]) => Promise<unknown>,\n entries: McpMiddlewareEntry[],\n) {\n const applicable = entries.filter((entry) =>\n matchesAnyFilter(method, entry.filter, isNotification),\n );\n\n if (applicable.length === 0) {\n return originalHandler;\n }\n\n return (...args: unknown[]) => {\n const rawRequest = args[0] as Record<string, unknown> | undefined;\n // SDK calls request handlers as handler(request, extra) but\n // notification handlers as handler(notification) — no extra arg.\n const extra = isNotification ? undefined : (args[1] as McpExtra);\n const mcpRequest = {\n method,\n params: (rawRequest?.params as Record<string, unknown>) ?? {},\n };\n\n let index = 0;\n\n const executeLayer = (): Promise<unknown> => {\n const entry = applicable[index++];\n if (!entry) {\n if (rawRequest) {\n rawRequest.params = mcpRequest.params;\n }\n return originalHandler(...args);\n }\n\n let nextCalled = false;\n\n const next = (): Promise<unknown> => {\n if (nextCalled) {\n throw new Error(\n `next() called multiple times in middleware for \"${method}\"`,\n );\n }\n nextCalled = true;\n return executeLayer();\n };\n\n return Promise.resolve(entry.handler(mcpRequest, extra, next));\n };\n\n return executeLayer();\n };\n}\n"]}
@@ -6,12 +6,25 @@ import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/proto
6
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,6 +141,14 @@ 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
  }
92
154
  /**
@@ -126,10 +188,45 @@ type ToolHandler<TInput extends ZodRawShapeCompat, TReturn extends {
126
188
  } = {
127
189
  content?: HandlerContent;
128
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
+ */
129
197
  export declare function normalizeContent(content: HandlerContent | undefined): ContentBlock[];
130
198
  interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "connect"> {
131
199
  }
132
200
  declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof McpServerBase>) => McpServerBaseOmitted;
201
+ /**
202
+ * The Skybridge server. Extends the MCP SDK's `McpServer` with a typed tool
203
+ * registry, view resources, an embedded Express app, and protocol-level
204
+ * middleware. Construct it with the same `Implementation` info you would pass
205
+ * to the SDK, chain {@link McpServer.registerTool} calls to declare tools,
206
+ * then call {@link McpServer.run} to start the HTTP server.
207
+ *
208
+ * The `TTools` generic accumulates each registered tool's input/output/meta
209
+ * shape, so `typeof server` carries enough information for view-side helpers
210
+ * like {@link generateHelpers} to produce fully-typed hooks.
211
+ *
212
+ * @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
213
+ * chaining; you almost never set this manually.
214
+ *
215
+ * @example
216
+ * ```ts
217
+ * const server = new McpServer({ name: "my-app", version: "1.0.0" }, {})
218
+ * .registerTool({
219
+ * name: "search",
220
+ * inputSchema: { query: z.string() },
221
+ * view: { component: "search" },
222
+ * }, async ({ query }) => ({ content: `Results for ${query}` }));
223
+ *
224
+ * await server.run();
225
+ * export type AppType = typeof server;
226
+ * ```
227
+ *
228
+ * @see https://docs.skybridge.tech/api-reference/mcp-server
229
+ */
133
230
  export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>> extends McpServerBaseOmitted {
134
231
  readonly $types: McpServerTypes<TTools>;
135
232
  /**
@@ -149,12 +246,34 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
149
246
  private mcpMiddlewareEntries;
150
247
  private mcpMiddlewareApplied;
151
248
  private claimedViews;
249
+ private viewMetaBuilders;
152
250
  private viteManifest;
153
251
  private readonly serverInfo;
154
252
  private readonly serverOptions?;
155
253
  constructor(serverInfo: Implementation, options?: ServerOptions);
254
+ /**
255
+ * Register Express middleware on the underlying app. Mirrors `app.use` —
256
+ * pass handlers directly or a path-prefixed handler list. Register before
257
+ * {@link McpServer.run}; ordering matches Express.
258
+ *
259
+ * Note: Alpic Cloud only routes traffic to `/mcp`. Custom paths work
260
+ * locally and on self-hosted deployments.
261
+ */
156
262
  use(...handlers: RequestHandler[]): this;
157
263
  use(path: string, ...handlers: RequestHandler[]): this;
264
+ /**
265
+ * Register Express error-handling middleware to run after the built-in
266
+ * `/mcp` route (or your custom route). Use this to log or transform errors
267
+ * thrown by tool handlers before the default error handler responds.
268
+ *
269
+ * @example
270
+ * ```ts
271
+ * server.useOnError((err, _req, _res, next) => {
272
+ * logger.error(err);
273
+ * next(err);
274
+ * });
275
+ * ```
276
+ */
158
277
  useOnError(...handlers: ErrorRequestHandler[]): this;
159
278
  useOnError(path: string, ...handlers: ErrorRequestHandler[]): this;
160
279
  /** Register MCP protocol-level middleware (catch-all). */
@@ -189,6 +308,14 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
189
308
  */
190
309
  mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
191
310
  private applyMcpMiddleware;
311
+ /**
312
+ * Connect to an MCP transport (override of the SDK's `connect`). Use this
313
+ * when you're embedding Skybridge in a host that already manages its own
314
+ * transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
315
+ * which sets the transport up for you. Locks in any middleware registered
316
+ * via {@link McpServer.mcpMiddleware} — further calls to that method will
317
+ * throw afterwards.
318
+ */
192
319
  connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
193
320
  /**
194
321
  * Per-request stateless connect. The SDK's `Protocol` only allows one
@@ -201,10 +328,21 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
201
328
  * read side and fails fast on SDK field renames.
202
329
  */
203
330
  connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
331
+ /**
332
+ * Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
333
+ * mounts the `/mcp` route, applies any custom Express middleware registered
334
+ * via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
335
+ * any MCP middleware registered via {@link McpServer.mcpMiddleware}.
336
+ *
337
+ * On Cloudflare Workers / workerd, returns an object exposing `fetch` so
338
+ * the runtime can bridge incoming requests to the Node HTTP server. On
339
+ * Node, returns `undefined` once listening.
340
+ */
204
341
  run(): Promise<{
205
342
  fetch: (...args: unknown[]) => unknown;
206
343
  } | undefined>;
207
344
  private enforceOneToolPerView;
345
+ private resolveViewRequestContext;
208
346
  private registerViewResources;
209
347
  private registerViewResource;
210
348
  private wrapHandler;
@@ -221,6 +359,35 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
221
359
  file: string;
222
360
  }>): this;
223
361
  private readManifest;
362
+ /**
363
+ * Register a tool. Pass a `config` describing the tool (name, schemas,
364
+ * optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
365
+ * returns the tool's result.
366
+ *
367
+ * Chain calls to build up a server: each call returns a new `McpServer`
368
+ * type that captures the tool's input/output/`_meta` shape so the
369
+ * resulting `typeof server` can drive {@link generateHelpers}.
370
+ *
371
+ * The handler's return shape determines the output types: the
372
+ * `structuredContent` field becomes the tool's typed output, and `_meta`
373
+ * becomes its `responseMetadata`. The `content` field is normalized through
374
+ * {@link normalizeContent}.
375
+ *
376
+ * @example
377
+ * ```ts
378
+ * server.registerTool({
379
+ * name: "search",
380
+ * inputSchema: { query: z.string() },
381
+ * outputSchema: { results: z.array(z.string()) },
382
+ * view: { component: "search" },
383
+ * }, async ({ query }) => ({
384
+ * content: `Found results for ${query}`,
385
+ * structuredContent: { results: [...] },
386
+ * }));
387
+ * ```
388
+ *
389
+ * @see https://docs.skybridge.tech/api-reference/register-tool
390
+ */
224
391
  registerTool<TName extends string, InputArgs extends ZodRawShapeCompat, TReturn extends {
225
392
  content?: HandlerContent;
226
393
  }>(config: ToolConfig<InputArgs> & {