skybridge 0.0.0-dev.e7f0f8e → 0.0.0-dev.e8131c6

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 (225) hide show
  1. package/README.md +123 -124
  2. package/dist/cli/build-helpers.d.ts +7 -0
  3. package/dist/cli/build-helpers.js +82 -0
  4. package/dist/cli/build-helpers.js.map +1 -0
  5. package/dist/cli/build-helpers.test.d.ts +1 -0
  6. package/dist/cli/build-helpers.test.js +64 -0
  7. package/dist/cli/build-helpers.test.js.map +1 -0
  8. package/dist/cli/detect-port.d.ts +2 -2
  9. package/dist/cli/detect-port.js +9 -20
  10. package/dist/cli/detect-port.js.map +1 -1
  11. package/dist/cli/resolve-views-dir.d.ts +1 -0
  12. package/dist/cli/resolve-views-dir.js +17 -0
  13. package/dist/cli/resolve-views-dir.js.map +1 -0
  14. package/dist/cli/use-typescript-check.js +1 -1
  15. package/dist/cli/use-typescript-check.js.map +1 -1
  16. package/dist/commands/build.d.ts +0 -1
  17. package/dist/commands/build.js +18 -30
  18. package/dist/commands/build.js.map +1 -1
  19. package/dist/commands/create.d.ts +9 -0
  20. package/dist/commands/create.js +30 -0
  21. package/dist/commands/create.js.map +1 -0
  22. package/dist/commands/dev.js +16 -0
  23. package/dist/commands/dev.js.map +1 -1
  24. package/dist/commands/start.js +7 -1
  25. package/dist/commands/start.js.map +1 -1
  26. package/dist/server/asset-base-url-transform-plugin.d.ts +1 -0
  27. package/dist/server/asset-base-url-transform-plugin.js +16 -1
  28. package/dist/server/asset-base-url-transform-plugin.js.map +1 -1
  29. package/dist/server/asset-base-url-transform-plugin.test.js +51 -1
  30. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -1
  31. package/dist/server/auth/discovery.d.ts +32 -0
  32. package/dist/server/auth/discovery.js +56 -0
  33. package/dist/server/auth/discovery.js.map +1 -0
  34. package/dist/server/auth/discovery.test.d.ts +1 -0
  35. package/dist/server/auth/discovery.test.js +93 -0
  36. package/dist/server/auth/discovery.test.js.map +1 -0
  37. package/dist/server/auth/index.d.ts +18 -0
  38. package/dist/server/auth/index.js +2 -0
  39. package/dist/server/auth/index.js.map +1 -0
  40. package/dist/server/auth/providers/auth0.d.ts +13 -0
  41. package/dist/server/auth/providers/auth0.js +31 -0
  42. package/dist/server/auth/providers/auth0.js.map +1 -0
  43. package/dist/server/auth/providers/auth0.test.d.ts +1 -0
  44. package/dist/server/auth/providers/auth0.test.js +32 -0
  45. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  46. package/dist/server/auth/providers/clerk.d.ts +14 -0
  47. package/dist/server/auth/providers/clerk.js +16 -0
  48. package/dist/server/auth/providers/clerk.js.map +1 -0
  49. package/dist/server/auth/providers/clerk.test.d.ts +1 -0
  50. package/dist/server/auth/providers/clerk.test.js +28 -0
  51. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  52. package/dist/server/auth/providers/custom.d.ts +17 -0
  53. package/dist/server/auth/providers/custom.js +28 -0
  54. package/dist/server/auth/providers/custom.js.map +1 -0
  55. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  56. package/dist/server/auth/providers/custom.test.js +91 -0
  57. package/dist/server/auth/providers/custom.test.js.map +1 -0
  58. package/dist/server/auth/providers/descope.d.ts +13 -0
  59. package/dist/server/auth/providers/descope.js +31 -0
  60. package/dist/server/auth/providers/descope.js.map +1 -0
  61. package/dist/server/auth/providers/descope.test.d.ts +1 -0
  62. package/dist/server/auth/providers/descope.test.js +37 -0
  63. package/dist/server/auth/providers/descope.test.js.map +1 -0
  64. package/dist/server/auth/providers/shared.d.ts +2 -0
  65. package/dist/server/auth/providers/shared.js +6 -0
  66. package/dist/server/auth/providers/shared.js.map +1 -0
  67. package/dist/server/auth/providers/shared.test.d.ts +1 -0
  68. package/dist/server/auth/providers/shared.test.js +10 -0
  69. package/dist/server/auth/providers/shared.test.js.map +1 -0
  70. package/dist/server/auth/providers/stytch.d.ts +12 -0
  71. package/dist/server/auth/providers/stytch.js +13 -0
  72. package/dist/server/auth/providers/stytch.js.map +1 -0
  73. package/dist/server/auth/providers/workos.d.ts +11 -0
  74. package/dist/server/auth/providers/workos.js +12 -0
  75. package/dist/server/auth/providers/workos.js.map +1 -0
  76. package/dist/server/auth/setup.d.ts +4 -0
  77. package/dist/server/auth/setup.js +51 -0
  78. package/dist/server/auth/setup.js.map +1 -0
  79. package/dist/server/auth/setup.test.d.ts +1 -0
  80. package/dist/server/auth/setup.test.js +185 -0
  81. package/dist/server/auth/setup.test.js.map +1 -0
  82. package/dist/server/auth/verify.d.ts +12 -0
  83. package/dist/server/auth/verify.js +38 -0
  84. package/dist/server/auth/verify.js.map +1 -0
  85. package/dist/server/auth/verify.test.d.ts +1 -0
  86. package/dist/server/auth/verify.test.js +100 -0
  87. package/dist/server/auth/verify.test.js.map +1 -0
  88. package/dist/server/auth.d.ts +20 -0
  89. package/dist/server/auth.js +28 -0
  90. package/dist/server/auth.js.map +1 -0
  91. package/dist/server/build-manifest.test.d.ts +1 -0
  92. package/dist/server/build-manifest.test.js +27 -0
  93. package/dist/server/build-manifest.test.js.map +1 -0
  94. package/dist/server/content-helpers.d.ts +40 -0
  95. package/dist/server/content-helpers.js +33 -0
  96. package/dist/server/content-helpers.js.map +1 -1
  97. package/dist/server/express.test.js +61 -0
  98. package/dist/server/express.test.js.map +1 -1
  99. package/dist/server/file-ref.d.ts +20 -0
  100. package/dist/server/file-ref.js +19 -0
  101. package/dist/server/file-ref.js.map +1 -1
  102. package/dist/server/index.d.ts +10 -2
  103. package/dist/server/index.js +8 -1
  104. package/dist/server/index.js.map +1 -1
  105. package/dist/server/middleware.d.ts +16 -3
  106. package/dist/server/middleware.js.map +1 -1
  107. package/dist/server/requestOrigin.d.ts +7 -0
  108. package/dist/server/requestOrigin.js +25 -0
  109. package/dist/server/requestOrigin.js.map +1 -0
  110. package/dist/server/server.d.ts +213 -6
  111. package/dist/server/server.js +235 -62
  112. package/dist/server/server.js.map +1 -1
  113. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  114. package/dist/server/view-resource-resolution.test.js +88 -0
  115. package/dist/server/view-resource-resolution.test.js.map +1 -0
  116. package/dist/test/view.test.js +45 -0
  117. package/dist/test/view.test.js.map +1 -1
  118. package/dist/web/bridges/apps-sdk/adaptor.d.ts +4 -1
  119. package/dist/web/bridges/apps-sdk/adaptor.js +16 -1
  120. package/dist/web/bridges/apps-sdk/adaptor.js.map +1 -1
  121. package/dist/web/bridges/apps-sdk/bridge.d.ts +1 -0
  122. package/dist/web/bridges/apps-sdk/bridge.js +1 -0
  123. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  124. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  125. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  126. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  127. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  128. package/dist/web/bridges/get-adaptor.js +7 -0
  129. package/dist/web/bridges/get-adaptor.js.map +1 -1
  130. package/dist/web/bridges/mcp-app/adaptor.d.ts +4 -1
  131. package/dist/web/bridges/mcp-app/adaptor.js +12 -0
  132. package/dist/web/bridges/mcp-app/adaptor.js.map +1 -1
  133. package/dist/web/bridges/mcp-app/bridge.d.ts +4 -2
  134. package/dist/web/bridges/mcp-app/bridge.js +23 -1
  135. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  136. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +12 -0
  137. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +12 -0
  138. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  139. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  140. package/dist/web/bridges/mcp-app/view-tools.test.js +144 -0
  141. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  142. package/dist/web/bridges/types.d.ts +88 -1
  143. package/dist/web/bridges/types.js.map +1 -1
  144. package/dist/web/bridges/use-host-context.d.ts +5 -0
  145. package/dist/web/bridges/use-host-context.js +5 -0
  146. package/dist/web/bridges/use-host-context.js.map +1 -1
  147. package/dist/web/create-store.d.ts +26 -0
  148. package/dist/web/create-store.js +26 -0
  149. package/dist/web/create-store.js.map +1 -1
  150. package/dist/web/data-llm.d.ts +33 -0
  151. package/dist/web/data-llm.js +28 -0
  152. package/dist/web/data-llm.js.map +1 -1
  153. package/dist/web/generate-helpers.d.ts +2 -0
  154. package/dist/web/generate-helpers.js +2 -0
  155. package/dist/web/generate-helpers.js.map +1 -1
  156. package/dist/web/generate-helpers.test-d.js +4 -2
  157. package/dist/web/generate-helpers.test-d.js.map +1 -1
  158. package/dist/web/hooks/index.d.ts +2 -0
  159. package/dist/web/hooks/index.js +2 -0
  160. package/dist/web/hooks/index.js.map +1 -1
  161. package/dist/web/hooks/test/utils.d.ts +6 -2
  162. package/dist/web/hooks/test/utils.js +13 -2
  163. package/dist/web/hooks/test/utils.js.map +1 -1
  164. package/dist/web/hooks/use-call-tool.d.ts +45 -0
  165. package/dist/web/hooks/use-call-tool.js +28 -0
  166. package/dist/web/hooks/use-call-tool.js.map +1 -1
  167. package/dist/web/hooks/use-call-tool.test.js +27 -2
  168. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  169. package/dist/web/hooks/use-display-mode.d.ts +20 -0
  170. package/dist/web/hooks/use-display-mode.js +20 -0
  171. package/dist/web/hooks/use-display-mode.js.map +1 -1
  172. package/dist/web/hooks/use-download.d.ts +5 -0
  173. package/dist/web/hooks/use-download.js +8 -0
  174. package/dist/web/hooks/use-download.js.map +1 -0
  175. package/dist/web/hooks/use-download.test.d.ts +1 -0
  176. package/dist/web/hooks/use-download.test.js +95 -0
  177. package/dist/web/hooks/use-download.test.js.map +1 -0
  178. package/dist/web/hooks/use-files.d.ts +32 -0
  179. package/dist/web/hooks/use-files.js +32 -0
  180. package/dist/web/hooks/use-files.js.map +1 -1
  181. package/dist/web/hooks/use-layout.d.ts +2 -0
  182. package/dist/web/hooks/use-layout.js +2 -0
  183. package/dist/web/hooks/use-layout.js.map +1 -1
  184. package/dist/web/hooks/use-open-external.d.ts +17 -0
  185. package/dist/web/hooks/use-open-external.js +16 -0
  186. package/dist/web/hooks/use-open-external.js.map +1 -1
  187. package/dist/web/hooks/use-register-view-tool.d.ts +38 -0
  188. package/dist/web/hooks/use-register-view-tool.js +50 -0
  189. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  190. package/dist/web/hooks/use-request-close.d.ts +14 -0
  191. package/dist/web/hooks/use-request-close.js +13 -0
  192. package/dist/web/hooks/use-request-close.js.map +1 -1
  193. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  194. package/dist/web/hooks/use-request-modal.js +16 -1
  195. package/dist/web/hooks/use-request-modal.js.map +1 -1
  196. package/dist/web/hooks/use-request-size.d.ts +17 -0
  197. package/dist/web/hooks/use-request-size.js +16 -0
  198. package/dist/web/hooks/use-request-size.js.map +1 -1
  199. package/dist/web/hooks/use-send-follow-up-message.d.ts +17 -0
  200. package/dist/web/hooks/use-send-follow-up-message.js +17 -0
  201. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  202. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  203. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  204. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  205. package/dist/web/hooks/use-tool-info.d.ts +53 -2
  206. package/dist/web/hooks/use-tool-info.js +30 -7
  207. package/dist/web/hooks/use-tool-info.js.map +1 -1
  208. package/dist/web/hooks/use-tool-info.test-d.js +11 -29
  209. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  210. package/dist/web/hooks/use-tool-info.test.js +5 -5
  211. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  212. package/dist/web/hooks/use-user.d.ts +2 -0
  213. package/dist/web/hooks/use-user.js +2 -0
  214. package/dist/web/hooks/use-user.js.map +1 -1
  215. package/dist/web/hooks/use-view-state.d.ts +21 -0
  216. package/dist/web/hooks/use-view-state.js.map +1 -1
  217. package/dist/web/mount-view.d.ts +19 -0
  218. package/dist/web/mount-view.js +19 -0
  219. package/dist/web/mount-view.js.map +1 -1
  220. package/dist/web/plugin/plugin.d.ts +28 -0
  221. package/dist/web/plugin/plugin.js +26 -0
  222. package/dist/web/plugin/plugin.js.map +1 -1
  223. package/dist/web/types.d.ts +4 -0
  224. package/dist/web/types.js.map +1 -1
  225. package/package.json +10 -3
@@ -1,7 +1,15 @@
1
+ export type { OAuthConfig } from "./auth/index.js";
2
+ export { auth0Provider } from "./auth/providers/auth0.js";
3
+ export { clerkProvider } from "./auth/providers/clerk.js";
4
+ export { customProvider } from "./auth/providers/custom.js";
5
+ export { descopeProvider } from "./auth/providers/descope.js";
6
+ export { stytchProvider } from "./auth/providers/stytch.js";
7
+ export { workosProvider } from "./auth/providers/workos.js";
8
+ export { type AuthInfo, type AuthMetadataOptions, type BearerAuthMiddlewareOptions, InvalidTokenError, mcpAuthMetadataRouter, optionalBearerAuth, requireBearerAuth, } from "./auth.js";
1
9
  export { audio, embeddedResource, image, resourceLink, text, } from "./content-helpers.js";
2
10
  export { FileRef } from "./file-ref.js";
3
11
  export type { AnyToolRegistry, InferTools, ToolInput, ToolNames, ToolOutput, ToolResponseMetadata, } from "./inferUtilityTypes.js";
4
12
  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 { McpServer, normalizeContent, } from "./server.js";
13
+ export type { HandlerContent, JsonOptions, KnownToolMeta, McpServerTypes, SecurityScheme, SkybridgeServerOptions, ToolDef, ToolMeta, ViewConfig, ViewCsp, ViewHostType, ViewName, ViewNameRegistry, } from "./server.js";
14
+ export { __setBuildManifest, McpServer, normalizeContent, } from "./server.js";
7
15
  export { viewsDevServer } from "./viewsDevServer.js";
@@ -1,5 +1,12 @@
1
+ export { auth0Provider } from "./auth/providers/auth0.js";
2
+ export { clerkProvider } from "./auth/providers/clerk.js";
3
+ export { customProvider } from "./auth/providers/custom.js";
4
+ export { descopeProvider } from "./auth/providers/descope.js";
5
+ export { stytchProvider } from "./auth/providers/stytch.js";
6
+ export { workosProvider } from "./auth/providers/workos.js";
7
+ export { InvalidTokenError, mcpAuthMetadataRouter, optionalBearerAuth, requireBearerAuth, } from "./auth.js";
1
8
  export { audio, embeddedResource, image, resourceLink, text, } from "./content-helpers.js";
2
9
  export { FileRef } from "./file-ref.js";
3
- export { McpServer, normalizeContent, } from "./server.js";
10
+ export { __setBuildManifest, McpServer, normalizeContent, } from "./server.js";
4
11
  export { viewsDevServer } from "./viewsDevServer.js";
5
12
  //# sourceMappingURL=index.js.map
@@ -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":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,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;AAiCxC,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export type { OAuthConfig } from \"./auth/index.js\";\nexport { auth0Provider } from \"./auth/providers/auth0.js\";\nexport { clerkProvider } from \"./auth/providers/clerk.js\";\nexport { customProvider } from \"./auth/providers/custom.js\";\nexport { descopeProvider } from \"./auth/providers/descope.js\";\nexport { stytchProvider } from \"./auth/providers/stytch.js\";\nexport { workosProvider } from \"./auth/providers/workos.js\";\nexport {\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 JsonOptions,\n KnownToolMeta,\n McpServerTypes,\n SecurityScheme,\n SkybridgeServerOptions,\n ToolDef,\n ToolMeta,\n ViewConfig,\n ViewCsp,\n ViewHostType,\n ViewName,\n ViewNameRegistry,\n} from \"./server.js\";\nexport {\n __setBuildManifest,\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"]}
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Resolves this server's public origin from request headers, in precedence
3
+ * `x-forwarded-host` → `host` → localhost dev fallback. Shared by view serving
4
+ * and OAuth metadata so the two can't drift. `Origin` is deliberately ignored:
5
+ * it carries the *caller's* site, not this server's.
6
+ */
7
+ export declare function resolveServerOrigin(header: (key: string) => string | undefined): string;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Resolves this server's public origin from request headers, in precedence
3
+ * `x-forwarded-host` → `host` → localhost dev fallback. Shared by view serving
4
+ * and OAuth metadata so the two can't drift. `Origin` is deliberately ignored:
5
+ * it carries the *caller's* site, not this server's.
6
+ */
7
+ export function resolveServerOrigin(header) {
8
+ // Proxies may send X-Forwarded-* as a comma-separated chain; the client-facing
9
+ // hop is the first entry.
10
+ const firstHop = (value) => value?.split(",")[0]?.trim();
11
+ const forwardedHost = firstHop(header("x-forwarded-host"));
12
+ if (forwardedHost) {
13
+ const proto = firstHop(header("x-forwarded-proto")) || "https";
14
+ return `${proto}://${forwardedHost}`;
15
+ }
16
+ const host = header("host");
17
+ if (host) {
18
+ const proto = ["127.0.0.1:", "localhost:"].some((p) => host.startsWith(p))
19
+ ? "http"
20
+ : "https";
21
+ return `${proto}://${host}`;
22
+ }
23
+ return `http://localhost:${process.env.__PORT || "3000"}`;
24
+ }
25
+ //# sourceMappingURL=requestOrigin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requestOrigin.js","sourceRoot":"","sources":["../../src/server/requestOrigin.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAA2C;IAE3C,+EAA+E;IAC/E,0BAA0B;IAC1B,MAAM,QAAQ,GAAG,CAAC,KAAyB,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;IAC7E,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3D,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,OAAO,CAAC;QAC/D,OAAO,GAAG,KAAK,MAAM,aAAa,EAAE,CAAC;IACvC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,KAAK,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACxE,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,OAAO,CAAC;QACZ,OAAO,GAAG,KAAK,MAAM,IAAI,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,oBAAoB,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;AAC5D,CAAC","sourcesContent":["/**\n * Resolves this server's public origin from request headers, in precedence\n * `x-forwarded-host` → `host` → localhost dev fallback. Shared by view serving\n * and OAuth metadata so the two can't drift. `Origin` is deliberately ignored:\n * it carries the *caller's* site, not this server's.\n */\nexport function resolveServerOrigin(\n header: (key: string) => string | undefined,\n): string {\n // Proxies may send X-Forwarded-* as a comma-separated chain; the client-facing\n // hop is the first entry.\n const firstHop = (value: string | undefined) => value?.split(\",\")[0]?.trim();\n const forwardedHost = firstHop(header(\"x-forwarded-host\"));\n if (forwardedHost) {\n const proto = firstHop(header(\"x-forwarded-proto\")) || \"https\";\n return `${proto}://${forwardedHost}`;\n }\n const host = header(\"host\");\n if (host) {\n const proto = [\"127.0.0.1:\", \"localhost:\"].some((p) => host.startsWith(p))\n ? \"http\"\n : \"https\";\n return `${proto}://${host}`;\n }\n return `http://localhost:${process.env.__PORT || \"3000\"}`;\n}\n"]}
@@ -1,16 +1,31 @@
1
+ import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
1
2
  import { type ServerOptions } from "@modelcontextprotocol/sdk/server/index.js";
2
3
  import { McpServer as McpServerBase } from "@modelcontextprotocol/sdk/server/mcp.js";
3
4
  import type { AnySchema, SchemaOutput, ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
4
5
  import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
5
- import type { ContentBlock, Implementation, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
6
- import { type ErrorRequestHandler, type Express, type RequestHandler } from "express";
6
+ import type { ContentBlock, Implementation, RequestMeta, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
7
+ import express, { type ErrorRequestHandler, type Express, type RequestHandler } from "express";
8
+ import type { OAuthConfig } from "./auth/index.js";
7
9
  import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
10
+ /**
11
+ * Type marker for a registered tool — carries its input, output, and response
12
+ * metadata shapes so views can infer types from `typeof server`.
13
+ *
14
+ * You normally never construct this by hand; it is produced by `registerTool`
15
+ * and consumed by helpers like {@link InferTools} and {@link generateHelpers}.
16
+ */
8
17
  export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unknown> = {
9
18
  input: TInput;
10
19
  output: TOutput;
11
20
  responseMetadata: TResponseMetadata;
12
21
  };
22
+ /** Which host runtime a view targets — `"apps-sdk"` (ChatGPT) or `"mcp-app"` (MCP Apps spec). */
13
23
  export type ViewHostType = "apps-sdk" | "mcp-app";
24
+ /**
25
+ * Content Security Policy origins attached to a view's resource. Each list is
26
+ * passed through to the host's CSP for the view iframe; omit a field to inherit
27
+ * the host's default for that directive.
28
+ */
14
29
  export interface ViewCsp {
15
30
  /** Origins for static assets (images, fonts, scripts, styles). */
16
31
  resourceDomains?: string[];
@@ -23,24 +38,79 @@ export interface ViewCsp {
23
38
  /** Origins allowed in `<base href>` tags (mcp-apps only). */
24
39
  baseUriDomains?: string[];
25
40
  }
41
+ /**
42
+ * Registry of view component names. The Skybridge Vite plugin augments this
43
+ * interface in the generated `.skybridge/views.d.ts` with one key per view
44
+ * file, which narrows {@link ViewName} from `string` to the concrete union.
45
+ */
26
46
  export interface ViewNameRegistry {
27
47
  }
48
+ /** Union of valid view component names. Narrowed by {@link ViewNameRegistry}. */
28
49
  export type ViewName = keyof ViewNameRegistry & string;
50
+ /**
51
+ * Pass under `view` in a tool's `registerTool` config to render the tool's
52
+ * result through a Skybridge view instead of a plain text response.
53
+ */
29
54
  export interface ViewConfig {
55
+ /** Filename of the view module (without extension) — matches a file in your `viewsDir`. */
30
56
  component: ViewName;
57
+ /** Human-readable label the host may show alongside the view. */
31
58
  description?: string;
59
+ /** Restrict where the view is rendered. Defaults to all known hosts. */
32
60
  hosts?: ViewHostType[];
61
+ /** Apps SDK only: request a visible border around the widget. */
33
62
  prefersBorder?: boolean;
63
+ /** Apps SDK only: override the iframe's served domain (advanced). */
34
64
  domain?: string;
65
+ /** Per-view CSP overrides — see {@link ViewCsp}. */
35
66
  csp?: ViewCsp;
67
+ /** Free-form metadata forwarded on the view resource's `_meta`. */
36
68
  _meta?: Record<string, unknown>;
37
69
  }
70
+ export type SecurityScheme = {
71
+ type: "noauth";
72
+ } | {
73
+ type: "oauth2";
74
+ scopes?: string[];
75
+ };
76
+ /**
77
+ * Options forwarded to the built-in `express.json()` body parser. Derived
78
+ * from Express's own types so the public API doesn't depend on `body-parser`.
79
+ */
80
+ export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
81
+ /** Skybridge-specific server options, passed as the third `McpServer` constructor argument. */
82
+ export interface SkybridgeServerOptions {
83
+ /** Options for the built-in `express.json()` middleware, e.g. `{ limit: "10mb" }`. */
84
+ json?: JsonOptions;
85
+ /** Resource-server OAuth config. When set, mounts well-known metadata and bearer auth on `/mcp`. */
86
+ oauth?: OAuthConfig;
87
+ }
88
+ /**
89
+ * Well-known keys recognized by host runtimes when set on a tool's `_meta`.
90
+ * Use {@link ToolMeta} to also pass arbitrary custom metadata alongside these.
91
+ *
92
+ * @see https://developers.openai.com/apps-sdk/reference#tool-descriptor-parameters
93
+ */
38
94
  export interface KnownToolMeta {
95
+ /** Apps SDK: allow the rendered view to call this tool from inside its iframe. */
39
96
  "openai/widgetAccessible"?: boolean;
97
+ /** Apps SDK: status text shown while the tool is running (e.g. `"Searching trips"`). */
40
98
  "openai/toolInvocation/invoking"?: string;
99
+ /** Apps SDK: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
41
100
  "openai/toolInvocation/invoked"?: string;
101
+ /** Apps SDK: input parameters that hold file references — the host attaches uploaded files to them. */
102
+ "openai/fileParams"?: string[];
103
+ /** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
104
+ ui?: Pick<McpUiToolMeta, "visibility">;
105
+ securitySchemes?: SecurityScheme[];
42
106
  }
107
+ /** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
43
108
  export type ToolMeta = KnownToolMeta & Record<string, unknown>;
109
+ /**
110
+ * Convenient return type for tool handlers — a plain string, a single
111
+ * {@link ContentBlock}, or an array. Skybridge normalizes it to the MCP
112
+ * `content: ContentBlock[]` shape before responding.
113
+ */
44
114
  export type HandlerContent = string | ContentBlock | ContentBlock[];
45
115
  /**
46
116
  * Type-level marker interface for cross-package type inference.
@@ -84,17 +154,73 @@ interface ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> {
84
154
  outputSchema?: ZodRawShapeCompat | AnySchema;
85
155
  annotations?: ToolAnnotations;
86
156
  view?: ViewConfig;
157
+ /**
158
+ * Declares which auth schemes this tool supports (e.g. `noauth`, `oauth2`).
159
+ * Lets clients label tools that require sign-in before calling, and pass
160
+ * the right scopes through the OAuth flow. Listing both `noauth` and
161
+ * `oauth2` signals that the tool works for anonymous callers and gives
162
+ * enhanced behavior to authenticated ones.
163
+ */
164
+ securitySchemes?: SecurityScheme[];
87
165
  _meta?: ToolMeta;
88
166
  }
167
+ /**
168
+ * Optional client-supplied hints attached to `params._meta` on every tool call
169
+ * by the Apps SDK host. Hints only: never use for authorization, and tolerate
170
+ * absence.
171
+ * @see https://developers.openai.com/apps-sdk/reference#_meta-fields-the-client-provides
172
+ */
173
+ export interface ClientHintsMeta {
174
+ /** Requested locale (BCP-47, e.g. `"en-US"`). */
175
+ "openai/locale"?: string;
176
+ /** Browser user-agent */
177
+ "openai/userAgent"?: string;
178
+ /** Coarse user location. May be partially populated. */
179
+ "openai/userLocation"?: {
180
+ city?: string;
181
+ region?: string;
182
+ country?: string;
183
+ timezone?: string;
184
+ longitude?: number;
185
+ latitude?: number;
186
+ };
187
+ /** Anonymized user id. */
188
+ "openai/subject"?: string;
189
+ /** Anonymized conversation id, stable within a ChatGPT session. */
190
+ "openai/session"?: string;
191
+ /** Anonymized organization id, when the user account is part of an organization. */
192
+ "openai/organization"?: string;
193
+ /** Stable id for the currently mounted widget instance. */
194
+ "openai/widgetSessionId"?: string;
195
+ }
196
+ type ToolHandlerExtra = Omit<RequestHandlerExtra<ServerRequest, ServerNotification>, "_meta"> & {
197
+ _meta?: RequestMeta & ClientHintsMeta;
198
+ };
89
199
  type ToolHandler<TInput extends ZodRawShapeCompat, TReturn extends {
90
200
  content?: HandlerContent;
91
201
  } = {
92
202
  content?: HandlerContent;
93
- }> = (args: ShapeOutput<TInput>, extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => TReturn | Promise<TReturn>;
203
+ }> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
204
+ /**
205
+ * Coerce a tool handler's return value into an MCP `content` array. Strings
206
+ * become a single `TextContent`; a single block is wrapped in an array;
207
+ * `undefined` produces `[]`. Mostly used internally — exported so consumers
208
+ * who build content lazily can apply the same normalization.
209
+ */
94
210
  export declare function normalizeContent(content: HandlerContent | undefined): ContentBlock[];
95
211
  interface McpServerBaseOmitted extends Omit<McpServerBase, "registerTool" | "connect"> {
96
212
  }
97
213
  declare const McpServerBaseOmitted: new (...args: ConstructorParameters<typeof McpServerBase>) => McpServerBaseOmitted;
214
+ /**
215
+ * Prime the build-time Vite manifest before user code constructs its
216
+ * `McpServer`. Called from the generated `dist/__entry.js`; not part of the
217
+ * user-facing API.
218
+ *
219
+ * @internal
220
+ */
221
+ export declare function __setBuildManifest(manifest: Record<string, {
222
+ file: string;
223
+ }>): void;
98
224
  export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>> extends McpServerBaseOmitted {
99
225
  readonly $types: McpServerTypes<TTools>;
100
226
  /**
@@ -102,7 +228,9 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
102
228
  * custom routes, middleware, or settings — e.g.
103
229
  * `server.express.get("/health", ...)`.
104
230
  *
105
- * `express.json()` is pre-applied. Register your handlers before `run()`;
231
+ * `express.json()` is pre-applied tune it via the constructor's third
232
+ * argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
233
+ * Register your handlers before `run()`;
106
234
  * after `run()`, dev-mode middleware, the `/mcp` route, and the default
107
235
  * error handler are appended in that order.
108
236
  *
@@ -114,12 +242,41 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
114
242
  private mcpMiddlewareEntries;
115
243
  private mcpMiddlewareApplied;
116
244
  private claimedViews;
245
+ private viewMetaBuilders;
246
+ /**
247
+ * Maps a view resource's query-less path to its canonical registered URI
248
+ * (the one carrying the `?v=` cache key). Lets `resources/read` resolve the
249
+ * underlying view no matter which version param the consumer sends, since
250
+ * the param is only a cache key, not part of the resource's identity.
251
+ */
252
+ private viewUriByPath;
117
253
  private viteManifest;
118
254
  private readonly serverInfo;
119
255
  private readonly serverOptions?;
120
- constructor(serverInfo: Implementation, options?: ServerOptions);
256
+ constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
257
+ /**
258
+ * Register Express middleware on the underlying app. Mirrors `app.use` —
259
+ * pass handlers directly or a path-prefixed handler list. Register before
260
+ * {@link McpServer.run}; ordering matches Express.
261
+ *
262
+ * Note: Alpic Cloud only routes traffic to `/mcp`. Custom paths work
263
+ * locally and on self-hosted deployments.
264
+ */
121
265
  use(...handlers: RequestHandler[]): this;
122
266
  use(path: string, ...handlers: RequestHandler[]): this;
267
+ /**
268
+ * Register Express error-handling middleware to run after the built-in
269
+ * `/mcp` route (or your custom route). Use this to log or transform errors
270
+ * thrown by tool handlers before the default error handler responds.
271
+ *
272
+ * @example
273
+ * ```ts
274
+ * server.useOnError((err, _req, _res, next) => {
275
+ * logger.error(err);
276
+ * next(err);
277
+ * });
278
+ * ```
279
+ */
123
280
  useOnError(...handlers: ErrorRequestHandler[]): this;
124
281
  useOnError(path: string, ...handlers: ErrorRequestHandler[]): this;
125
282
  /** Register MCP protocol-level middleware (catch-all). */
@@ -154,6 +311,14 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
154
311
  */
155
312
  mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
156
313
  private applyMcpMiddleware;
314
+ /**
315
+ * Connect to an MCP transport (override of the SDK's `connect`). Use this
316
+ * when you're embedding Skybridge in a host that already manages its own
317
+ * transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
318
+ * which sets the transport up for you. Locks in any middleware registered
319
+ * via {@link McpServer.mcpMiddleware} — further calls to that method will
320
+ * throw afterwards.
321
+ */
157
322
  connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
158
323
  /**
159
324
  * Per-request stateless connect. The SDK's `Protocol` only allows one
@@ -166,10 +331,23 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
166
331
  * read side and fails fast on SDK field renames.
167
332
  */
168
333
  connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
334
+ /**
335
+ * Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
336
+ * mounts the `/mcp` route, applies any custom Express middleware registered
337
+ * via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
338
+ * any MCP middleware registered via {@link McpServer.mcpMiddleware}.
339
+ *
340
+ * On Cloudflare Workers / workerd, returns an object exposing `fetch` so
341
+ * the runtime can bridge incoming requests to the Node HTTP server. On
342
+ * Vercel (`VERCEL === "1"`), returns the Express app directly so the
343
+ * serverless function entry can call it as a `(req, res)` handler. On
344
+ * Node, returns `undefined` once listening.
345
+ */
169
346
  run(): Promise<{
170
347
  fetch: (...args: unknown[]) => unknown;
171
- } | undefined>;
348
+ } | Express | undefined>;
172
349
  private enforceOneToolPerView;
350
+ private resolveViewRequestContext;
173
351
  private registerViewResources;
174
352
  private registerViewResource;
175
353
  private wrapHandler;
@@ -186,6 +364,35 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
186
364
  file: string;
187
365
  }>): this;
188
366
  private readManifest;
367
+ /**
368
+ * Register a tool. Pass a `config` describing the tool (name, schemas,
369
+ * optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
370
+ * returns the tool's result.
371
+ *
372
+ * Chain calls to build up a server: each call returns a new `McpServer`
373
+ * type that captures the tool's input/output/`_meta` shape so the
374
+ * resulting `typeof server` can drive {@link generateHelpers}.
375
+ *
376
+ * The handler's return shape determines the output types: the
377
+ * `structuredContent` field becomes the tool's typed output, and `_meta`
378
+ * becomes its `responseMetadata`. The `content` field is normalized through
379
+ * {@link normalizeContent}.
380
+ *
381
+ * @example
382
+ * ```ts
383
+ * server.registerTool({
384
+ * name: "search",
385
+ * inputSchema: { query: z.string() },
386
+ * outputSchema: { results: z.array(z.string()) },
387
+ * view: { component: "search" },
388
+ * }, async ({ query }) => ({
389
+ * content: `Found results for ${query}`,
390
+ * structuredContent: { results: [...] },
391
+ * }));
392
+ * ```
393
+ *
394
+ * @see https://docs.skybridge.tech/api-reference/register-tool
395
+ */
189
396
  registerTool<TName extends string, InputArgs extends ZodRawShapeCompat, TReturn extends {
190
397
  content?: HandlerContent;
191
398
  }>(config: ToolConfig<InputArgs> & {