skybridge 0.0.0-dev.9c6d6b4 → 0.0.0-dev.9c70f50

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