skybridge 0.0.0-dev.f1f2ce8 → 0.0.0-dev.f2073a1

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 (323) hide show
  1. package/README.md +16 -14
  2. package/dist/cli/build-helpers.d.ts +1 -1
  3. package/dist/cli/build-helpers.js +4 -4
  4. package/dist/cli/build-helpers.js.map +1 -1
  5. package/dist/cli/build-helpers.test.js +6 -4
  6. package/dist/cli/build-helpers.test.js.map +1 -1
  7. package/dist/cli/build-steps.js +1 -1
  8. package/dist/cli/build-steps.js.map +1 -1
  9. package/dist/cli/build-steps.test.js +3 -3
  10. package/dist/cli/build-steps.test.js.map +1 -1
  11. package/dist/cli/detect-port.js +0 -1
  12. package/dist/cli/detect-port.js.map +1 -1
  13. package/dist/cli/run-plain.js +2 -1
  14. package/dist/cli/run-plain.js.map +1 -1
  15. package/dist/cli/telemetry.js +2 -0
  16. package/dist/cli/telemetry.js.map +1 -1
  17. package/dist/cli/use-execute-steps.d.ts +1 -1
  18. package/dist/cli/use-nodemon.d.ts +11 -1
  19. package/dist/cli/use-nodemon.js +30 -8
  20. package/dist/cli/use-nodemon.js.map +1 -1
  21. package/dist/cli/use-typescript-check.js +1 -1
  22. package/dist/cli/use-typescript-check.js.map +1 -1
  23. package/dist/commands/dev.js +4 -4
  24. package/dist/commands/dev.js.map +1 -1
  25. package/dist/commands/start.js +2 -2
  26. package/dist/commands/start.js.map +1 -1
  27. package/dist/context-warnings.d.ts +5 -0
  28. package/dist/context-warnings.js +31 -0
  29. package/dist/context-warnings.js.map +1 -0
  30. package/dist/context-warnings.test.js +28 -0
  31. package/dist/context-warnings.test.js.map +1 -0
  32. package/dist/server/app.d.ts +194 -0
  33. package/dist/server/app.js +266 -0
  34. package/dist/server/app.js.map +1 -0
  35. package/dist/server/app.test.js +97 -0
  36. package/dist/server/app.test.js.map +1 -0
  37. package/dist/server/auth/discovery.d.ts +2 -1
  38. package/dist/server/auth/discovery.js +2 -2
  39. package/dist/server/auth/discovery.js.map +1 -1
  40. package/dist/server/auth/index.d.ts +35 -5
  41. package/dist/server/auth/index.js.map +1 -1
  42. package/dist/server/auth/providers/auth0.d.ts +25 -3
  43. package/dist/server/auth/providers/auth0.js +13 -8
  44. package/dist/server/auth/providers/auth0.js.map +1 -1
  45. package/dist/server/auth/providers/auth0.test.js +5 -3
  46. package/dist/server/auth/providers/auth0.test.js.map +1 -1
  47. package/dist/server/auth/providers/authplane.d.ts +49 -0
  48. package/dist/server/auth/providers/authplane.js +57 -0
  49. package/dist/server/auth/providers/authplane.js.map +1 -0
  50. package/dist/server/auth/providers/authplane.test.js +143 -0
  51. package/dist/server/auth/providers/authplane.test.js.map +1 -0
  52. package/dist/server/auth/providers/clerk.d.ts +40 -3
  53. package/dist/server/auth/providers/clerk.js +4 -1
  54. package/dist/server/auth/providers/clerk.js.map +1 -1
  55. package/dist/server/auth/providers/clerk.test.js +5 -3
  56. package/dist/server/auth/providers/clerk.test.js.map +1 -1
  57. package/dist/server/auth/providers/custom.d.ts +16 -6
  58. package/dist/server/auth/providers/custom.js +14 -4
  59. package/dist/server/auth/providers/custom.js.map +1 -1
  60. package/dist/server/auth/providers/custom.test.js +24 -19
  61. package/dist/server/auth/providers/custom.test.js.map +1 -1
  62. package/dist/server/auth/providers/descope.d.ts +32 -3
  63. package/dist/server/auth/providers/descope.js.map +1 -1
  64. package/dist/server/auth/providers/descope.test.js +8 -6
  65. package/dist/server/auth/providers/descope.test.js.map +1 -1
  66. package/dist/server/auth/providers/stytch.d.ts +16 -3
  67. package/dist/server/auth/providers/stytch.js +4 -1
  68. package/dist/server/auth/providers/stytch.js.map +1 -1
  69. package/dist/server/auth/providers/verify-spy.d.ts +12 -0
  70. package/dist/server/auth/providers/verify-spy.js +21 -0
  71. package/dist/server/auth/providers/verify-spy.js.map +1 -0
  72. package/dist/server/auth/providers/workos.d.ts +28 -5
  73. package/dist/server/auth/providers/workos.js +6 -2
  74. package/dist/server/auth/providers/workos.js.map +1 -1
  75. package/dist/server/auth/setup.d.ts +1 -1
  76. package/dist/server/auth/setup.js +4 -5
  77. package/dist/server/auth/setup.js.map +1 -1
  78. package/dist/server/auth/setup.test.js +97 -57
  79. package/dist/server/auth/setup.test.js.map +1 -1
  80. package/dist/server/auth/verify.d.ts +42 -6
  81. package/dist/server/auth/verify.js +27 -3
  82. package/dist/server/auth/verify.js.map +1 -1
  83. package/dist/server/auth/verify.test.js +65 -0
  84. package/dist/server/auth/verify.test.js.map +1 -1
  85. package/dist/server/auth-extra.test-d.js +130 -0
  86. package/dist/server/auth-extra.test-d.js.map +1 -0
  87. package/dist/server/auth.d.ts +43 -6
  88. package/dist/server/auth.js +4 -5
  89. package/dist/server/auth.js.map +1 -1
  90. package/dist/server/build-manifest.test.js +7 -6
  91. package/dist/server/build-manifest.test.js.map +1 -1
  92. package/dist/server/content-helpers.d.ts +1 -1
  93. package/dist/server/content-helpers.js.map +1 -1
  94. package/dist/server/events.d.ts +113 -0
  95. package/dist/server/events.js +318 -0
  96. package/dist/server/events.js.map +1 -0
  97. package/dist/server/events.test.js +172 -0
  98. package/dist/server/events.test.js.map +1 -0
  99. package/dist/server/express.d.ts +23 -3
  100. package/dist/server/express.js +43 -32
  101. package/dist/server/express.js.map +1 -1
  102. package/dist/server/express.test.js +221 -103
  103. package/dist/server/express.test.js.map +1 -1
  104. package/dist/server/file-ref.d.ts +1 -1
  105. package/dist/server/file-ref.js +1 -1
  106. package/dist/server/file-ref.js.map +1 -1
  107. package/dist/server/form-input.d.ts +120 -0
  108. package/dist/server/form-input.js +89 -0
  109. package/dist/server/form-input.js.map +1 -0
  110. package/dist/server/index.d.ts +16 -8
  111. package/dist/server/index.js +9 -2
  112. package/dist/server/index.js.map +1 -1
  113. package/dist/server/mcp-errors.test.js +41 -0
  114. package/dist/server/mcp-errors.test.js.map +1 -0
  115. package/dist/server/middleware.d.ts +35 -10
  116. package/dist/server/middleware.js +33 -0
  117. package/dist/server/middleware.js.map +1 -1
  118. package/dist/server/middleware.test-d.js +1 -1
  119. package/dist/server/middleware.test-d.js.map +1 -1
  120. package/dist/server/middleware.test.js +242 -134
  121. package/dist/server/middleware.test.js.map +1 -1
  122. package/dist/server/register-tool.test.d.ts +1 -0
  123. package/dist/server/register-tool.test.js +230 -0
  124. package/dist/server/register-tool.test.js.map +1 -0
  125. package/dist/server/server.d.ts +337 -128
  126. package/dist/server/server.js +373 -305
  127. package/dist/server/server.js.map +1 -1
  128. package/dist/server/skills-integration.test.js +44 -21
  129. package/dist/server/skills-integration.test.js.map +1 -1
  130. package/dist/server/skills.d.ts +14 -10
  131. package/dist/server/skills.js +49 -39
  132. package/dist/server/skills.js.map +1 -1
  133. package/dist/server/skills.test.js +77 -44
  134. package/dist/server/skills.test.js.map +1 -1
  135. package/dist/server/templateHelper.d.ts +0 -3
  136. package/dist/server/templateHelper.js.map +1 -1
  137. package/dist/server/templates.generated.js +4 -8
  138. package/dist/server/templates.generated.js.map +1 -1
  139. package/dist/server/tool-extra.test.d.ts +1 -0
  140. package/dist/server/tool-extra.test.js +167 -0
  141. package/dist/server/tool-extra.test.js.map +1 -0
  142. package/dist/server/view-resource-resolution.test.js +18 -13
  143. package/dist/server/view-resource-resolution.test.js.map +1 -1
  144. package/dist/test/utils.d.ts +9 -11
  145. package/dist/test/utils.js +220 -201
  146. package/dist/test/utils.js.map +1 -1
  147. package/dist/test/view.test.js +41 -37
  148. package/dist/test/view.test.js.map +1 -1
  149. package/dist/views/index.d.ts +10 -0
  150. package/dist/views/index.js +3 -0
  151. package/dist/views/index.js.map +1 -0
  152. package/dist/{web/plugin → views}/scan-views.js +1 -1
  153. package/dist/views/scan-views.js.map +1 -0
  154. package/dist/views/scan-views.test.d.ts +1 -0
  155. package/dist/views/scan-views.test.js.map +1 -0
  156. package/dist/views/validate-view.d.ts +1 -0
  157. package/dist/{web/plugin → views}/validate-view.js +2 -2
  158. package/dist/views/validate-view.js.map +1 -0
  159. package/dist/views/validate-view.test.d.ts +1 -0
  160. package/dist/views/validate-view.test.js.map +1 -0
  161. package/dist/web/bridges/adaptor.d.ts +14 -3
  162. package/dist/web/bridges/adaptor.js +171 -30
  163. package/dist/web/bridges/adaptor.js.map +1 -1
  164. package/dist/web/bridges/adaptor.test.js +69 -13
  165. package/dist/web/bridges/adaptor.test.js.map +1 -1
  166. package/dist/web/bridges/apps-sdk/bridge.js +1 -1
  167. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  168. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +4 -4
  169. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +4 -4
  170. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  171. package/dist/web/bridges/get-adaptor.test.js +2 -2
  172. package/dist/web/bridges/get-adaptor.test.js.map +1 -1
  173. package/dist/web/bridges/mcp-app/bridge.d.ts +1 -1
  174. package/dist/web/bridges/mcp-app/bridge.js +10 -3
  175. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  176. package/dist/web/bridges/mcp-app/bridge.test.js +2 -2
  177. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -1
  178. package/dist/web/bridges/mcp-app/types.d.ts +18 -3
  179. package/dist/web/bridges/mcp-app/types.js.map +1 -1
  180. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +2 -2
  181. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +1 -1
  182. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  183. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +1 -1
  184. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
  185. package/dist/web/bridges/mcp-app/view-tools.test.js +1 -1
  186. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -1
  187. package/dist/web/bridges/types.d.ts +74 -16
  188. package/dist/web/bridges/types.js +1 -1
  189. package/dist/web/bridges/types.js.map +1 -1
  190. package/dist/web/create-store.test.js +2 -2
  191. package/dist/web/create-store.test.js.map +1 -1
  192. package/dist/web/data-llm.js +3 -2
  193. package/dist/web/data-llm.js.map +1 -1
  194. package/dist/web/data-llm.test.js +11 -4
  195. package/dist/web/data-llm.test.js.map +1 -1
  196. package/dist/web/generate-helpers.d.ts +23 -19
  197. package/dist/web/generate-helpers.js +21 -17
  198. package/dist/web/generate-helpers.js.map +1 -1
  199. package/dist/web/generate-helpers.test-d.js +3 -3
  200. package/dist/web/generate-helpers.test-d.js.map +1 -1
  201. package/dist/web/generate-helpers.test.js +2 -2
  202. package/dist/web/generate-helpers.test.js.map +1 -1
  203. package/dist/web/hooks/index.d.ts +6 -2
  204. package/dist/web/hooks/index.js +6 -2
  205. package/dist/web/hooks/index.js.map +1 -1
  206. package/dist/web/hooks/openai-extensions.test.d.ts +1 -0
  207. package/dist/web/hooks/openai-extensions.test.js +107 -0
  208. package/dist/web/hooks/openai-extensions.test.js.map +1 -0
  209. package/dist/web/hooks/use-call-tool.d.ts +2 -2
  210. package/dist/web/hooks/use-call-tool.js +15 -10
  211. package/dist/web/hooks/use-call-tool.js.map +1 -1
  212. package/dist/web/hooks/use-call-tool.test.js +15 -4
  213. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  214. package/dist/web/hooks/use-deep-link.d.ts +22 -0
  215. package/dist/web/hooks/use-deep-link.js +34 -0
  216. package/dist/web/hooks/use-deep-link.js.map +1 -0
  217. package/dist/web/hooks/use-display-mode.d.ts +1 -1
  218. package/dist/web/hooks/use-display-mode.js +1 -1
  219. package/dist/web/hooks/use-display-mode.js.map +1 -1
  220. package/dist/web/hooks/use-display-mode.test.js +1 -1
  221. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  222. package/dist/web/hooks/use-download.d.ts +1 -3
  223. package/dist/web/hooks/use-download.js +1 -2
  224. package/dist/web/hooks/use-download.js.map +1 -1
  225. package/dist/web/hooks/use-download.test.js +7 -7
  226. package/dist/web/hooks/use-download.test.js.map +1 -1
  227. package/dist/web/hooks/use-file-resource.d.ts +37 -0
  228. package/dist/web/hooks/use-file-resource.js +98 -0
  229. package/dist/web/hooks/use-file-resource.js.map +1 -0
  230. package/dist/web/hooks/use-file-resource.test.d.ts +1 -0
  231. package/dist/web/hooks/use-file-resource.test.js +65 -0
  232. package/dist/web/hooks/use-file-resource.test.js.map +1 -0
  233. package/dist/web/hooks/use-files.test.js +1 -1
  234. package/dist/web/hooks/use-files.test.js.map +1 -1
  235. package/dist/web/hooks/use-host.d.ts +44 -0
  236. package/dist/web/hooks/use-host.js +45 -0
  237. package/dist/web/hooks/use-host.js.map +1 -0
  238. package/dist/web/hooks/use-host.test.d.ts +1 -0
  239. package/dist/web/hooks/{use-host-info.test.js → use-host.test.js} +7 -7
  240. package/dist/web/hooks/use-host.test.js.map +1 -0
  241. package/dist/web/hooks/use-model-context.d.ts +44 -0
  242. package/dist/web/hooks/use-model-context.js +63 -0
  243. package/dist/web/hooks/use-model-context.js.map +1 -0
  244. package/dist/web/hooks/use-open-external.test.js +2 -2
  245. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  246. package/dist/web/hooks/use-open-file.d.ts +20 -0
  247. package/dist/web/hooks/use-open-file.js +25 -0
  248. package/dist/web/hooks/use-open-file.js.map +1 -0
  249. package/dist/web/hooks/use-register-view-tool.d.ts +3 -4
  250. package/dist/web/hooks/use-register-view-tool.js +1 -1
  251. package/dist/web/hooks/use-register-view-tool.js.map +1 -1
  252. package/dist/web/hooks/use-request-close.test.js +1 -1
  253. package/dist/web/hooks/use-request-close.test.js.map +1 -1
  254. package/dist/web/hooks/use-request-modal.test.js +1 -1
  255. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  256. package/dist/web/hooks/use-request-size.d.ts +1 -1
  257. package/dist/web/hooks/use-request-size.js +1 -1
  258. package/dist/web/hooks/use-request-size.js.map +1 -1
  259. package/dist/web/hooks/use-request-size.test.js +1 -1
  260. package/dist/web/hooks/use-request-size.test.js.map +1 -1
  261. package/dist/web/hooks/use-send-follow-up-message.d.ts +8 -2
  262. package/dist/web/hooks/use-send-follow-up-message.js +6 -0
  263. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  264. package/dist/web/hooks/use-set-open-in-app-url.test.js +2 -8
  265. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -1
  266. package/dist/web/hooks/use-tool-info.d.ts +1 -20
  267. package/dist/web/hooks/use-tool-info.js +0 -1
  268. package/dist/web/hooks/use-tool-info.js.map +1 -1
  269. package/dist/web/hooks/use-tool-info.test-d.js +0 -5
  270. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  271. package/dist/web/hooks/use-tool-info.test.js +2 -7
  272. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  273. package/dist/web/hooks/use-user.d.ts +3 -2
  274. package/dist/web/hooks/use-user.js +4 -3
  275. package/dist/web/hooks/use-user.js.map +1 -1
  276. package/dist/web/hooks/use-user.test.js +5 -3
  277. package/dist/web/hooks/use-user.test.js.map +1 -1
  278. package/dist/web/hooks/use-view-state.js +19 -9
  279. package/dist/web/hooks/use-view-state.js.map +1 -1
  280. package/dist/web/hooks/use-view-state.test.js +33 -2
  281. package/dist/web/hooks/use-view-state.test.js.map +1 -1
  282. package/dist/web/hooks/use-viewport.d.ts +20 -0
  283. package/dist/web/hooks/use-viewport.js +21 -0
  284. package/dist/web/hooks/use-viewport.js.map +1 -0
  285. package/dist/web/hooks/use-viewport.test.d.ts +1 -0
  286. package/dist/web/hooks/{use-layout.test.js → use-viewport.test.js} +12 -32
  287. package/dist/web/hooks/use-viewport.test.js.map +1 -0
  288. package/dist/web/mount-view.d.ts +3 -2
  289. package/dist/web/mount-view.js +5 -8
  290. package/dist/web/mount-view.js.map +1 -1
  291. package/package.json +17 -13
  292. package/dist/web/hooks/use-host-info.d.ts +0 -22
  293. package/dist/web/hooks/use-host-info.js +0 -30
  294. package/dist/web/hooks/use-host-info.js.map +0 -1
  295. package/dist/web/hooks/use-host-info.test.js.map +0 -1
  296. package/dist/web/hooks/use-layout.d.ts +0 -24
  297. package/dist/web/hooks/use-layout.js +0 -25
  298. package/dist/web/hooks/use-layout.js.map +0 -1
  299. package/dist/web/hooks/use-layout.test.js.map +0 -1
  300. package/dist/web/plugin/data-llm.test.js +0 -81
  301. package/dist/web/plugin/data-llm.test.js.map +0 -1
  302. package/dist/web/plugin/plugin.d.ts +0 -39
  303. package/dist/web/plugin/plugin.js +0 -189
  304. package/dist/web/plugin/plugin.js.map +0 -1
  305. package/dist/web/plugin/scan-views.js.map +0 -1
  306. package/dist/web/plugin/scan-views.test.js.map +0 -1
  307. package/dist/web/plugin/transform-data-llm.d.ts +0 -12
  308. package/dist/web/plugin/transform-data-llm.js +0 -96
  309. package/dist/web/plugin/transform-data-llm.js.map +0 -1
  310. package/dist/web/plugin/transform-data-llm.test.js +0 -81
  311. package/dist/web/plugin/transform-data-llm.test.js.map +0 -1
  312. package/dist/web/plugin/validate-view.d.ts +0 -1
  313. package/dist/web/plugin/validate-view.js.map +0 -1
  314. package/dist/web/plugin/validate-view.test.js.map +0 -1
  315. /package/dist/{web/hooks/use-host-info.test.d.ts → context-warnings.test.d.ts} +0 -0
  316. /package/dist/{web/hooks/use-layout.test.d.ts → server/app.test.d.ts} +0 -0
  317. /package/dist/{web/plugin/scan-views.test.d.ts → server/auth/providers/authplane.test.d.ts} +0 -0
  318. /package/dist/{web/plugin/data-llm.test.d.ts → server/auth-extra.test-d.d.ts} +0 -0
  319. /package/dist/{web/plugin/transform-data-llm.test.d.ts → server/events.test.d.ts} +0 -0
  320. /package/dist/{web/plugin/validate-view.test.d.ts → server/mcp-errors.test.d.ts} +0 -0
  321. /package/dist/{web/plugin → views}/scan-views.d.ts +0 -0
  322. /package/dist/{web/plugin → views}/scan-views.test.js +0 -0
  323. /package/dist/{web/plugin → views}/validate-view.test.js +0 -0
@@ -1,12 +1,11 @@
1
1
  import type { McpUiToolMeta } from "@modelcontextprotocol/ext-apps";
2
- import { type ServerOptions } from "@modelcontextprotocol/sdk/server/index.js";
3
- import { McpServer as McpServerBase } from "@modelcontextprotocol/sdk/server/mcp.js";
4
- import type { AnySchema, SchemaOutput, ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
5
- import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
6
- import type { ContentBlock, Implementation, RequestMeta, ServerNotification, ServerRequest, ServerResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
7
- import express, { type ErrorRequestHandler, type Express, type RequestHandler } from "express";
8
- import type { OAuthConfig } from "./auth/index.js";
9
- import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
2
+ import { type ContentBlock, type Icon, type Implementation, type InputRequiredResult, McpServer as McpServerBase, type RequestMeta, type ResourceLink, type ServerOptions, type ServerResult, type StandardSchemaV1, type StandardSchemaWithJSON, type ToolAnnotations } from "@modelcontextprotocol/server";
3
+ import type express from "express";
4
+ import { z } from "zod/v4";
5
+ import type { ResourceMetadataUrlResolver } from "./auth/setup.js";
6
+ import type { ExtraClaims } from "./auth.js";
7
+ import { type EventConfig, type EventHooks, type InferEventSchema } from "./events.js";
8
+ import type { McpExtra, McpExtraFor, McpMethodString, McpMiddlewareEntry, McpMiddlewareFilter, McpMiddlewareFn, McpResultFor, McpTypedMiddlewareFn, McpWildcard } from "./middleware.js";
10
9
  import { type SkillsManifest } from "./skills.js";
11
10
  /**
12
11
  * Type marker for a registered tool — carries its input, output, and response
@@ -20,12 +19,6 @@ export type ToolDef<TInput = unknown, TOutput = unknown, TResponseMetadata = unk
20
19
  output: TOutput;
21
20
  responseMetadata: TResponseMetadata;
22
21
  };
23
- /**
24
- * @deprecated Views now always emit a single ext-apps resource; host targeting
25
- * no longer applies. Retained for backwards compatibility; will be removed in a
26
- * future major.
27
- */
28
- export type ViewHostType = "apps-sdk" | "mcp-app";
29
22
  /**
30
23
  * Content Security Policy origins attached to a view's resource. Each list is
31
24
  * passed through to the host's CSP for the view iframe; omit a field to inherit
@@ -36,7 +29,7 @@ export interface ViewCsp {
36
29
  resourceDomains?: string[];
37
30
  /** Origins the view may contact via fetch/XHR. */
38
31
  connectDomains?: string[];
39
- /** Origins allowed for iframe embeds (opts into stricter app review). */
32
+ /** Origins allowed for iframe embeds (opts into stricter plugin review). */
40
33
  frameDomains?: string[];
41
34
  /** Origins that can receive openExternal redirects without the safe-link modal. */
42
35
  redirectDomains?: string[];
@@ -69,11 +62,6 @@ export interface ViewConfig {
69
62
  component: ViewName;
70
63
  /** Human-readable label the host may show alongside the view. */
71
64
  description?: string;
72
- /**
73
- * @deprecated No-op. Every view emits a single ext-apps resource regardless
74
- * of this value. Will be removed in a future major.
75
- */
76
- hosts?: ViewHostType[];
77
65
  /** Request a visible border around the view (forwarded as `ui.prefersBorder`). */
78
66
  prefersBorder?: boolean;
79
67
  /** Override the iframe's served domain (advanced; forwarded as `ui.domain`). */
@@ -89,6 +77,65 @@ export type SecurityScheme = {
89
77
  type: "oauth2";
90
78
  scopes?: string[];
91
79
  };
80
+ /** A display mode ChatGPT can render a view in. ChatGPT doesn't support `pip`. */
81
+ export type OpenAIDisplayMode = "inline" | "fullscreen";
82
+ /** A sidebar shortcut that calls another tool of the same server. */
83
+ export interface OpenAIQuickAction {
84
+ title: string;
85
+ icons: [Icon, ...Icon[]];
86
+ target: {
87
+ type: "tool";
88
+ name: string;
89
+ arguments?: Record<string, unknown>;
90
+ };
91
+ }
92
+ /**
93
+ * A place in ChatGPT where users can open the tool's view without the model.
94
+ *
95
+ * - `global`: an entry in the sidebar, opened fullscreen.
96
+ * - `thread`: a tab in a conversation's side panel.
97
+ * - `file`: a viewer for files with these extensions, such as `".stl"`.
98
+ * ChatGPT calls the tool with `{ file: { name, resourceUri } }`.
99
+ * - `settings`: an entry in the plugin settings.
100
+ *
101
+ * ChatGPT calls the tool with `{}` for global and thread entrypoints, so the
102
+ * tool must not require any input.
103
+ */
104
+ export type OpenAIEntrypoint = {
105
+ type: "global";
106
+ quickAction?: OpenAIQuickAction;
107
+ } | {
108
+ type: "thread";
109
+ } | {
110
+ type: "file";
111
+ extensions: string[];
112
+ } | {
113
+ type: "settings";
114
+ searchTerms?: string[];
115
+ };
116
+ /**
117
+ * ChatGPT-only tool options, emitted as `_meta["openai/ui"]` on the tool and
118
+ * on its view resource. Every field is optional: ChatGPT applies the defaults
119
+ * of the OpenAI MCP extensions spec when one is omitted. Requires `view`.
120
+ *
121
+ * @see https://github.com/openai/mcp-extensions/blob/main/docs/spec.md
122
+ */
123
+ export interface OpenAIToolConfig {
124
+ /** Places where users can open the view directly. */
125
+ entrypoints?: OpenAIEntrypoint[];
126
+ /**
127
+ * Display modes the view supports, read before the view loads. Defaults to
128
+ * `[preferredDisplayMode]` when that is set, otherwise to both modes.
129
+ */
130
+ availableDisplayModes?: OpenAIDisplayMode[];
131
+ /**
132
+ * Display mode the view prefers to open in. Setting it alone makes it the
133
+ * only available mode, so also set `availableDisplayModes` to keep the other.
134
+ */
135
+ preferredDisplayMode?: OpenAIDisplayMode;
136
+ /** Display mode the view opens in first when the model calls the tool. */
137
+ preferredModelDisplayMode?: OpenAIDisplayMode;
138
+ }
92
139
  /**
93
140
  * Declarative per-tool auth. Enforced when the server has an `oauth` provider:
94
141
  * anonymous or under-scoped calls are rejected before the handler runs. Omit
@@ -108,12 +155,14 @@ export type ToolAuth = {
108
155
  * from Express's own types so the public API doesn't depend on `body-parser`.
109
156
  */
110
157
  export type JsonOptions = NonNullable<Parameters<typeof express.json>[0]>;
111
- /** Skybridge-specific server options, passed as the third `McpServer` constructor argument. */
158
+ /**
159
+ * The Skybridge-specific options an {@link McpServer} is built with. A
160
+ * {@link Skybridge} app derives them from its config; pass them directly only
161
+ * when constructing an `McpServer` by hand.
162
+ */
112
163
  export interface SkybridgeServerOptions {
113
- /** Options for the built-in `express.json()` middleware, e.g. `{ limit: "10mb" }`. */
114
- json?: JsonOptions;
115
- /** Resource-server OAuth config. When set, mounts well-known metadata and bearer auth on `/mcp`. */
116
- oauth?: OAuthConfig;
164
+ /** Whether an OAuth provider guards `/mcp`; enables per-tool scheme enforcement. */
165
+ oauth?: boolean;
117
166
  /**
118
167
  * @experimental Serve Agent Skills from `src/skills` over MCP (SEP-2640).
119
168
  * API may change.
@@ -124,20 +173,19 @@ export interface SkybridgeServerOptions {
124
173
  * Well-known keys recognized by host runtimes when set on a tool's `_meta`.
125
174
  * Use {@link ToolMeta} to also pass arbitrary custom metadata alongside these.
126
175
  *
127
- * @see https://developers.openai.com/apps-sdk/reference#tool-descriptor-parameters
176
+ * @see https://developers.openai.com/plugins/reference#tool-descriptor-parameters
128
177
  */
129
178
  export interface KnownToolMeta {
130
- /** Apps SDK: allow the rendered view to call this tool from inside its iframe. */
179
+ /** ChatGPT: allow the rendered view to call this tool from inside its iframe. */
131
180
  "openai/widgetAccessible"?: boolean;
132
- /** Apps SDK: status text shown while the tool is running (e.g. `"Searching trips"`). */
181
+ /** ChatGPT: status text shown while the tool is running (e.g. `"Searching trips"`). */
133
182
  "openai/toolInvocation/invoking"?: string;
134
- /** Apps SDK: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
183
+ /** ChatGPT: status text shown once the tool returns (e.g. `"Found 3 trips"`). */
135
184
  "openai/toolInvocation/invoked"?: string;
136
- /** Apps SDK: input parameters that hold file references — the host attaches uploaded files to them. */
185
+ /** ChatGPT: input parameters that hold file references — the host attaches uploaded files to them. */
137
186
  "openai/fileParams"?: string[];
138
187
  /** MCP Apps: control whether the tool is exposed to the model, the app, or both. */
139
188
  ui?: Pick<McpUiToolMeta, "visibility">;
140
- securitySchemes?: SecurityScheme[];
141
189
  }
142
190
  /** {@link KnownToolMeta} merged with arbitrary string-keyed metadata for custom flags. */
143
191
  export type ToolMeta = KnownToolMeta & Record<string, unknown>;
@@ -163,10 +211,10 @@ export interface McpServerTypes<TTools extends Record<string, ToolDef>> {
163
211
  type Simplify<T> = {
164
212
  [K in keyof T]: T[K];
165
213
  };
166
- type ShapeOutput<Shape extends ZodRawShapeCompat> = Simplify<{
167
- [K in keyof Shape as undefined extends SchemaOutput<Shape[K]> ? never : K]: SchemaOutput<Shape[K]>;
214
+ type ShapeOutput<Shape extends Record<string, StandardSchemaWithJSON>> = Simplify<{
215
+ [K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? never : K]: StandardSchemaV1.InferOutput<Shape[K]>;
168
216
  } & {
169
- [K in keyof Shape as undefined extends SchemaOutput<Shape[K]> ? K : never]?: SchemaOutput<Shape[K]>;
217
+ [K in keyof Shape as undefined extends StandardSchemaV1.InferOutput<Shape[K]> ? K : never]?: StandardSchemaV1.InferOutput<Shape[K]>;
170
218
  }>;
171
219
  type ExtractStructuredContent<T> = T extends {
172
220
  structuredContent: infer SC;
@@ -178,17 +226,25 @@ type ExtractMeta<T> = [Extract<T, {
178
226
  }> extends {
179
227
  _meta: infer M;
180
228
  } ? Simplify<M> : unknown;
181
- type AddTool<TTools, TName extends string, TInput extends ZodRawShapeCompat, TOutput, TResponseMetadata = unknown> = McpServer<TTools & {
229
+ type AddTool<TTools, TName extends string, TInput extends Record<string, StandardSchemaWithJSON>, TOutput, TResponseMetadata = unknown, TAuthExtra extends ExtraClaims = ExtraClaims> = McpServer<TTools & {
182
230
  [K in TName]: ToolDef<ShapeOutput<TInput>, TOutput, TResponseMetadata>;
183
- }>;
184
- interface ToolConfigBase<TInput extends ZodRawShapeCompat | AnySchema> {
231
+ }, TAuthExtra>;
232
+ interface ToolConfigBase<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> {
185
233
  name: string;
186
234
  title?: string;
187
235
  description?: string;
188
236
  inputSchema?: TInput;
189
- outputSchema?: ZodRawShapeCompat | AnySchema;
237
+ outputSchema?: Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
190
238
  annotations?: ToolAnnotations;
239
+ /**
240
+ * Icons for the tool, a standard MCP field. Hosts choose whether and where
241
+ * to show them. ChatGPT asks for them on every entrypoint tool, as a
242
+ * monochrome SVG on a 20x20 viewport that uses `currentColor`.
243
+ */
244
+ icons?: Icon[];
191
245
  view?: ViewConfig;
246
+ /** ChatGPT-only options. See {@link OpenAIToolConfig}. */
247
+ openai?: OpenAIToolConfig;
192
248
  _meta?: ToolMeta;
193
249
  }
194
250
  /**
@@ -209,12 +265,28 @@ type ToolAuthConfig = {
209
265
  */
210
266
  securitySchemes?: SecurityScheme[];
211
267
  };
212
- type ToolConfig<TInput extends ZodRawShapeCompat | AnySchema> = ToolConfigBase<TInput> & ToolAuthConfig;
268
+ type ToolConfig<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON> = ToolConfigBase<TInput> & ToolAuthConfig;
269
+ declare const fileEntrypointInput: {
270
+ file: z.ZodObject<{
271
+ name: z.ZodString;
272
+ resourceUri: z.ZodString;
273
+ }, z.core.$strip>;
274
+ };
275
+ type FileEntrypointInput = typeof fileEntrypointInput;
276
+ /** A ChatGPT file viewer, registered with `server.registerFileViewer`. */
277
+ export type OpenAIFileViewerConfig<TName extends string = string> = Omit<ToolConfigBase<FileEntrypointInput>, "inputSchema" | "openai" | "view"> & ToolAuthConfig & {
278
+ name: TName;
279
+ /** File extensions the viewer opens, each starting with `.`. */
280
+ extensions: string[];
281
+ view: ViewConfig;
282
+ /** Display modes. The file entrypoint is set from `extensions`. */
283
+ openai?: Omit<OpenAIToolConfig, "entrypoints">;
284
+ };
213
285
  /**
214
286
  * Optional client-supplied hints attached to `params._meta` on every tool call
215
- * by the Apps SDK host. Hints only: never use for authorization, and tolerate
287
+ * by the ChatGPT host. Hints only: never use for authorization, and tolerate
216
288
  * absence.
217
- * @see https://developers.openai.com/apps-sdk/reference#_meta-fields-the-client-provides
289
+ * @see https://developers.openai.com/plugins/reference#_meta-fields-the-client-provides
218
290
  */
219
291
  export interface ClientHintsMeta {
220
292
  /** Requested locale (BCP-47, e.g. `"en-US"`). */
@@ -238,15 +310,77 @@ export interface ClientHintsMeta {
238
310
  "openai/organization"?: string;
239
311
  /** Stable id for the currently mounted widget instance. */
240
312
  "openai/widgetSessionId"?: string;
313
+ /**
314
+ * Set by ChatGPT desktop on tool calls from a view opened through a file
315
+ * entrypoint. `path` is the absolute path of the opened file. Any MCP client
316
+ * can send this key: never use it for authorization, and resolve the path
317
+ * and keep it inside an allowed directory before touching the filesystem.
318
+ */
319
+ "openai/resource"?: {
320
+ path?: string;
321
+ };
322
+ }
323
+ type ToolHandlerExtra<TAuthExtra extends ExtraClaims = ExtraClaims> = Omit<McpExtra<TAuthExtra>, "mcpReq"> & {
324
+ mcpReq: Omit<McpExtra<TAuthExtra>["mcpReq"], "_meta"> & {
325
+ _meta?: RequestMeta & ClientHintsMeta;
326
+ };
327
+ };
328
+ /** Composer at-mention search, registered with `server.registerMentions`. */
329
+ export interface OpenAIMentionsConfig<TAuthExtra extends ExtraClaims = ExtraClaims> {
330
+ /** Name of the tool ChatGPT calls for each search. */
331
+ name: string;
332
+ description?: string;
333
+ /** Returns the items matching the typed text, which may be empty. */
334
+ handler: (params: {
335
+ query: string;
336
+ }, extra: ToolHandlerExtra<TAuthExtra>) => Promise<{
337
+ items: ResourceLink[];
338
+ }> | {
339
+ items: ResourceLink[];
340
+ };
241
341
  }
242
- type ToolHandlerExtra = Omit<RequestHandlerExtra<ServerRequest, ServerNotification>, "_meta"> & {
243
- _meta?: RequestMeta & ClientHintsMeta;
342
+ /** One setting, registered with `server.registerSettings`. */
343
+ export interface OpenAISettingsField {
344
+ /** A boolean, string, string enum, number or integer schema, without a default. */
345
+ schema: z.ZodType<boolean | string | number>;
346
+ title: string;
347
+ description?: string;
348
+ }
349
+ /** Values of every setting, keyed by field name. */
350
+ export type OpenAISettingsValues<TFields extends Record<string, OpenAISettingsField>> = {
351
+ [K in keyof TFields]-?: Exclude<z.output<TFields[K]["schema"]>, undefined>;
244
352
  };
245
- type ToolHandler<TInput extends ZodRawShapeCompat, TReturn extends {
353
+ /** App settings in ChatGPT, registered with `server.registerSettings`. */
354
+ export interface OpenAISettingsConfig<TFields extends Record<string, OpenAISettingsField>, TAuthExtra extends ExtraClaims = ExtraClaims> {
355
+ fields: TFields;
356
+ /** Sections of the settings page. Fields left out appear under "Other settings". */
357
+ layout?: {
358
+ kind: "group";
359
+ title: string;
360
+ items: ({
361
+ kind: "property";
362
+ property: Extract<keyof TFields, string>;
363
+ } | {
364
+ kind: "tool";
365
+ tool: string;
366
+ title: string;
367
+ description?: string;
368
+ })[];
369
+ }[];
370
+ /** Returns the current value of every field. */
371
+ read: (extra: ToolHandlerExtra<TAuthExtra>) => OpenAISettingsValues<TFields> | Promise<OpenAISettingsValues<TFields>>;
372
+ /** Saves the changed fields and returns the value of every field. */
373
+ update: (set: Partial<OpenAISettingsValues<TFields>>, extra: ToolHandlerExtra<TAuthExtra>) => OpenAISettingsValues<TFields> | Promise<OpenAISettingsValues<TFields>>;
374
+ /** Name of the read tool. Defaults to `settings.read`. */
375
+ readTool?: string;
376
+ /** Name of the update tool. Defaults to `settings.update`. */
377
+ updateTool?: string;
378
+ }
379
+ type ToolHandler<TInput extends Record<string, StandardSchemaWithJSON>, TReturn extends {
246
380
  content?: HandlerContent;
247
381
  } = {
248
382
  content?: HandlerContent;
249
- }> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra) => TReturn | Promise<TReturn>;
383
+ }, TAuthExtra extends ExtraClaims = ExtraClaims> = (args: ShapeOutput<TInput>, extra: ToolHandlerExtra<TAuthExtra>) => TReturn | InputRequiredResult | Promise<TReturn | InputRequiredResult>;
250
384
  /**
251
385
  * Coerce a tool handler's return value into an MCP `content` array. Strings
252
386
  * become a single `TextContent`; a single block is wrapped in an array;
@@ -268,26 +402,38 @@ export declare function __setBuildManifest(manifest: Record<string, {
268
402
  file: string;
269
403
  }>): void;
270
404
  export declare function __setSkillsManifest(manifest: SkillsManifest): void;
271
- export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>> extends McpServerBaseOmitted {
405
+ /**
406
+ * Typed registration sugar over the MCP SDK's `McpServer`: a tool registry
407
+ * that carries input/output/meta shapes, view resources, per-tool security
408
+ * schemes, and prompt/resource registration. A {@link Skybridge} app builds
409
+ * one of these per request and hands it to your `handler`; chain
410
+ * {@link McpServer.registerTool} calls on it and return the result.
411
+ *
412
+ * The `TTools` generic accumulates each registered tool's input/output/meta
413
+ * shape, so `typeof app` carries enough information for view-side helpers
414
+ * like {@link generateHelpers} to produce fully-typed hooks.
415
+ *
416
+ * @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
417
+ * chaining; you almost never set this manually.
418
+ *
419
+ * @example
420
+ * ```ts
421
+ * export const app = new Skybridge({
422
+ * name: "my-app",
423
+ * version: "1.0.0",
424
+ * handler: (server) =>
425
+ * server.registerTool({
426
+ * name: "search",
427
+ * inputSchema: { query: z.string() },
428
+ * view: { component: "search" },
429
+ * }, async ({ query }) => ({ content: `Results for ${query}` })),
430
+ * });
431
+ * ```
432
+ *
433
+ * @see https://docs.skybridge.tech/api-reference/mcp-server
434
+ */
435
+ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<never, ToolDef>, TAuthExtra extends ExtraClaims = ExtraClaims> extends McpServerBaseOmitted {
272
436
  readonly $types: McpServerTypes<TTools>;
273
- /**
274
- * The underlying Express app. Use this to extend the HTTP server with
275
- * custom routes, middleware, or settings — e.g.
276
- * `server.express.get("/health", ...)`.
277
- *
278
- * `express.json()` is pre-applied — tune it via the constructor's third
279
- * argument, e.g. `new McpServer(info, {}, { json: { limit: "10mb" } })`.
280
- * Register your handlers before `run()`;
281
- * after `run()`, dev-mode middleware, the `/mcp` route, and the default
282
- * error handler are appended in that order.
283
- *
284
- * Note: Alpic Cloud only routes traffic to `/mcp` — custom routes work
285
- * locally and on self-hosted deployments.
286
- */
287
- readonly express: Express;
288
- private customErrorMiddleware;
289
- private mcpMiddlewareEntries;
290
- private mcpMiddlewareApplied;
291
437
  private claimedViews;
292
438
  private viewMetaBuilders;
293
439
  /**
@@ -298,45 +444,35 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
298
444
  */
299
445
  private viewUriByPath;
300
446
  private viteManifest;
301
- private readonly serverInfo;
302
- private readonly serverOptions?;
303
447
  private oauthEnabled;
304
448
  private resolveResourceMetadataUrl?;
305
- private securitySchemesByTool;
449
+ private readonly toolSecuritySchemes;
450
+ private readonly userMiddlewareEntries;
451
+ private eventRegistry?;
306
452
  constructor(serverInfo: Implementation, options?: ServerOptions, skybridgeOptions?: SkybridgeServerOptions);
307
- private setupSkills;
308
453
  /**
309
- * Register Express middleware on the underlying app. Mirrors `app.use` —
310
- * pass handlers directly or a path-prefixed handler list. Register before
311
- * {@link McpServer.run}; ordering matches Express.
454
+ * The per-tool security schemes collected during registration, keyed by tool
455
+ * name. Read by the OAuth layer to decide whether anonymous requests are
456
+ * allowed and which schemes gate a given `tools/call`.
312
457
  *
313
- * Note: Alpic Cloud only routes traffic to `/mcp`. Custom paths work
314
- * locally and on self-hosted deployments.
458
+ * @internal
315
459
  */
316
- use(...handlers: RequestHandler[]): this;
317
- use(path: string, ...handlers: RequestHandler[]): this;
460
+ get securitySchemesByTool(): ReadonlyMap<string, SecurityScheme[] | undefined>;
318
461
  /**
319
- * Register Express error-handling middleware to run after the built-in
320
- * `/mcp` route (or your custom route). Use this to log or transform errors
321
- * thrown by tool handlers before the default error handler responds.
462
+ * Inject the resolver the app uses to build the protected-resource metadata
463
+ * URL, so tool handlers can emit in-band auth challenges.
322
464
  *
323
- * @example
324
- * ```ts
325
- * server.useOnError((err, _req, _res, next) => {
326
- * logger.error(err);
327
- * next(err);
328
- * });
329
- * ```
465
+ * @internal
330
466
  */
331
- useOnError(...handlers: ErrorRequestHandler[]): this;
332
- useOnError(path: string, ...handlers: ErrorRequestHandler[]): this;
467
+ setResourceMetadataUrlResolver(resolve: ResourceMetadataUrlResolver): this;
468
+ private setupSkills;
333
469
  /** Register MCP protocol-level middleware (catch-all). */
334
- mcpMiddleware(handler: McpMiddlewareFn): this;
470
+ mcpMiddleware(handler: McpMiddlewareFn<TAuthExtra>): this;
335
471
  /** Register MCP protocol-level middleware for all requests (`extra` is `McpExtra`). */
336
472
  mcpMiddleware(filter: "request", handler: (request: {
337
473
  method: string;
338
474
  params: Record<string, unknown>;
339
- }, extra: McpExtra, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
475
+ }, extra: McpExtra<TAuthExtra>, next: () => Promise<ServerResult>) => Promise<unknown> | unknown): this;
340
476
  /** Register MCP protocol-level middleware for all notifications (`extra` is `undefined`). */
341
477
  mcpMiddleware(filter: "notification", handler: (request: {
342
478
  method: string;
@@ -346,7 +482,7 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
346
482
  * Register MCP protocol-level middleware for an exact method.
347
483
  * Narrows `params`, `extra`, and `next()` result based on the method string.
348
484
  */
349
- mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M>): this;
485
+ mcpMiddleware<M extends McpMethodString>(filter: M, handler: McpTypedMiddlewareFn<M, TAuthExtra>): this;
350
486
  /**
351
487
  * Register MCP protocol-level middleware for a wildcard pattern (e.g. `"tools/*"`).
352
488
  * `next()` returns the union of result types for matching methods.
@@ -354,49 +490,22 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
354
490
  mcpMiddleware<W extends McpWildcard>(filter: W, handler: (request: {
355
491
  method: string;
356
492
  params: Record<string, unknown>;
357
- }, extra: McpExtraFor<W>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
493
+ }, extra: McpExtraFor<W, TAuthExtra>, next: () => Promise<McpResultFor<W>>) => Promise<unknown> | unknown): this;
358
494
  /**
359
495
  * Register MCP protocol-level middleware with a method filter.
360
496
  * Filter can be an exact method (`"tools/call"`), wildcard (`"tools/*"`),
361
497
  * category (`"request"` | `"notification"`), or an array of those.
362
498
  */
363
- mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn): this;
364
- private applyMcpMiddleware;
365
- /**
366
- * Connect to an MCP transport (override of the SDK's `connect`). Use this
367
- * when you're embedding Skybridge in a host that already manages its own
368
- * transport (e.g. stdio for desktop apps); for HTTP, prefer {@link McpServer.run}
369
- * which sets the transport up for you. Locks in any middleware registered
370
- * via {@link McpServer.mcpMiddleware} — further calls to that method will
371
- * throw afterwards.
372
- */
373
- connect(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
499
+ mcpMiddleware(filter: McpMiddlewareFilter, handler: McpMiddlewareFn<TAuthExtra>): this;
374
500
  /**
375
- * Per-request stateless connect. The SDK's `Protocol` only allows one
376
- * transport per instance, so we can't reuse this `McpServer` across
377
- * concurrent requests. The SDK's idiomatic fix is a `() => McpServer`
378
- * factory, but that would break Skybridge's singleton API — so instead
379
- * we build a fresh underlying `Server` per request and share the main
380
- * server's handler maps by reference. The cast is unavoidable: there's
381
- * no public API to inject handler maps. `getHandlerMaps` validates the
382
- * read side and fails fast on SDK field renames.
383
- */
384
- connectStatelessTransport(transport: Parameters<typeof McpServerBase.prototype.connect>[0]): Promise<void>;
385
- /**
386
- * Start the HTTP server. Listens on `process.env.__PORT` (default `3000`),
387
- * mounts the `/mcp` route, applies any custom Express middleware registered
388
- * via {@link McpServer.use} / {@link McpServer.useOnError}, and locks in
389
- * any MCP middleware registered via {@link McpServer.mcpMiddleware}.
501
+ * This instance's protocol-level middleware: the framework's own entries
502
+ * (view `_meta` on `resources/list`, version-agnostic view resolution on
503
+ * `resources/read`, the top-level `securitySchemes` mirror on `tools/list`)
504
+ * followed by the ones registered via {@link McpServer.mcpMiddleware}.
390
505
  *
391
- * On Cloudflare Workers / workerd, returns an object exposing `fetch` so
392
- * the runtime can bridge incoming requests to the Node HTTP server. On
393
- * Vercel (`VERCEL === "1"`), returns the Express app directly so the
394
- * serverless function entry can call it as a `(req, res)` handler. On
395
- * Node, returns `undefined` once listening.
506
+ * @internal
396
507
  */
397
- run(): Promise<{
398
- fetch: (...args: unknown[]) => unknown;
399
- } | Express | undefined>;
508
+ protocolMiddlewareEntries(): McpMiddlewareEntry[];
400
509
  private enforceOneToolPerView;
401
510
  private resolveViewRequestContext;
402
511
  private registerViewResources;
@@ -416,6 +525,104 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
416
525
  file: string;
417
526
  }>): this;
418
527
  private readManifest;
528
+ /**
529
+ * @experimental Register an MCP Events type that hosts can subscribe to, per
530
+ * the Triggers & Events working group draft. Skybridge serves `events/list`,
531
+ * `events/subscribe` and `events/unsubscribe`, checks auth and arguments,
532
+ * verifies the callback URL, then hands each subscription to `onSubscribe`.
533
+ * Delivering the events is up to you, for example with {@link deliverEvent}.
534
+ * API may change.
535
+ *
536
+ * @example
537
+ * ```ts
538
+ * server.registerEvent(
539
+ * {
540
+ * name: "comment.created",
541
+ * description: "Fires when someone comments on a document",
542
+ * inputSchema: { documentId: z.string() },
543
+ * payloadSchema: { documentId: z.string(), excerpt: z.string() },
544
+ * },
545
+ * {
546
+ * onSubscribe: ({ documentId }, { subscription }) =>
547
+ * webhooks.upsert({ ...subscription, filter: { documentId } }),
548
+ * onUnsubscribe: (_args, { subscription }) =>
549
+ * webhooks.remove(subscription.id),
550
+ * },
551
+ * );
552
+ * ```
553
+ *
554
+ * @see https://docs.skybridge.tech/api-reference/register-event
555
+ */
556
+ registerEvent<TInput extends Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON = Record<never, StandardSchemaWithJSON>>(config: EventConfig<TInput>, hooks: EventHooks<InferEventSchema<TInput>, McpExtra<TAuthExtra>>): this;
557
+ /**
558
+ * Register a ChatGPT file viewer, from the OpenAI MCP extensions: a tool
559
+ * with a file entrypoint for `extensions` and a view. ChatGPT desktop calls
560
+ * it with the file the user opened, as `{ file: { name, resourceUri } }`.
561
+ * Read and save the file from the view with `useFileResource`.
562
+ *
563
+ * @example
564
+ * ```ts
565
+ * server.registerFileViewer(
566
+ * {
567
+ * name: "part-viewer",
568
+ * title: "Part Viewer",
569
+ * extensions: [".stl", ".step"],
570
+ * view: { component: "part-viewer" },
571
+ * },
572
+ * async ({ file }) => ({ structuredContent: { name: file.name } }),
573
+ * );
574
+ * ```
575
+ *
576
+ * @see https://docs.skybridge.tech/api-reference/register-file-viewer
577
+ */
578
+ registerFileViewer<TName extends string, TReturn extends {
579
+ content?: HandlerContent;
580
+ }>(config: OpenAIFileViewerConfig<TName>, cb: ToolHandler<FileEntrypointInput, TReturn, TAuthExtra>): AddTool<TTools, TName, FileEntrypointInput, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
581
+ /**
582
+ * Register the composer at-mention search for ChatGPT, from the OpenAI MCP
583
+ * extensions. When the user types `@` and your app name, ChatGPT calls
584
+ * `handler` with the typed text and lists the returned resource links.
585
+ * Skybridge registers it as a tool hidden from the model.
586
+ *
587
+ * @example
588
+ * ```ts
589
+ * server.registerMentions({
590
+ * name: "search_parts",
591
+ * handler: async ({ query }) => ({
592
+ * items: findParts(query).map((part) => ({
593
+ * type: "resource_link",
594
+ * uri: `parts://${part.id}`,
595
+ * name: part.name,
596
+ * })),
597
+ * }),
598
+ * });
599
+ * ```
600
+ *
601
+ * @see https://docs.skybridge.tech/api-reference/register-mentions
602
+ */
603
+ registerMentions(config: OpenAIMentionsConfig<TAuthExtra>): this;
604
+ /**
605
+ * Register app settings for ChatGPT, from the OpenAI MCP extensions.
606
+ * Skybridge registers a read tool and an update tool from `fields`, and
607
+ * advertises them in the `openai/settings` server capability. ChatGPT shows
608
+ * the settings page and calls `update` with the changed fields only. Store
609
+ * the values yourself, for example per user.
610
+ *
611
+ * @example
612
+ * ```ts
613
+ * server.registerSettings({
614
+ * fields: {
615
+ * units: { title: "Units", schema: z.enum(["mm", "in"]) },
616
+ * showGrid: { title: "Show grid", schema: z.boolean() },
617
+ * },
618
+ * read: (extra) => loadSettings(extra),
619
+ * update: (set, extra) => saveSettings(set, extra),
620
+ * });
621
+ * ```
622
+ *
623
+ * @see https://docs.skybridge.tech/api-reference/register-settings
624
+ */
625
+ registerSettings<TFields extends Record<string, OpenAISettingsField>>(config: OpenAISettingsConfig<TFields, TAuthExtra>): this;
419
626
  /**
420
627
  * Register a tool. Pass a `config` describing the tool (name, schemas,
421
628
  * optional {@link ViewConfig}, optional {@link ToolMeta}) and a handler that
@@ -445,11 +652,13 @@ export declare class McpServer<TTools extends Record<string, ToolDef> = Record<n
445
652
  *
446
653
  * @see https://docs.skybridge.tech/api-reference/register-tool
447
654
  */
448
- registerTool<TName extends string, InputArgs extends ZodRawShapeCompat, TReturn extends {
655
+ registerTool<TName extends string, InputArgs extends Record<string, StandardSchemaWithJSON>, TReturn extends {
449
656
  content?: HandlerContent;
450
657
  }>(config: ToolConfig<InputArgs> & {
451
658
  name: TName;
452
- }, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>>;
453
- registerTool<InputArgs extends ZodRawShapeCompat>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs>): this;
659
+ }, cb: ToolHandler<InputArgs, TReturn, TAuthExtra>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>, ExtractMeta<TReturn>, TAuthExtra>;
660
+ registerTool<InputArgs extends Record<string, StandardSchemaWithJSON>>(config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, {
661
+ content?: HandlerContent;
662
+ }, TAuthExtra>): this;
454
663
  }
455
664
  export {};