skybridge 0.0.0-dev.d338619 → 0.0.0-dev.d33e6f5

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 (513) hide show
  1. package/README.md +126 -124
  2. package/dist/cli/build-helpers.d.ts +11 -0
  3. package/dist/cli/build-helpers.js +115 -0
  4. package/dist/cli/build-helpers.js.map +1 -0
  5. package/dist/cli/build-helpers.test.js +156 -0
  6. package/dist/cli/build-helpers.test.js.map +1 -0
  7. package/dist/cli/build-steps.d.ts +2 -0
  8. package/dist/cli/build-steps.js +84 -0
  9. package/dist/cli/build-steps.js.map +1 -0
  10. package/dist/cli/build-steps.test.js +72 -0
  11. package/dist/cli/build-steps.test.js.map +1 -0
  12. package/dist/cli/detect-port.d.ts +2 -2
  13. package/dist/cli/detect-port.js +8 -20
  14. package/dist/cli/detect-port.js.map +1 -1
  15. package/dist/cli/header.d.ts +1 -1
  16. package/dist/cli/header.js.map +1 -1
  17. package/dist/cli/resolve-skybridge-config.d.ts +6 -0
  18. package/dist/cli/resolve-skybridge-config.js +28 -0
  19. package/dist/cli/resolve-skybridge-config.js.map +1 -0
  20. package/dist/cli/run-command.js.map +1 -1
  21. package/dist/cli/run-plain.d.ts +18 -0
  22. package/dist/cli/run-plain.js +90 -0
  23. package/dist/cli/run-plain.js.map +1 -0
  24. package/dist/cli/telemetry.js +2 -0
  25. package/dist/cli/telemetry.js.map +1 -1
  26. package/dist/cli/tunnel-control-server.d.ts +9 -0
  27. package/dist/cli/tunnel-control-server.js +31 -0
  28. package/dist/cli/tunnel-control-server.js.map +1 -0
  29. package/dist/cli/tunnel-control-server.test.js +39 -0
  30. package/dist/cli/tunnel-control-server.test.js.map +1 -0
  31. package/dist/cli/tunnel-handler.d.ts +3 -0
  32. package/dist/cli/tunnel-handler.js +48 -0
  33. package/dist/cli/tunnel-handler.js.map +1 -0
  34. package/dist/cli/tunnel-handler.test.js +105 -0
  35. package/dist/cli/tunnel-handler.test.js.map +1 -0
  36. package/dist/cli/tunnel.d.ts +57 -0
  37. package/dist/cli/tunnel.js +154 -0
  38. package/dist/cli/tunnel.js.map +1 -0
  39. package/dist/cli/tunnel.test.js +190 -0
  40. package/dist/cli/tunnel.test.js.map +1 -0
  41. package/dist/cli/types.js.map +1 -1
  42. package/dist/cli/use-execute-steps.d.ts +1 -1
  43. package/dist/cli/use-execute-steps.js.map +1 -1
  44. package/dist/cli/use-messages.js.map +1 -1
  45. package/dist/cli/use-nodemon.d.ts +25 -1
  46. package/dist/cli/use-nodemon.js +97 -55
  47. package/dist/cli/use-nodemon.js.map +1 -1
  48. package/dist/cli/use-open-browser.d.ts +1 -0
  49. package/dist/cli/use-open-browser.js +44 -0
  50. package/dist/cli/use-open-browser.js.map +1 -0
  51. package/dist/cli/use-tunnel.d.ts +1 -1
  52. package/dist/cli/use-tunnel.js +102 -68
  53. package/dist/cli/use-tunnel.js.map +1 -1
  54. package/dist/cli/use-typescript-check.d.ts +9 -2
  55. package/dist/cli/use-typescript-check.js +91 -51
  56. package/dist/cli/use-typescript-check.js.map +1 -1
  57. package/dist/commands/build.d.ts +0 -3
  58. package/dist/commands/build.js +2 -38
  59. package/dist/commands/build.js.map +1 -1
  60. package/dist/commands/create.d.ts +9 -0
  61. package/dist/commands/create.js +30 -0
  62. package/dist/commands/create.js.map +1 -0
  63. package/dist/commands/dev.d.ts +2 -0
  64. package/dist/commands/dev.js +84 -5
  65. package/dist/commands/dev.js.map +1 -1
  66. package/dist/commands/start.js +7 -1
  67. package/dist/commands/start.js.map +1 -1
  68. package/dist/commands/telemetry/disable.js.map +1 -1
  69. package/dist/commands/telemetry/enable.js.map +1 -1
  70. package/dist/commands/telemetry/status.js.map +1 -1
  71. package/dist/context-warnings.d.ts +5 -0
  72. package/dist/context-warnings.js +31 -0
  73. package/dist/context-warnings.js.map +1 -0
  74. package/dist/context-warnings.test.js +28 -0
  75. package/dist/context-warnings.test.js.map +1 -0
  76. package/dist/server/app.d.ts +211 -0
  77. package/dist/server/app.js +277 -0
  78. package/dist/server/app.js.map +1 -0
  79. package/dist/server/app.test.d.ts +1 -0
  80. package/dist/server/app.test.js +178 -0
  81. package/dist/server/app.test.js.map +1 -0
  82. package/dist/server/asset-base-url-transform-plugin.d.ts +1 -0
  83. package/dist/server/asset-base-url-transform-plugin.js +17 -2
  84. package/dist/server/asset-base-url-transform-plugin.js.map +1 -1
  85. package/dist/server/asset-base-url-transform-plugin.test.js +80 -1
  86. package/dist/server/asset-base-url-transform-plugin.test.js.map +1 -1
  87. package/dist/server/auth/discovery.d.ts +33 -0
  88. package/dist/server/auth/discovery.js +56 -0
  89. package/dist/server/auth/discovery.js.map +1 -0
  90. package/dist/server/auth/discovery.test.d.ts +1 -0
  91. package/dist/server/auth/discovery.test.js +93 -0
  92. package/dist/server/auth/discovery.test.js.map +1 -0
  93. package/dist/server/auth/index.d.ts +48 -0
  94. package/dist/server/auth/index.js +2 -0
  95. package/dist/server/auth/index.js.map +1 -0
  96. package/dist/server/auth/providers/auth0.d.ts +40 -0
  97. package/dist/server/auth/providers/auth0.js +36 -0
  98. package/dist/server/auth/providers/auth0.js.map +1 -0
  99. package/dist/server/auth/providers/auth0.test.d.ts +1 -0
  100. package/dist/server/auth/providers/auth0.test.js +50 -0
  101. package/dist/server/auth/providers/auth0.test.js.map +1 -0
  102. package/dist/server/auth/providers/authplane.d.ts +49 -0
  103. package/dist/server/auth/providers/authplane.js +57 -0
  104. package/dist/server/auth/providers/authplane.js.map +1 -0
  105. package/dist/server/auth/providers/authplane.test.d.ts +1 -0
  106. package/dist/server/auth/providers/authplane.test.js +143 -0
  107. package/dist/server/auth/providers/authplane.test.js.map +1 -0
  108. package/dist/server/auth/providers/clerk.d.ts +51 -0
  109. package/dist/server/auth/providers/clerk.js +19 -0
  110. package/dist/server/auth/providers/clerk.js.map +1 -0
  111. package/dist/server/auth/providers/clerk.test.d.ts +1 -0
  112. package/dist/server/auth/providers/clerk.test.js +30 -0
  113. package/dist/server/auth/providers/clerk.test.js.map +1 -0
  114. package/dist/server/auth/providers/custom.d.ts +42 -0
  115. package/dist/server/auth/providers/custom.js +59 -0
  116. package/dist/server/auth/providers/custom.js.map +1 -0
  117. package/dist/server/auth/providers/custom.test.d.ts +1 -0
  118. package/dist/server/auth/providers/custom.test.js +161 -0
  119. package/dist/server/auth/providers/custom.test.js.map +1 -0
  120. package/dist/server/auth/providers/descope.d.ts +44 -0
  121. package/dist/server/auth/providers/descope.js +44 -0
  122. package/dist/server/auth/providers/descope.js.map +1 -0
  123. package/dist/server/auth/providers/descope.test.d.ts +1 -0
  124. package/dist/server/auth/providers/descope.test.js +62 -0
  125. package/dist/server/auth/providers/descope.test.js.map +1 -0
  126. package/dist/server/auth/providers/shared.d.ts +2 -0
  127. package/dist/server/auth/providers/shared.js +6 -0
  128. package/dist/server/auth/providers/shared.js.map +1 -0
  129. package/dist/server/auth/providers/shared.test.d.ts +1 -0
  130. package/dist/server/auth/providers/shared.test.js +10 -0
  131. package/dist/server/auth/providers/shared.test.js.map +1 -0
  132. package/dist/server/auth/providers/stytch.d.ts +25 -0
  133. package/dist/server/auth/providers/stytch.js +16 -0
  134. package/dist/server/auth/providers/stytch.js.map +1 -0
  135. package/dist/server/auth/providers/verify-spy.d.ts +12 -0
  136. package/dist/server/auth/providers/verify-spy.js +21 -0
  137. package/dist/server/auth/providers/verify-spy.js.map +1 -0
  138. package/dist/server/auth/providers/workos.d.ts +34 -0
  139. package/dist/server/auth/providers/workos.js +16 -0
  140. package/dist/server/auth/providers/workos.js.map +1 -0
  141. package/dist/server/auth/security-schemes.d.ts +23 -0
  142. package/dist/server/auth/security-schemes.js +64 -0
  143. package/dist/server/auth/security-schemes.js.map +1 -0
  144. package/dist/server/auth/security-schemes.test.d.ts +1 -0
  145. package/dist/server/auth/security-schemes.test.js +99 -0
  146. package/dist/server/auth/security-schemes.test.js.map +1 -0
  147. package/dist/server/auth/setup.d.ts +6 -0
  148. package/dist/server/auth/setup.js +91 -0
  149. package/dist/server/auth/setup.js.map +1 -0
  150. package/dist/server/auth/setup.test.d.ts +1 -0
  151. package/dist/server/auth/setup.test.js +514 -0
  152. package/dist/server/auth/setup.test.js.map +1 -0
  153. package/dist/server/auth/verify.d.ts +48 -0
  154. package/dist/server/auth/verify.js +62 -0
  155. package/dist/server/auth/verify.js.map +1 -0
  156. package/dist/server/auth/verify.test.d.ts +1 -0
  157. package/dist/server/auth/verify.test.js +165 -0
  158. package/dist/server/auth/verify.test.js.map +1 -0
  159. package/dist/server/auth-extra.test-d.d.ts +1 -0
  160. package/dist/server/auth-extra.test-d.js +130 -0
  161. package/dist/server/auth-extra.test-d.js.map +1 -0
  162. package/dist/server/auth.d.ts +57 -0
  163. package/dist/server/auth.js +27 -0
  164. package/dist/server/auth.js.map +1 -0
  165. package/dist/server/build-manifest.test.d.ts +1 -0
  166. package/dist/server/build-manifest.test.js +28 -0
  167. package/dist/server/build-manifest.test.js.map +1 -0
  168. package/dist/server/content-helpers.d.ts +41 -1
  169. package/dist/server/content-helpers.js +33 -0
  170. package/dist/server/content-helpers.js.map +1 -1
  171. package/dist/server/content-helpers.test.js.map +1 -1
  172. package/dist/server/events.d.ts +113 -0
  173. package/dist/server/events.js +318 -0
  174. package/dist/server/events.js.map +1 -0
  175. package/dist/server/events.test.d.ts +1 -0
  176. package/dist/server/events.test.js +172 -0
  177. package/dist/server/events.test.js.map +1 -0
  178. package/dist/server/express.d.ts +24 -7
  179. package/dist/server/express.js +66 -30
  180. package/dist/server/express.js.map +1 -1
  181. package/dist/server/express.test.js +472 -71
  182. package/dist/server/express.test.js.map +1 -1
  183. package/dist/server/file-ref.d.ts +28 -0
  184. package/dist/server/file-ref.js +27 -0
  185. package/dist/server/file-ref.js.map +1 -0
  186. package/dist/server/form-input.d.ts +120 -0
  187. package/dist/server/form-input.js +89 -0
  188. package/dist/server/form-input.js.map +1 -0
  189. package/dist/server/host.d.ts +2 -0
  190. package/dist/server/host.js +11 -0
  191. package/dist/server/host.js.map +1 -0
  192. package/dist/server/host.test.d.ts +1 -0
  193. package/dist/server/host.test.js +13 -0
  194. package/dist/server/host.test.js.map +1 -0
  195. package/dist/server/index.d.ts +20 -2
  196. package/dist/server/index.js +17 -1
  197. package/dist/server/index.js.map +1 -1
  198. package/dist/server/inferUtilityTypes.d.ts +6 -6
  199. package/dist/server/inferUtilityTypes.js.map +1 -1
  200. package/dist/server/mcp-errors.test.d.ts +1 -0
  201. package/dist/server/mcp-errors.test.js +229 -0
  202. package/dist/server/mcp-errors.test.js.map +1 -0
  203. package/dist/server/metric.d.ts +5 -3
  204. package/dist/server/metric.js +5 -5
  205. package/dist/server/metric.js.map +1 -1
  206. package/dist/server/middleware.d.ts +51 -13
  207. package/dist/server/middleware.js +33 -0
  208. package/dist/server/middleware.js.map +1 -1
  209. package/dist/server/middleware.test-d.js +1 -1
  210. package/dist/server/middleware.test-d.js.map +1 -1
  211. package/dist/server/middleware.test.js +242 -134
  212. package/dist/server/middleware.test.js.map +1 -1
  213. package/dist/server/register-tool.test.d.ts +1 -0
  214. package/dist/server/register-tool.test.js +230 -0
  215. package/dist/server/register-tool.test.js.map +1 -0
  216. package/dist/server/requestOrigin.d.ts +7 -0
  217. package/dist/server/requestOrigin.js +25 -0
  218. package/dist/server/requestOrigin.js.map +1 -0
  219. package/dist/server/server.d.ts +550 -42
  220. package/dist/server/server.js +702 -260
  221. package/dist/server/server.js.map +1 -1
  222. package/dist/server/skills-integration.test.d.ts +1 -0
  223. package/dist/server/skills-integration.test.js +86 -0
  224. package/dist/server/skills-integration.test.js.map +1 -0
  225. package/dist/server/skills.d.ts +27 -0
  226. package/dist/server/skills.js +188 -0
  227. package/dist/server/skills.js.map +1 -0
  228. package/dist/server/skills.test.d.ts +1 -0
  229. package/dist/server/skills.test.js +243 -0
  230. package/dist/server/skills.test.js.map +1 -0
  231. package/dist/server/templateHelper.d.ts +1 -5
  232. package/dist/server/templateHelper.js +3 -22
  233. package/dist/server/templateHelper.js.map +1 -1
  234. package/dist/server/templates.generated.d.ts +4 -0
  235. package/dist/server/templates.generated.js +57 -0
  236. package/dist/server/templates.generated.js.map +1 -0
  237. package/dist/server/tool-extra.test.d.ts +1 -0
  238. package/dist/server/tool-extra.test.js +167 -0
  239. package/dist/server/tool-extra.test.js.map +1 -0
  240. package/dist/server/tunnel-proxy-router.d.ts +7 -0
  241. package/dist/server/tunnel-proxy-router.js +110 -0
  242. package/dist/server/tunnel-proxy-router.js.map +1 -0
  243. package/dist/server/tunnel-proxy-router.test.d.ts +1 -0
  244. package/dist/server/tunnel-proxy-router.test.js +229 -0
  245. package/dist/server/tunnel-proxy-router.test.js.map +1 -0
  246. package/dist/server/view-name.test-d.d.ts +1 -0
  247. package/dist/server/view-name.test-d.js +8 -0
  248. package/dist/server/view-name.test-d.js.map +1 -0
  249. package/dist/server/view-resource-resolution.test.d.ts +6 -0
  250. package/dist/server/view-resource-resolution.test.js +211 -0
  251. package/dist/server/view-resource-resolution.test.js.map +1 -0
  252. package/dist/server/viewsDevServer.js +4 -1
  253. package/dist/server/viewsDevServer.js.map +1 -1
  254. package/dist/test/utils.d.ts +9 -11
  255. package/dist/test/utils.js +220 -201
  256. package/dist/test/utils.js.map +1 -1
  257. package/dist/test/view.test.js +199 -113
  258. package/dist/test/view.test.js.map +1 -1
  259. package/dist/version.js +1 -3
  260. package/dist/version.js.map +1 -1
  261. package/dist/views/index.d.ts +10 -0
  262. package/dist/views/index.js +3 -0
  263. package/dist/views/index.js.map +1 -0
  264. package/dist/{web/plugin → views}/scan-views.d.ts +8 -0
  265. package/dist/{web/plugin → views}/scan-views.js +26 -8
  266. package/dist/views/scan-views.js.map +1 -0
  267. package/dist/views/scan-views.test.d.ts +1 -0
  268. package/dist/{web/plugin → views}/scan-views.test.js +33 -1
  269. package/dist/views/scan-views.test.js.map +1 -0
  270. package/dist/views/validate-view.d.ts +1 -0
  271. package/dist/{web/plugin → views}/validate-view.js +2 -2
  272. package/dist/views/validate-view.js.map +1 -0
  273. package/dist/views/validate-view.test.d.ts +1 -0
  274. package/dist/views/validate-view.test.js.map +1 -0
  275. package/dist/web/bridges/adaptor.d.ts +62 -0
  276. package/dist/web/bridges/adaptor.js +480 -0
  277. package/dist/web/bridges/adaptor.js.map +1 -0
  278. package/dist/web/bridges/adaptor.test.d.ts +1 -0
  279. package/dist/web/bridges/adaptor.test.js +292 -0
  280. package/dist/web/bridges/adaptor.test.js.map +1 -0
  281. package/dist/web/bridges/apps-sdk/bridge.d.ts +6 -1
  282. package/dist/web/bridges/apps-sdk/bridge.js +15 -3
  283. package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
  284. package/dist/web/bridges/apps-sdk/index.d.ts +0 -1
  285. package/dist/web/bridges/apps-sdk/index.js +0 -1
  286. package/dist/web/bridges/apps-sdk/index.js.map +1 -1
  287. package/dist/web/bridges/apps-sdk/types.d.ts +11 -5
  288. package/dist/web/bridges/apps-sdk/types.js.map +1 -1
  289. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +11 -0
  290. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +11 -0
  291. package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
  292. package/dist/web/bridges/get-adaptor.d.ts +7 -0
  293. package/dist/web/bridges/get-adaptor.js +9 -7
  294. package/dist/web/bridges/get-adaptor.js.map +1 -1
  295. package/dist/web/bridges/get-adaptor.test.d.ts +1 -0
  296. package/dist/web/bridges/get-adaptor.test.js +32 -0
  297. package/dist/web/bridges/get-adaptor.test.js.map +1 -0
  298. package/dist/web/bridges/index.js.map +1 -1
  299. package/dist/web/bridges/mcp-app/bridge.d.ts +15 -2
  300. package/dist/web/bridges/mcp-app/bridge.js +80 -7
  301. package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
  302. package/dist/web/bridges/mcp-app/bridge.test.d.ts +1 -0
  303. package/dist/web/bridges/mcp-app/bridge.test.js +17 -0
  304. package/dist/web/bridges/mcp-app/bridge.test.js.map +1 -0
  305. package/dist/web/bridges/mcp-app/index.d.ts +0 -1
  306. package/dist/web/bridges/mcp-app/index.js +0 -1
  307. package/dist/web/bridges/mcp-app/index.js.map +1 -1
  308. package/dist/web/bridges/mcp-app/types.d.ts +19 -2
  309. package/dist/web/bridges/mcp-app/types.js.map +1 -1
  310. package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +13 -1
  311. package/dist/web/bridges/mcp-app/use-mcp-app-context.js +12 -0
  312. package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
  313. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js +1 -1
  314. package/dist/web/bridges/mcp-app/use-mcp-app-context.test.js.map +1 -1
  315. package/dist/web/bridges/mcp-app/view-tools.test.d.ts +1 -0
  316. package/dist/web/bridges/mcp-app/view-tools.test.js +143 -0
  317. package/dist/web/bridges/mcp-app/view-tools.test.js.map +1 -0
  318. package/dist/web/bridges/types.d.ts +174 -11
  319. package/dist/web/bridges/types.js +14 -1
  320. package/dist/web/bridges/types.js.map +1 -1
  321. package/dist/web/bridges/types.test.d.ts +1 -0
  322. package/dist/web/bridges/types.test.js +19 -0
  323. package/dist/web/bridges/types.test.js.map +1 -0
  324. package/dist/web/bridges/use-host-context.d.ts +5 -0
  325. package/dist/web/bridges/use-host-context.js +5 -0
  326. package/dist/web/bridges/use-host-context.js.map +1 -1
  327. package/dist/web/components/modal-provider.d.ts +1 -1
  328. package/dist/web/components/modal-provider.js +4 -3
  329. package/dist/web/components/modal-provider.js.map +1 -1
  330. package/dist/web/create-store.d.ts +26 -0
  331. package/dist/web/create-store.js +35 -9
  332. package/dist/web/create-store.js.map +1 -1
  333. package/dist/web/create-store.test.js +24 -23
  334. package/dist/web/create-store.test.js.map +1 -1
  335. package/dist/web/data-llm.d.ts +35 -2
  336. package/dist/web/data-llm.js +34 -5
  337. package/dist/web/data-llm.js.map +1 -1
  338. package/dist/web/data-llm.test.js +48 -29
  339. package/dist/web/data-llm.test.js.map +1 -1
  340. package/dist/web/generate-helpers.d.ts +25 -19
  341. package/dist/web/generate-helpers.js +23 -17
  342. package/dist/web/generate-helpers.js.map +1 -1
  343. package/dist/web/generate-helpers.test-d.js +14 -12
  344. package/dist/web/generate-helpers.test-d.js.map +1 -1
  345. package/dist/web/generate-helpers.test.js +2 -2
  346. package/dist/web/generate-helpers.test.js.map +1 -1
  347. package/dist/web/helpers/state.d.ts +2 -2
  348. package/dist/web/helpers/state.js +11 -11
  349. package/dist/web/helpers/state.js.map +1 -1
  350. package/dist/web/helpers/state.test.js +9 -9
  351. package/dist/web/helpers/state.test.js.map +1 -1
  352. package/dist/web/hooks/index.d.ts +11 -2
  353. package/dist/web/hooks/index.js +11 -2
  354. package/dist/web/hooks/index.js.map +1 -1
  355. package/dist/web/hooks/openai-extensions.test.d.ts +1 -0
  356. package/dist/web/hooks/openai-extensions.test.js +107 -0
  357. package/dist/web/hooks/openai-extensions.test.js.map +1 -0
  358. package/dist/web/hooks/test/utils.d.ts +7 -2
  359. package/dist/web/hooks/test/utils.js +14 -3
  360. package/dist/web/hooks/test/utils.js.map +1 -1
  361. package/dist/web/hooks/use-call-tool.d.ts +47 -2
  362. package/dist/web/hooks/use-call-tool.js +43 -10
  363. package/dist/web/hooks/use-call-tool.js.map +1 -1
  364. package/dist/web/hooks/use-call-tool.test-d.js.map +1 -1
  365. package/dist/web/hooks/use-call-tool.test.js +75 -29
  366. package/dist/web/hooks/use-call-tool.test.js.map +1 -1
  367. package/dist/web/hooks/use-deep-link.d.ts +22 -0
  368. package/dist/web/hooks/use-deep-link.js +34 -0
  369. package/dist/web/hooks/use-deep-link.js.map +1 -0
  370. package/dist/web/hooks/use-display-mode.d.ts +20 -0
  371. package/dist/web/hooks/use-display-mode.js +20 -0
  372. package/dist/web/hooks/use-display-mode.js.map +1 -1
  373. package/dist/web/hooks/use-display-mode.test-d.js.map +1 -1
  374. package/dist/web/hooks/use-display-mode.test.js +57 -21
  375. package/dist/web/hooks/use-display-mode.test.js.map +1 -1
  376. package/dist/web/hooks/use-download.d.ts +3 -0
  377. package/dist/web/hooks/use-download.js +7 -0
  378. package/dist/web/hooks/use-download.js.map +1 -0
  379. package/dist/web/hooks/use-download.test.d.ts +1 -0
  380. package/dist/web/hooks/use-download.test.js +103 -0
  381. package/dist/web/hooks/use-download.test.js.map +1 -0
  382. package/dist/web/hooks/use-file-resource.d.ts +37 -0
  383. package/dist/web/hooks/use-file-resource.js +98 -0
  384. package/dist/web/hooks/use-file-resource.js.map +1 -0
  385. package/dist/web/hooks/use-file-resource.test.d.ts +1 -0
  386. package/dist/web/hooks/use-file-resource.test.js +65 -0
  387. package/dist/web/hooks/use-file-resource.test.js.map +1 -0
  388. package/dist/web/hooks/use-files.d.ts +32 -0
  389. package/dist/web/hooks/use-files.js +32 -0
  390. package/dist/web/hooks/use-files.js.map +1 -1
  391. package/dist/web/hooks/use-files.test.js +11 -3
  392. package/dist/web/hooks/use-files.test.js.map +1 -1
  393. package/dist/web/hooks/use-host.d.ts +44 -0
  394. package/dist/web/hooks/use-host.js +45 -0
  395. package/dist/web/hooks/use-host.js.map +1 -0
  396. package/dist/web/hooks/use-host.test.d.ts +1 -0
  397. package/dist/web/hooks/use-host.test.js +59 -0
  398. package/dist/web/hooks/use-host.test.js.map +1 -0
  399. package/dist/web/hooks/use-model-context.d.ts +44 -0
  400. package/dist/web/hooks/use-model-context.js +63 -0
  401. package/dist/web/hooks/use-model-context.js.map +1 -0
  402. package/dist/web/hooks/use-open-external.d.ts +17 -0
  403. package/dist/web/hooks/use-open-external.js +16 -0
  404. package/dist/web/hooks/use-open-external.js.map +1 -1
  405. package/dist/web/hooks/use-open-external.test.js +15 -5
  406. package/dist/web/hooks/use-open-external.test.js.map +1 -1
  407. package/dist/web/hooks/use-open-file.d.ts +20 -0
  408. package/dist/web/hooks/use-open-file.js +25 -0
  409. package/dist/web/hooks/use-open-file.js.map +1 -0
  410. package/dist/web/hooks/use-register-view-tool.d.ts +37 -0
  411. package/dist/web/hooks/use-register-view-tool.js +50 -0
  412. package/dist/web/hooks/use-register-view-tool.js.map +1 -0
  413. package/dist/web/hooks/use-request-close.d.ts +16 -0
  414. package/dist/web/hooks/use-request-close.js +21 -0
  415. package/dist/web/hooks/use-request-close.js.map +1 -0
  416. package/dist/web/hooks/use-request-close.test.d.ts +1 -0
  417. package/dist/web/hooks/use-request-close.test.js +47 -0
  418. package/dist/web/hooks/use-request-close.test.js.map +1 -0
  419. package/dist/web/hooks/use-request-modal.d.ts +16 -1
  420. package/dist/web/hooks/use-request-modal.js +19 -4
  421. package/dist/web/hooks/use-request-modal.js.map +1 -1
  422. package/dist/web/hooks/use-request-modal.test.js +12 -2
  423. package/dist/web/hooks/use-request-modal.test.js.map +1 -1
  424. package/dist/web/hooks/use-request-size.d.ts +20 -0
  425. package/dist/web/hooks/use-request-size.js +24 -0
  426. package/dist/web/hooks/use-request-size.js.map +1 -0
  427. package/dist/web/hooks/use-request-size.test.d.ts +1 -0
  428. package/dist/web/hooks/use-request-size.test.js +47 -0
  429. package/dist/web/hooks/use-request-size.test.js.map +1 -0
  430. package/dist/web/hooks/use-send-follow-up-message.d.ts +25 -1
  431. package/dist/web/hooks/use-send-follow-up-message.js +25 -2
  432. package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
  433. package/dist/web/hooks/use-set-open-in-app-url.d.ts +17 -0
  434. package/dist/web/hooks/use-set-open-in-app-url.js +17 -0
  435. package/dist/web/hooks/use-set-open-in-app-url.js.map +1 -1
  436. package/dist/web/hooks/use-set-open-in-app-url.test.js +26 -12
  437. package/dist/web/hooks/use-set-open-in-app-url.test.js.map +1 -1
  438. package/dist/web/hooks/use-tool-info.d.ts +46 -14
  439. package/dist/web/hooks/use-tool-info.js +29 -7
  440. package/dist/web/hooks/use-tool-info.js.map +1 -1
  441. package/dist/web/hooks/use-tool-info.test-d.js +11 -34
  442. package/dist/web/hooks/use-tool-info.test-d.js.map +1 -1
  443. package/dist/web/hooks/use-tool-info.test.js +42 -37
  444. package/dist/web/hooks/use-tool-info.test.js.map +1 -1
  445. package/dist/web/hooks/use-user.d.ts +5 -2
  446. package/dist/web/hooks/use-user.js +6 -3
  447. package/dist/web/hooks/use-user.js.map +1 -1
  448. package/dist/web/hooks/use-user.test.js +85 -37
  449. package/dist/web/hooks/use-user.test.js.map +1 -1
  450. package/dist/web/hooks/use-view-state.d.ts +25 -0
  451. package/dist/web/hooks/use-view-state.js +42 -0
  452. package/dist/web/hooks/use-view-state.js.map +1 -0
  453. package/dist/web/hooks/use-view-state.test.d.ts +1 -0
  454. package/dist/web/hooks/{use-widget-state.test.js → use-view-state.test.js} +56 -21
  455. package/dist/web/hooks/use-view-state.test.js.map +1 -0
  456. package/dist/web/hooks/use-viewport.d.ts +20 -0
  457. package/dist/web/hooks/use-viewport.js +21 -0
  458. package/dist/web/hooks/use-viewport.js.map +1 -0
  459. package/dist/web/hooks/use-viewport.test.d.ts +1 -0
  460. package/dist/web/hooks/use-viewport.test.js +109 -0
  461. package/dist/web/hooks/use-viewport.test.js.map +1 -0
  462. package/dist/web/index.d.ts +1 -3
  463. package/dist/web/index.js +1 -2
  464. package/dist/web/index.js.map +1 -1
  465. package/dist/web/mount-view.d.ts +21 -0
  466. package/dist/web/mount-view.js +41 -0
  467. package/dist/web/mount-view.js.map +1 -0
  468. package/dist/web/proxy.js.map +1 -1
  469. package/dist/web/types.d.ts +4 -0
  470. package/dist/web/types.js.map +1 -1
  471. package/package.json +47 -29
  472. package/dist/server/templates/development.hbs +0 -12
  473. package/dist/server/templates/production.hbs +0 -6
  474. package/dist/web/bridges/apps-sdk/adaptor.d.ts +0 -24
  475. package/dist/web/bridges/apps-sdk/adaptor.js +0 -87
  476. package/dist/web/bridges/apps-sdk/adaptor.js.map +0 -1
  477. package/dist/web/bridges/mcp-app/adaptor.d.ts +0 -48
  478. package/dist/web/bridges/mcp-app/adaptor.js +0 -268
  479. package/dist/web/bridges/mcp-app/adaptor.js.map +0 -1
  480. package/dist/web/hooks/use-layout.d.ts +0 -22
  481. package/dist/web/hooks/use-layout.js +0 -23
  482. package/dist/web/hooks/use-layout.js.map +0 -1
  483. package/dist/web/hooks/use-layout.test.js +0 -96
  484. package/dist/web/hooks/use-layout.test.js.map +0 -1
  485. package/dist/web/hooks/use-widget-state.d.ts +0 -4
  486. package/dist/web/hooks/use-widget-state.js +0 -32
  487. package/dist/web/hooks/use-widget-state.js.map +0 -1
  488. package/dist/web/hooks/use-widget-state.test.js.map +0 -1
  489. package/dist/web/mount-widget.d.ts +0 -1
  490. package/dist/web/mount-widget.js +0 -27
  491. package/dist/web/mount-widget.js.map +0 -1
  492. package/dist/web/plugin/data-llm.test.js +0 -81
  493. package/dist/web/plugin/data-llm.test.js.map +0 -1
  494. package/dist/web/plugin/plugin.d.ts +0 -5
  495. package/dist/web/plugin/plugin.js +0 -141
  496. package/dist/web/plugin/plugin.js.map +0 -1
  497. package/dist/web/plugin/scan-views.js.map +0 -1
  498. package/dist/web/plugin/scan-views.test.js.map +0 -1
  499. package/dist/web/plugin/transform-data-llm.d.ts +0 -12
  500. package/dist/web/plugin/transform-data-llm.js +0 -96
  501. package/dist/web/plugin/transform-data-llm.js.map +0 -1
  502. package/dist/web/plugin/transform-data-llm.test.js +0 -81
  503. package/dist/web/plugin/transform-data-llm.test.js.map +0 -1
  504. package/dist/web/plugin/validate-view.d.ts +0 -1
  505. package/dist/web/plugin/validate-view.js.map +0 -1
  506. package/dist/web/plugin/validate-view.test.js.map +0 -1
  507. /package/dist/{web/hooks/use-layout.test.d.ts → cli/build-helpers.test.d.ts} +0 -0
  508. /package/dist/{web/hooks/use-widget-state.test.d.ts → cli/build-steps.test.d.ts} +0 -0
  509. /package/dist/{web/plugin/data-llm.test.d.ts → cli/tunnel-control-server.test.d.ts} +0 -0
  510. /package/dist/{web/plugin/scan-views.test.d.ts → cli/tunnel-handler.test.d.ts} +0 -0
  511. /package/dist/{web/plugin/transform-data-llm.test.d.ts → cli/tunnel.test.d.ts} +0 -0
  512. /package/dist/{web/plugin/validate-view.test.d.ts → context-warnings.test.d.ts} +0 -0
  513. /package/dist/{web/plugin → views}/validate-view.test.js +0 -0
@@ -1,20 +1,67 @@
1
1
  import crypto from "node:crypto";
2
2
  import { readFileSync } from "node:fs";
3
- import http from "node:http";
4
3
  import path from "node:path";
5
- import { McpServer as McpServerBase } from "@modelcontextprotocol/sdk/server/mcp.js";
6
- import { mergeWith, union } from "es-toolkit";
7
- import { createApp } from "./express.js";
8
- import { createMiddlewareEntry } from "./metric.js";
9
- import { buildMiddlewareChain, getHandlerMaps } from "./middleware.js";
4
+ import { isInputRequiredResult, McpServer as McpServerBase, } from "@modelcontextprotocol/server";
5
+ import { z } from "zod/v4";
6
+ import { warnOnLargeToolOutput } from "../context-warnings.js";
7
+ import { authToSecuritySchemes, evaluateSecuritySchemes, inBandChallengeResult, } from "./auth/security-schemes.js";
8
+ import { EventRegistry, } from "./events.js";
9
+ import { hostFromUserAgent } from "./host.js";
10
+ import { captureToolError } from "./middleware.js";
11
+ import { resolveServerOrigin } from "./requestOrigin.js";
12
+ import { discoverSkills, registerSkills, SKILLS_EXTENSION_KEY, } from "./skills.js";
10
13
  import { templateHelper } from "./templateHelper.js";
11
- const mergeWithUnion = (target, source) => {
12
- return mergeWith(target, source, (targetVal, sourceVal) => {
13
- if (Array.isArray(targetVal) && Array.isArray(sourceVal)) {
14
- return union(targetVal, sourceVal);
15
- }
16
- });
14
+ const unionOf = (base, extra) => extra ? [...new Set([...base, ...extra])] : base;
15
+ function mergeOpenAIUi(meta, values) {
16
+ const defined = Object.fromEntries(Object.entries(values).filter(([, value]) => value !== undefined));
17
+ if (Object.keys(defined).length > 0) {
18
+ meta["openai/ui"] = { ...meta["openai/ui"], ...defined };
19
+ }
20
+ }
21
+ function acceptsEmptyInput(inputSchema) {
22
+ if (inputSchema === undefined) {
23
+ return true;
24
+ }
25
+ const checks = "~standard" in inputSchema
26
+ ? [inputSchema["~standard"].validate({})]
27
+ : Object.values(inputSchema).map((schema) => schema["~standard"].validate(undefined));
28
+ return checks.every((result) => result instanceof Promise || result.issues === undefined);
29
+ }
30
+ const SKILLS_DIR = "src/skills";
31
+ /**
32
+ * Normalize an `x-forwarded-prefix` value into a leading-slash, no-trailing-slash
33
+ * path. Takes the first hop of a comma-separated proxy chain.
34
+ * "/v1/", "v1", "/v1, /internal" → "/v1"; "", "/", undefined → "".
35
+ */
36
+ function normalizeForwardedPrefix(raw) {
37
+ const firstHop = raw?.split(",")[0]?.trim() ?? "";
38
+ const trimmed = firstHop.replace(/\/+$/, "");
39
+ if (trimmed === "") {
40
+ return "";
41
+ }
42
+ return trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
43
+ }
44
+ const fileEntrypointInput = {
45
+ file: z.object({
46
+ name: z.string().min(1),
47
+ resourceUri: z.string().trim().min(1),
48
+ }),
17
49
  };
50
+ /**
51
+ * Drop the query string from a `ui://` view URI, leaving the bare path. The
52
+ * `?v=` cache key is the only query we append, so a plain split is enough and
53
+ * sidesteps `URL` normalization quirks on the non-special `ui:` scheme.
54
+ */
55
+ function stripQuery(uri) {
56
+ const queryIndex = uri.indexOf("?");
57
+ return queryIndex === -1 ? uri : uri.slice(0, queryIndex);
58
+ }
59
+ /**
60
+ * Coerce a tool handler's return value into an MCP `content` array. Strings
61
+ * become a single `TextContent`; a single block is wrapped in an array;
62
+ * `undefined` produces `[]`. Mostly used internally — exported so consumers
63
+ * who build content lazily can apply the same normalization.
64
+ */
18
65
  export function normalizeContent(content) {
19
66
  if (content === undefined) {
20
67
  return [];
@@ -28,53 +75,147 @@ export function normalizeContent(content) {
28
75
  return [content];
29
76
  }
30
77
  const McpServerBaseOmitted = McpServerBase;
78
+ // Side channel populated by `dist/__entry.js` before user code is imported.
79
+ // Set at module scope rather than passed through the constructor because the
80
+ // wrapper has the manifest before the user's `new McpServer(...)` runs, and
81
+ // threading it through every call site (including user templates) is exactly
82
+ // the boilerplate this design is trying to hide.
83
+ let pendingBuildManifest = null;
84
+ /**
85
+ * Prime the build-time Vite manifest before user code constructs its
86
+ * `McpServer`. Called from the generated `dist/__entry.js`; not part of the
87
+ * user-facing API.
88
+ *
89
+ * @internal
90
+ */
91
+ export function __setBuildManifest(manifest) {
92
+ pendingBuildManifest = manifest;
93
+ }
94
+ let pendingSkillsManifest = null;
95
+ let cachedDiskManifest = null;
96
+ let discoveredSkills = null;
97
+ let warnedOnMissingSkills = false;
98
+ export function __setSkillsManifest(manifest) {
99
+ pendingSkillsManifest = manifest;
100
+ discoveredSkills = null;
101
+ }
102
+ // Pure and `this`-free so it can run inside the `super(...)` call, before `this`
103
+ // exists — the capability must be present for the `initialize` response.
104
+ function withSkillsCapability(options, skybridgeOptions) {
105
+ if (!skybridgeOptions?.skills) {
106
+ return options;
107
+ }
108
+ return {
109
+ ...options,
110
+ capabilities: {
111
+ ...options?.capabilities,
112
+ extensions: {
113
+ ...options?.capabilities?.extensions,
114
+ [SKILLS_EXTENSION_KEY]: { directoryRead: true },
115
+ },
116
+ },
117
+ };
118
+ }
119
+ /**
120
+ * Typed registration sugar over the MCP SDK's `McpServer`: a tool registry
121
+ * that carries input/output/meta shapes, view resources, per-tool security
122
+ * schemes, and prompt/resource registration. A {@link Skybridge} app builds
123
+ * one of these per request and hands it to your `handler`; chain
124
+ * {@link McpServer.registerTool} calls on it and return the result.
125
+ *
126
+ * The `TTools` generic accumulates each registered tool's input/output/meta
127
+ * shape, so `typeof app` carries enough information for view-side helpers
128
+ * like {@link generateHelpers} to produce fully-typed hooks.
129
+ *
130
+ * @typeParam TTools - Accumulated tool registry. Filled in by `registerTool`
131
+ * chaining; you almost never set this manually.
132
+ *
133
+ * @example
134
+ * ```ts
135
+ * export const app = new Skybridge({
136
+ * name: "my-app",
137
+ * version: "1.0.0",
138
+ * handler: (server) =>
139
+ * server.registerTool({
140
+ * name: "search",
141
+ * inputSchema: { query: z.string() },
142
+ * view: { component: "search" },
143
+ * }, async ({ query }) => ({ content: `Results for ${query}` })),
144
+ * });
145
+ * ```
146
+ *
147
+ * @see https://docs.skybridge.tech/api-reference/mcp-server
148
+ */
31
149
  export class McpServer extends McpServerBaseOmitted {
32
- express;
33
- customMiddleware = [];
34
- customErrorMiddleware = [];
35
- mcpMiddlewareEntries = [];
36
- mcpMiddlewareApplied = false;
37
150
  claimedViews = new Map();
38
- use(pathOrHandler, ...handlers) {
39
- if (typeof pathOrHandler === "string") {
40
- this.customMiddleware.push({
41
- path: pathOrHandler,
42
- handlers,
43
- });
44
- }
45
- else {
46
- this.customMiddleware.push({
47
- handlers: [pathOrHandler, ...handlers],
48
- });
151
+ viewMetaBuilders = new Map();
152
+ /**
153
+ * Maps a view resource's query-less path to its canonical registered URI
154
+ * (the one carrying the `?v=` cache key). Lets `resources/read` resolve the
155
+ * underlying view no matter which version param the consumer sends, since
156
+ * the param is only a cache key, not part of the resource's identity.
157
+ */
158
+ viewUriByPath = new Map();
159
+ viteManifest = null;
160
+ oauthEnabled = false;
161
+ resolveResourceMetadataUrl;
162
+ toolSecuritySchemes = new Map();
163
+ userMiddlewareEntries = [];
164
+ eventRegistry;
165
+ constructor(serverInfo, options, skybridgeOptions) {
166
+ super(serverInfo, withSkillsCapability(options, skybridgeOptions));
167
+ this.oauthEnabled = Boolean(skybridgeOptions?.oauth);
168
+ // Pick up the manifest if `dist/__entry.js` primed it before importing
169
+ // user code. Explicit `setViteManifest` calls still win because they
170
+ // happen after construction.
171
+ if (pendingBuildManifest) {
172
+ this.setViteManifest(pendingBuildManifest);
49
173
  }
174
+ this.setupSkills(Boolean(skybridgeOptions?.skills));
175
+ }
176
+ /**
177
+ * The per-tool security schemes collected during registration, keyed by tool
178
+ * name. Read by the OAuth layer to decide whether anonymous requests are
179
+ * allowed and which schemes gate a given `tools/call`.
180
+ *
181
+ * @internal
182
+ */
183
+ get securitySchemesByTool() {
184
+ return this.toolSecuritySchemes;
185
+ }
186
+ /**
187
+ * Inject the resolver the app uses to build the protected-resource metadata
188
+ * URL, so tool handlers can emit in-band auth challenges.
189
+ *
190
+ * @internal
191
+ */
192
+ setResourceMetadataUrlResolver(resolve) {
193
+ this.resolveResourceMetadataUrl = resolve;
50
194
  return this;
51
195
  }
52
- useOnError(pathOrHandler, ...handlers) {
53
- if (typeof pathOrHandler === "string") {
54
- this.customErrorMiddleware.push({ path: pathOrHandler, handlers });
196
+ setupSkills(enabled) {
197
+ if (!enabled) {
198
+ return;
55
199
  }
56
- else {
57
- this.customErrorMiddleware.push({
58
- handlers: [pathOrHandler, ...handlers],
59
- });
200
+ discoveredSkills ??= pendingSkillsManifest ?? discoverSkills(SKILLS_DIR);
201
+ if (discoveredSkills.length === 0 && !warnedOnMissingSkills) {
202
+ warnedOnMissingSkills = true;
203
+ console.warn(`skybridge: the "skills" option is enabled but no skills were found in "${SKILLS_DIR}". Add a <name>/SKILL.md there, or remove the option.`);
60
204
  }
61
- return this;
205
+ registerSkills(this, discoveredSkills);
62
206
  }
63
207
  mcpMiddleware(filterOrHandler,
64
208
  // biome-ignore lint/suspicious/noExplicitAny: overloads narrow the handler type at call sites; implementation must accept all variants
65
209
  maybeHandler) {
66
- if (this.mcpMiddlewareApplied) {
67
- throw new Error("Cannot register MCP middleware after run() or connect() has been called");
68
- }
69
210
  const handler = maybeHandler;
70
211
  if (typeof filterOrHandler === "function") {
71
- this.mcpMiddlewareEntries.push({
212
+ this.userMiddlewareEntries.push({
72
213
  filter: null,
73
214
  handler: filterOrHandler,
74
215
  });
75
216
  }
76
217
  else if (handler) {
77
- this.mcpMiddlewareEntries.push({
218
+ this.userMiddlewareEntries.push({
78
219
  filter: filterOrHandler,
79
220
  handler,
80
221
  });
@@ -84,55 +225,96 @@ export class McpServer extends McpServerBaseOmitted {
84
225
  }
85
226
  return this;
86
227
  }
87
- applyMcpMiddleware() {
88
- if (this.mcpMiddlewareApplied) {
89
- return;
90
- }
91
- this.mcpMiddlewareApplied = true;
92
- const monitoringEntry = createMiddlewareEntry();
93
- const entries = monitoringEntry
94
- ? [monitoringEntry, ...this.mcpMiddlewareEntries]
95
- : this.mcpMiddlewareEntries;
96
- if (entries.length === 0) {
97
- return;
98
- }
99
- const { requestHandlers, notificationHandlers } = getHandlerMaps(this.server);
100
- const instrumentMap = (map, isNotification) => {
101
- for (const [method, handler] of map) {
102
- map.set(method, buildMiddlewareChain(method, isNotification, handler, entries));
103
- }
104
- const originalSet = map.set.bind(map);
105
- map.set = (method, handler) => originalSet(method, buildMiddlewareChain(method, isNotification, handler, entries));
228
+ /**
229
+ * This instance's protocol-level middleware: the framework's own entries
230
+ * (view `_meta` on `resources/list`, version-agnostic view resolution on
231
+ * `resources/read`, the top-level `securitySchemes` mirror on `tools/list`)
232
+ * followed by the ones registered via {@link McpServer.mcpMiddleware}.
233
+ *
234
+ * @internal
235
+ */
236
+ protocolMiddlewareEntries() {
237
+ // Surface view-resource _meta on `resources/list` (per ext-apps spec:
238
+ // hosts/checkers read CSP & domain at list time before fetching content).
239
+ const viewListMetaEntry = {
240
+ filter: "resources/list",
241
+ handler: async (_req, extra, next) => {
242
+ const result = (await next());
243
+ for (const resource of result.resources) {
244
+ const builder = this.viewMetaBuilders.get(resource.uri);
245
+ if (!builder) {
246
+ continue;
247
+ }
248
+ const meta = builder(extra);
249
+ resource._meta = {
250
+ ...(resource._meta ?? {}),
251
+ ...meta,
252
+ };
253
+ }
254
+ return result;
255
+ },
106
256
  };
107
- instrumentMap(requestHandlers, false);
108
- instrumentMap(notificationHandlers, true);
109
- }
110
- async connect(transport) {
111
- this.applyMcpMiddleware();
112
- return McpServerBase.prototype.connect.call(this, transport);
113
- }
114
- async run() {
115
- this.applyMcpMiddleware();
116
- const httpServer = http.createServer();
117
- if (!this.express) {
118
- this.express = await createApp({
119
- mcpServer: this,
120
- httpServer,
121
- customMiddleware: this.customMiddleware,
122
- errorMiddleware: this.customErrorMiddleware,
123
- });
124
- }
125
- httpServer.on("request", this.express);
126
- return new Promise((resolve, reject) => {
127
- httpServer.on("error", (error) => {
128
- console.error("Failed to start server:", error);
129
- reject(error);
130
- });
131
- const port = parseInt(process.env.__PORT ?? "3000", 10);
132
- httpServer.listen(port, () => {
133
- resolve();
134
- });
135
- });
257
+ // Resolve a view's `resources/read` by its query-less path so the
258
+ // underlying asset is served no matter the `?v=` value (stale cache key,
259
+ // no param, etc.). The version param is a cache-busting hint for external
260
+ // consumers; it must not gate resolution. We rewrite the lookup URI to the
261
+ // canonical registered one, then restore the requested URI on the response
262
+ // so the consumer-facing URI is never rewritten.
263
+ const viewReadResolveEntry = {
264
+ filter: "resources/read",
265
+ handler: async (req, _extra, next) => {
266
+ const requested = req.params.uri;
267
+ if (typeof requested !== "string") {
268
+ return next();
269
+ }
270
+ const path = stripQuery(requested);
271
+ const canonical = this.viewUriByPath.get(path);
272
+ if (!canonical) {
273
+ return next();
274
+ }
275
+ req.params.uri = canonical;
276
+ try {
277
+ const result = (await next());
278
+ for (const content of result.contents ?? []) {
279
+ if (typeof content.uri === "string" &&
280
+ stripQuery(content.uri) === stripQuery(canonical)) {
281
+ content.uri = requested;
282
+ }
283
+ }
284
+ return result;
285
+ }
286
+ finally {
287
+ // Restore the shared request params so middleware outer to us never
288
+ // observes the rewritten lookup URI after next() unwinds.
289
+ req.params.uri = requested;
290
+ }
291
+ },
292
+ };
293
+ // ChatGPT reads `securitySchemes` at the tool descriptor top level (SEP-1488,
294
+ // still Draft), but the SDK's registerTool strips unknown top-level fields, so
295
+ // it's stashed in `_meta` at registration. This restores it to the top level
296
+ // on tools/list output. Remove once SEP-1488 lands and the SDK preserves it.
297
+ // { name: "checkout", _meta: { securitySchemes: [{ type: "oauth2" }] } }
298
+ // -> { name: "checkout", _meta: {…}, securitySchemes: [{ type: "oauth2" }] }
299
+ const toolsListSecuritySchemesEntry = {
300
+ filter: "tools/list",
301
+ handler: async (_req, _extra, next) => {
302
+ const result = (await next());
303
+ for (const tool of result.tools) {
304
+ const schemes = tool._meta?.securitySchemes;
305
+ if (schemes && !("securitySchemes" in tool)) {
306
+ tool.securitySchemes = schemes;
307
+ }
308
+ }
309
+ return result;
310
+ },
311
+ };
312
+ return [
313
+ viewListMetaEntry,
314
+ viewReadResolveEntry,
315
+ toolsListSecuritySchemesEntry,
316
+ ...this.userMiddlewareEntries,
317
+ ];
136
318
  }
137
319
  enforceOneToolPerView(component, toolName) {
138
320
  const existingTool = this.claimedViews.get(component);
@@ -141,188 +323,155 @@ export class McpServer extends McpServerBaseOmitted {
141
323
  }
142
324
  this.claimedViews.set(component, toolName);
143
325
  }
144
- registerViewResources(toolName, view, toolMeta) {
145
- const hosts = view.hosts ?? ["apps-sdk", "mcp-app"];
146
- if (hosts.includes("apps-sdk")) {
147
- const viewResource = {
148
- hostType: "apps-sdk",
149
- uri: `ui://widgets/apps-sdk/${view.component}.html`,
150
- mimeType: "text/html+skybridge",
151
- buildContentMeta: ({ resourceDomains, connectDomains, domain }, overrides) => {
152
- const defaults = {
153
- "openai/widgetCSP": {
154
- resource_domains: resourceDomains,
155
- connect_domains: connectDomains,
156
- },
157
- "openai/widgetDomain": domain,
158
- "openai/widgetDescription": view.description,
159
- };
160
- const fromView = {
161
- "openai/widgetCSP": {
162
- resource_domains: view.csp?.resourceDomains,
163
- connect_domains: view.csp?.connectDomains,
164
- frame_domains: view.csp?.frameDomains,
165
- redirect_domains: view.csp?.redirectDomains,
166
- },
167
- "openai/widgetDomain": view.domain,
168
- "openai/widgetPrefersBorder": view.prefersBorder,
169
- };
170
- const base = mergeWithUnion(mergeWithUnion(defaults, fromView), {
171
- "openai/widgetDomain": overrides.domain,
172
- });
173
- if (view._meta) {
174
- return { ...base, ...view._meta };
175
- }
176
- return base;
177
- },
178
- };
179
- this.registerViewResource({
180
- name: toolName,
181
- viewResource,
182
- view,
183
- });
184
- toolMeta["openai/outputTemplate"] = viewResource.uri;
326
+ resolveViewRequestContext(ctx) {
327
+ const isProduction = process.env.NODE_ENV === "production";
328
+ const header = (key) => ctx?.http?.req?.headers.get(key) ?? undefined;
329
+ const isClaude = hostFromUserAgent(header("user-agent")) === "claude";
330
+ const serverUrl = resolveServerOrigin(header);
331
+ // Path prefix the proxy routed this request under (e.g. `foo.com/v1`). Read
332
+ // per-request so one process can serve many hosts/prefixes at once: the
333
+ // origin is recovered from x-forwarded-host, the prefix from
334
+ // x-forwarded-prefix. Empty when served at the origin root.
335
+ const assetsBasePath = normalizeForwardedPrefix(header("x-forwarded-prefix"));
336
+ const connectDomains = [serverUrl];
337
+ if (!isProduction) {
338
+ const wsUrl = new URL(serverUrl);
339
+ wsUrl.protocol = wsUrl.protocol === "https:" ? "wss:" : "ws:";
340
+ connectDomains.push(wsUrl.origin);
185
341
  }
186
- if (hosts.includes("mcp-app")) {
187
- const viewResource = {
188
- hostType: "mcp-app",
189
- uri: `ui://widgets/ext-apps/${view.component}.html`,
190
- mimeType: "text/html;profile=mcp-app",
191
- buildContentMeta: ({ resourceDomains, connectDomains, domain, baseUriDomains }, overrides) => {
192
- const defaults = {
193
- ui: {
194
- csp: {
195
- resourceDomains,
196
- connectDomains,
197
- baseUriDomains,
198
- },
199
- domain,
200
- },
201
- };
202
- const fromView = {
203
- ui: {
204
- ...(view.description && { description: view.description }),
205
- ...(view.prefersBorder !== undefined && {
206
- prefersBorder: view.prefersBorder,
342
+ let contentMetaOverrides = {};
343
+ if (isClaude) {
344
+ const pathname = ctx?.http?.req ? new URL(ctx.http.req.url).pathname : "";
345
+ const rawUrl = header("x-alpic-forwarded-url") ?? `${serverUrl}${pathname}`;
346
+ // Strip a lone trailing slash so the hash matches the connector URL
347
+ // as registered with Claude (which has no trailing slash on bare origins).
348
+ const url = rawUrl.endsWith("/") ? rawUrl.slice(0, -1) : rawUrl;
349
+ const hash = crypto
350
+ .createHash("sha256")
351
+ .update(url)
352
+ .digest("hex")
353
+ .slice(0, 32);
354
+ contentMetaOverrides = { domain: `${hash}.claudemcpcontent.com` };
355
+ }
356
+ return { serverUrl, assetsBasePath, connectDomains, contentMetaOverrides };
357
+ }
358
+ registerViewResources(toolName, view, toolMeta, openai) {
359
+ // Append a content-derived version param so hosts (e.g. ChatGPT) bust
360
+ // their cache when the bundle changes, but keep the URI stable across
361
+ // `tools/list` calls when the bundle hasn't changed.
362
+ const versionParam = this.computeViewVersionParam(view.component);
363
+ const viewResource = {
364
+ uri: `ui://views/ext-apps/${view.component}.html${versionParam}`,
365
+ mimeType: "text/html;profile=mcp-app",
366
+ buildContentMeta: ({ resourceDomains, connectDomains, domain, baseUriDomains }, overrides) => {
367
+ const ui = {
368
+ ui: {
369
+ ...(view.description && { description: view.description }),
370
+ ...(view.prefersBorder !== undefined && {
371
+ prefersBorder: view.prefersBorder,
372
+ }),
373
+ domain: overrides.domain ?? view.domain ?? domain,
374
+ csp: {
375
+ resourceDomains: unionOf(resourceDomains, view.csp?.resourceDomains),
376
+ connectDomains: unionOf(connectDomains, view.csp?.connectDomains),
377
+ baseUriDomains: unionOf(baseUriDomains, view.csp?.baseUriDomains),
378
+ ...(view.csp?.frameDomains && {
379
+ frameDomains: view.csp.frameDomains,
207
380
  }),
208
- ...(view.domain && { domain: view.domain }),
209
- csp: {
210
- ...(view.csp?.resourceDomains && {
211
- resourceDomains: view.csp.resourceDomains,
212
- }),
213
- ...(view.csp?.connectDomains && {
214
- connectDomains: view.csp.connectDomains,
215
- }),
216
- ...(view.csp?.frameDomains && {
217
- frameDomains: view.csp.frameDomains,
218
- }),
219
- ...(view.csp?.baseUriDomains && {
220
- baseUriDomains: view.csp.baseUriDomains,
221
- }),
222
- ...(view.csp?.redirectDomains && {
223
- redirectDomains: view.csp.redirectDomains,
224
- }),
225
- },
226
381
  },
227
- };
228
- const base = mergeWithUnion(mergeWithUnion(defaults, fromView), {
229
- ui: overrides,
230
- });
231
- if (view._meta) {
232
- return { ...base, ...view._meta };
233
- }
234
- return base;
235
- },
236
- };
237
- this.registerViewResource({
238
- name: toolName,
239
- viewResource,
240
- view,
241
- });
242
- // @ts-expect-error - For backwards compatibility with Claude current implementation of the specs
243
- toolMeta["ui/resourceUri"] = viewResource.uri;
244
- toolMeta.ui = { resourceUri: viewResource.uri };
245
- }
382
+ },
383
+ };
384
+ const base = {
385
+ ...ui,
386
+ ...(view.description && {
387
+ "openai/widgetDescription": view.description,
388
+ }),
389
+ ...(view.csp?.redirectDomains && {
390
+ "openai/widgetCSP": { redirect_domains: view.csp.redirectDomains },
391
+ }),
392
+ };
393
+ const meta = { ...base, ...view._meta };
394
+ mergeOpenAIUi(meta, {
395
+ availableDisplayModes: openai?.availableDisplayModes,
396
+ preferredDisplayMode: openai?.preferredDisplayMode,
397
+ });
398
+ return meta;
399
+ },
400
+ };
401
+ this.registerViewResource({ name: toolName, viewResource, view });
402
+ // Advertise via the MCP Apps standard pointer only — ChatGPT renders from
403
+ // ui.resourceUri (verified), and not emitting openai/outputTemplate lets us
404
+ // retire the legacy apps-sdk resource later. The legacy apps-sdk URL is still
405
+ // served (see registerViewResource) so already-published apps keep resolving.
406
+ // @ts-expect-error - For backwards compatibility with Claude current implementation of the specs
407
+ toolMeta["ui/resourceUri"] = viewResource.uri;
408
+ toolMeta.ui = { ...toolMeta.ui, resourceUri: viewResource.uri };
246
409
  }
247
410
  registerViewResource({ name, viewResource, view, }) {
248
- const { hostType, uri: viewUri, mimeType, buildContentMeta } = viewResource;
411
+ const { uri: viewUri, mimeType, buildContentMeta } = viewResource;
412
+ const buildMeta = (extra) => {
413
+ const { serverUrl, connectDomains, contentMetaOverrides } = this.resolveViewRequestContext(extra);
414
+ return buildContentMeta({
415
+ resourceDomains: [serverUrl],
416
+ connectDomains,
417
+ domain: serverUrl,
418
+ baseUriDomains: [serverUrl],
419
+ }, contentMetaOverrides);
420
+ };
421
+ this.viewMetaBuilders.set(viewUri, buildMeta);
422
+ this.viewUriByPath.set(stripQuery(viewUri), viewUri);
423
+ this.serveLegacyAppsSdkUrl(view.component, viewUri);
249
424
  this.registerResource(name, viewUri, { description: view.description }, async (uri, extra) => {
250
425
  const isProduction = process.env.NODE_ENV === "production";
251
- const isClaude = extra?.requestInfo?.headers?.["user-agent"] === "Claude-User";
252
- const headers = extra?.requestInfo?.headers || {};
253
- const header = (key) => {
254
- const val = headers[key];
255
- return Array.isArray(val) ? val[0] : val;
256
- };
257
- let serverUrl;
258
- const forwardedHost = header("x-forwarded-host");
259
- const origin = header("origin");
260
- const host = header("host");
261
- if (forwardedHost) {
262
- const proto = header("x-forwarded-proto") || "https";
263
- serverUrl = `${proto}://${forwardedHost}`;
264
- }
265
- else if (origin) {
266
- serverUrl = origin;
267
- }
268
- else if (host) {
269
- const proto = ["127.0.0.1:", "localhost:"].some((p) => host.startsWith(p))
270
- ? "http"
271
- : "https";
272
- serverUrl = `${proto}://${host}`;
273
- }
274
- else {
275
- const devPort = process.env.__PORT || "3000";
276
- serverUrl = `http://localhost:${devPort}`;
277
- }
426
+ const { serverUrl, assetsBasePath } = this.resolveViewRequestContext(extra);
427
+ // The view resolves all assets (template imports + runtime lazy chunks
428
+ // via `window.skybridge.serverUrl`) against this base, so it carries the
429
+ // proxy path prefix. CSP domains in `buildMeta` stay the bare origin.
430
+ const viewBase = `${serverUrl}${assetsBasePath}`;
278
431
  const html = isProduction
279
432
  ? templateHelper.renderProduction({
280
- hostType,
281
- serverUrl,
433
+ serverUrl: viewBase,
282
434
  viewFile: this.lookupViewFile(view.component),
283
435
  styleFile: this.lookupDistFile("style.css") ?? "",
436
+ preloadFiles: this.lookupViewPreloadFiles(view.component),
284
437
  })
285
438
  : templateHelper.renderDevelopment({
286
- hostType,
287
- serverUrl,
439
+ serverUrl: viewBase,
288
440
  viewName: view.component,
289
441
  });
290
- const connectDomains = [serverUrl];
291
- if (!isProduction) {
292
- const wsUrl = new URL(serverUrl);
293
- wsUrl.protocol = wsUrl.protocol === "https:" ? "wss:" : "ws:";
294
- connectDomains.push(wsUrl.origin);
295
- }
296
- let contentMetaOverrides = {};
297
- if (isClaude) {
298
- const pathname = extra?.requestInfo?.url?.pathname ?? "";
299
- const rawUrl = header("x-alpic-forwarded-url") ?? `${serverUrl}${pathname}`;
300
- // Strip a lone trailing slash so the hash matches the connector URL
301
- // as registered with Claude (which has no trailing slash on bare origins).
302
- const url = rawUrl.endsWith("/") ? rawUrl.slice(0, -1) : rawUrl;
303
- const hash = crypto
304
- .createHash("sha256")
305
- .update(url)
306
- .digest("hex")
307
- .slice(0, 32);
308
- contentMetaOverrides = { domain: `${hash}.claudemcpcontent.com` };
309
- }
310
- const contentMeta = buildContentMeta({
311
- resourceDomains: [serverUrl],
312
- connectDomains,
313
- domain: serverUrl,
314
- baseUriDomains: [serverUrl],
315
- }, contentMetaOverrides);
316
442
  return {
317
443
  contents: [
318
- { uri: uri.href, mimeType, text: html, _meta: contentMeta },
444
+ { uri: uri.href, mimeType, text: html, _meta: buildMeta(extra) },
319
445
  ],
320
446
  };
321
447
  });
322
448
  }
323
- wrapHandler(cb, { attachViewUUID }) {
449
+ serveLegacyAppsSdkUrl(component, canonicalUri) {
450
+ this.viewUriByPath.set(`ui://views/apps-sdk/${component}.html`, canonicalUri);
451
+ this.viewUriByPath.set(`ui://widgets/apps-sdk/${component}.html`, canonicalUri);
452
+ this.viewUriByPath.set(`ui://widgets/ext-apps/${component}.html`, canonicalUri);
453
+ }
454
+ decorateToolHandler(cb, { attachViewUUID, securitySchemes, toolName, }) {
324
455
  return async (args, extra) => {
325
- const result = await cb(args, extra);
456
+ if (this.oauthEnabled) {
457
+ const failure = evaluateSecuritySchemes(securitySchemes, extra.http?.authInfo);
458
+ if (failure) {
459
+ const header = (key) => extra.http?.req?.headers.get(key) ?? undefined;
460
+ return inBandChallengeResult(failure, this.resolveResourceMetadataUrl?.(header));
461
+ }
462
+ }
463
+ let result;
464
+ try {
465
+ result = await cb(args, extra);
466
+ }
467
+ catch (error) {
468
+ captureToolError(extra, error);
469
+ throw error;
470
+ }
471
+ if (isInputRequiredResult(result)) {
472
+ return result;
473
+ }
474
+ warnOnLargeToolOutput(result, toolName);
326
475
  return {
327
476
  ...result,
328
477
  content: normalizeContent(result.content),
@@ -335,6 +484,26 @@ export class McpServer extends McpServerBaseOmitted {
335
484
  };
336
485
  };
337
486
  }
487
+ computeViewVersionParam(viewName) {
488
+ if (process.env.NODE_ENV !== "production") {
489
+ return "";
490
+ }
491
+ try {
492
+ const viewFile = this.lookupViewFile(viewName);
493
+ const styleFile = this.lookupDistFile("style.css") ?? "";
494
+ const hash = crypto
495
+ .createHash("sha256")
496
+ .update(viewFile)
497
+ .update("\0")
498
+ .update(styleFile)
499
+ .digest("hex")
500
+ .slice(0, 8);
501
+ return `?v=${hash}`;
502
+ }
503
+ catch {
504
+ return "";
505
+ }
506
+ }
338
507
  lookupViewFile(viewName) {
339
508
  const manifest = this.readManifest();
340
509
  for (const entry of Object.values(manifest)) {
@@ -344,29 +513,302 @@ export class McpServer extends McpServerBaseOmitted {
344
513
  }
345
514
  throw new Error(`View "${viewName}" not found in Vite manifest. Did the build complete successfully? Look for an entry with name "${viewName}" in dist/assets/.vite/manifest.json.`);
346
515
  }
516
+ lookupViewPreloadFiles(viewName) {
517
+ const manifest = this.readManifest();
518
+ const entryKey = Object.keys(manifest).find((key) => manifest[key]?.isEntry && manifest[key]?.name === viewName);
519
+ const files = new Set();
520
+ const visit = (key) => {
521
+ const chunk = key ? manifest[key] : undefined;
522
+ if (!chunk || files.has(chunk.file)) {
523
+ return;
524
+ }
525
+ files.add(chunk.file);
526
+ chunk.imports?.forEach(visit);
527
+ };
528
+ visit(entryKey);
529
+ return [...files];
530
+ }
347
531
  lookupDistFile(key) {
348
532
  const manifest = this.readManifest();
349
533
  return manifest[key]?.file;
350
534
  }
535
+ /**
536
+ * Inject the Vite manifest as a value rather than letting `readManifest()`
537
+ * load it from disk. Required for runtimes without a usable filesystem
538
+ * (Cloudflare Workers, etc.) — the user's `skybridge build` emits the
539
+ * manifest as a JS module which the entry imports and passes here.
540
+ */
541
+ setViteManifest(manifest) {
542
+ this.viteManifest = manifest;
543
+ return this;
544
+ }
351
545
  readManifest() {
352
- return JSON.parse(readFileSync(path.join(process.cwd(), "dist", "assets", ".vite", "manifest.json"), "utf-8"));
546
+ if (this.viteManifest) {
547
+ return this.viteManifest;
548
+ }
549
+ cachedDiskManifest ??= JSON.parse(readFileSync(path.join(process.cwd(), "dist", "assets", ".vite", "manifest.json"), "utf-8"));
550
+ return cachedDiskManifest ?? {};
353
551
  }
354
- registerTool(...args) {
552
+ /**
553
+ * @experimental Register an MCP Events type that hosts can subscribe to, per
554
+ * the Triggers & Events working group draft. Skybridge serves `events/list`,
555
+ * `events/subscribe` and `events/unsubscribe`, checks auth and arguments,
556
+ * verifies the callback URL, then hands each subscription to `onSubscribe`.
557
+ * Delivering the events is up to you, for example with {@link deliverEvent}.
558
+ * API may change.
559
+ *
560
+ * @example
561
+ * ```ts
562
+ * server.registerEvent(
563
+ * {
564
+ * name: "comment.created",
565
+ * description: "Fires when someone comments on a document",
566
+ * inputSchema: { documentId: z.string() },
567
+ * payloadSchema: { documentId: z.string(), excerpt: z.string() },
568
+ * },
569
+ * {
570
+ * onSubscribe: ({ documentId }, { subscription }) =>
571
+ * webhooks.upsert({ ...subscription, filter: { documentId } }),
572
+ * onUnsubscribe: (_args, { subscription }) =>
573
+ * webhooks.remove(subscription.id),
574
+ * },
575
+ * );
576
+ * ```
577
+ *
578
+ * @see https://docs.skybridge.tech/api-reference/register-event
579
+ */
580
+ registerEvent(config, hooks) {
581
+ if (!this.eventRegistry) {
582
+ this.server.registerCapabilities({ events: {} });
583
+ this.eventRegistry = new EventRegistry(this.server);
584
+ }
585
+ this.eventRegistry.add(config, hooks);
586
+ return this;
587
+ }
588
+ /**
589
+ * Register a ChatGPT file viewer, from the OpenAI MCP extensions: a tool
590
+ * with a file entrypoint for `extensions` and a view. ChatGPT desktop calls
591
+ * it with the file the user opened, as `{ file: { name, resourceUri } }`.
592
+ * Read and save the file from the view with `useFileResource`.
593
+ *
594
+ * @example
595
+ * ```ts
596
+ * server.registerFileViewer(
597
+ * {
598
+ * name: "part-viewer",
599
+ * title: "Part Viewer",
600
+ * extensions: [".stl", ".step"],
601
+ * view: { component: "part-viewer" },
602
+ * },
603
+ * async ({ file }) => ({ structuredContent: { name: file.name } }),
604
+ * );
605
+ * ```
606
+ *
607
+ * @see https://docs.skybridge.tech/api-reference/register-file-viewer
608
+ */
609
+ registerFileViewer(config, cb) {
610
+ const { extensions, openai, ...toolConfig } = config;
611
+ return this.registerTool({
612
+ ...toolConfig,
613
+ inputSchema: fileEntrypointInput,
614
+ openai: { ...openai, entrypoints: [{ type: "file", extensions }] },
615
+ }, cb);
616
+ }
617
+ /**
618
+ * Register the composer at-mention search for ChatGPT, from the OpenAI MCP
619
+ * extensions. When the user types `@` and your app name, ChatGPT calls
620
+ * `handler` with the typed text and lists the returned resource links.
621
+ * Skybridge registers it as a tool hidden from the model.
622
+ *
623
+ * @example
624
+ * ```ts
625
+ * server.registerMentions({
626
+ * name: "search_parts",
627
+ * handler: async ({ query }) => ({
628
+ * items: findParts(query).map((part) => ({
629
+ * type: "resource_link",
630
+ * uri: `parts://${part.id}`,
631
+ * name: part.name,
632
+ * })),
633
+ * }),
634
+ * });
635
+ * ```
636
+ *
637
+ * @see https://docs.skybridge.tech/api-reference/register-mentions
638
+ */
639
+ registerMentions(config) {
640
+ this.registerTool({
641
+ name: config.name,
642
+ description: config.description ?? "Search items to mention.",
643
+ annotations: { readOnlyHint: true },
644
+ inputSchema: { query: z.string() },
645
+ _meta: {
646
+ "openai/extensions": { "mentions/search": {} },
647
+ ui: { visibility: ["app"] },
648
+ },
649
+ }, async ({ query }, extra) => ({
650
+ content: [],
651
+ structuredContent: await config.handler({ query }, extra),
652
+ }));
653
+ return this;
654
+ }
655
+ /**
656
+ * Register app settings for ChatGPT, from the OpenAI MCP extensions.
657
+ * Skybridge registers a read tool and an update tool from `fields`, and
658
+ * advertises them in the `openai/settings` server capability. ChatGPT shows
659
+ * the settings page and calls `update` with the changed fields only. Store
660
+ * the values yourself, for example per user.
661
+ *
662
+ * @example
663
+ * ```ts
664
+ * server.registerSettings({
665
+ * fields: {
666
+ * units: { title: "Units", schema: z.enum(["mm", "in"]) },
667
+ * showGrid: { title: "Show grid", schema: z.boolean() },
668
+ * },
669
+ * read: (extra) => loadSettings(extra),
670
+ * update: (set, extra) => saveSettings(set, extra),
671
+ * });
672
+ * ```
673
+ *
674
+ * @see https://docs.skybridge.tech/api-reference/register-settings
675
+ */
676
+ registerSettings(config) {
677
+ const { fields, layout, readTool = "settings.read", updateTool = "settings.update", } = config;
678
+ const values = z
679
+ .strictObject(Object.fromEntries(Object.entries(fields).map(([name, { schema, title, description }]) => [
680
+ name,
681
+ schema.meta({
682
+ title,
683
+ ...(description !== undefined && { description }),
684
+ }),
685
+ ])))
686
+ .required();
687
+ const { $schema: _, ...schema } = z.toJSONSchema(values);
688
+ for (const [name, property] of Object.entries(schema.properties ?? {})) {
689
+ if (fields[name]?.schema.safeParse(undefined).data !== undefined) {
690
+ throw new Error(`Setting "${name}" declares a default: return current values from \`read\` instead.`);
691
+ }
692
+ if (typeof property === "boolean" ||
693
+ !["boolean", "string", "number", "integer"].includes(String(property.type)) ||
694
+ (property.enum !== undefined && property.type !== "string")) {
695
+ throw new Error(`Setting "${name}" must be a boolean, string, string enum, number or integer.`);
696
+ }
697
+ }
698
+ const placed = new Set();
699
+ for (const group of layout ?? []) {
700
+ for (const item of group.items) {
701
+ if (item.kind !== "property") {
702
+ continue;
703
+ }
704
+ if (!Object.hasOwn(fields, item.property) ||
705
+ placed.has(item.property)) {
706
+ throw new Error(`Settings layout names an unknown or duplicate field "${item.property}".`);
707
+ }
708
+ placed.add(item.property);
709
+ }
710
+ }
711
+ this.registerTool({
712
+ name: readTool,
713
+ description: "Read the app settings.",
714
+ annotations: { readOnlyHint: true, openWorldHint: false },
715
+ inputSchema: {},
716
+ outputSchema: {
717
+ schema: z.record(z.string(), z.unknown()),
718
+ values,
719
+ layout: z.array(z.record(z.string(), z.unknown())).optional(),
720
+ },
721
+ }, async (_args, extra) => ({
722
+ content: [],
723
+ structuredContent: {
724
+ schema,
725
+ values: values.parse(await config.read(extra)),
726
+ layout,
727
+ },
728
+ }));
729
+ this.registerTool({
730
+ name: updateTool,
731
+ description: "Update the app settings.",
732
+ annotations: {
733
+ destructiveHint: false,
734
+ idempotentHint: true,
735
+ openWorldHint: false,
736
+ },
737
+ inputSchema: {
738
+ set: values
739
+ .partial()
740
+ .refine((set) => Object.keys(set).length > 0)
741
+ .meta({ minProperties: 1 }),
742
+ },
743
+ outputSchema: { values },
744
+ }, async ({ set }, extra) => ({
745
+ content: [],
746
+ structuredContent: {
747
+ values: values.parse(await config.update(set, extra)),
748
+ },
749
+ }));
750
+ const capability = { readTool, updateTool };
751
+ this.server.registerCapabilities({
752
+ extensions: { "openai/settings": capability },
753
+ experimental: { "openai/settings": capability },
754
+ });
755
+ return this;
756
+ }
757
+ registerTool(rawConfig, rawCb) {
355
758
  const baseFn = McpServerBase.prototype.registerTool;
356
- if (typeof args[0] === "string") {
357
- baseFn.call(this, args[0], args[1], args[2]);
358
- return this;
759
+ const config = rawConfig;
760
+ const cb = rawCb;
761
+ const { name, view, auth, securitySchemes: rawSecuritySchemes, openai, _meta: userToolMeta, ...toolFields } = config;
762
+ const authNeedsProvider = auth !== undefined &&
763
+ (!auth.allowsAnonymous || Boolean(auth.scopes?.length));
764
+ if (rawSecuritySchemes === undefined &&
765
+ authNeedsProvider &&
766
+ !this.oauthEnabled) {
767
+ throw new Error(`Tool "${name}" sets \`auth: ${JSON.stringify(auth)}\` but the server has no \`oauth\` provider configured.`);
359
768
  }
360
- const config = args[0];
361
- const cb = args[1];
362
- const { name, view, _meta: userToolMeta, ...toolFields } = config;
769
+ const securitySchemes = rawSecuritySchemes ??
770
+ (auth && this.oauthEnabled ? authToSecuritySchemes(auth) : undefined);
363
771
  const toolMeta = { ...userToolMeta };
772
+ this.toolSecuritySchemes.set(name, securitySchemes);
773
+ if (securitySchemes) {
774
+ // SEP-1488 puts `securitySchemes` at the top level of the tool
775
+ // descriptor, but the SDK's `registerTool` drops unknown top-level
776
+ // fields, so the canonical spot isn't reachable without intercepting
777
+ // `tools/list`. Use the `_meta` back-compat mirror documented in the
778
+ // ChatGPT plugin reference until SEP-1488 lands in the spec.
779
+ toolMeta.securitySchemes = securitySchemes;
780
+ }
781
+ if (openai) {
782
+ if (!view) {
783
+ throw new Error(`skybridge: tool "${name}" sets \`openai\` options but has no \`view\`.`);
784
+ }
785
+ const opensWithoutInput = openai.entrypoints?.some(({ type }) => type === "global" || type === "thread");
786
+ if (opensWithoutInput && !acceptsEmptyInput(toolFields.inputSchema)) {
787
+ throw new Error(`skybridge: tool "${name}" has a global or thread entrypoint, so ChatGPT calls it with \`{}\`, but its input schema rejects \`{}\`. Make every input optional.`);
788
+ }
789
+ const badExtension = openai.entrypoints
790
+ ?.flatMap((entrypoint) => entrypoint.type === "file" ? entrypoint.extensions : [])
791
+ .find((extension) => !extension.startsWith("."));
792
+ if (badExtension !== undefined) {
793
+ throw new Error(`skybridge: tool "${name}" has a file entrypoint extension "${badExtension}" that doesn't start with ".".`);
794
+ }
795
+ mergeOpenAIUi(toolMeta, {
796
+ entrypoints: openai.entrypoints,
797
+ preferredModelDisplayMode: openai.preferredModelDisplayMode,
798
+ });
799
+ }
364
800
  if (view) {
365
801
  this.enforceOneToolPerView(view.component, name);
366
- this.registerViewResources(name, view, toolMeta);
802
+ this.registerViewResources(name, view, toolMeta, openai);
367
803
  }
368
- const wrappedCb = this.wrapHandler(cb, { attachViewUUID: Boolean(view) });
369
- baseFn.call(this, name, { ...toolFields, _meta: toolMeta }, wrappedCb);
804
+ const wrappedCb = this.decorateToolHandler(cb, {
805
+ attachViewUUID: Boolean(view),
806
+ securitySchemes,
807
+ toolName: name,
808
+ });
809
+ baseFn.call(this, name, { ...toolFields, _meta: toolMeta }, toolFields.inputSchema === undefined
810
+ ? (extra) => wrappedCb({}, extra)
811
+ : wrappedCb);
370
812
  return this;
371
813
  }
372
814
  }