@assistant-ui/mcp-docs-server 0.1.30 → 0.1.32

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 (341) hide show
  1. package/.docs/organized/code-examples/waterfall.md +8 -8
  2. package/.docs/organized/code-examples/with-a2a.md +10 -10
  3. package/.docs/organized/code-examples/with-ag-ui.md +12 -12
  4. package/.docs/organized/code-examples/with-ai-sdk-v6.md +14 -14
  5. package/.docs/organized/code-examples/with-artifacts.md +14 -14
  6. package/.docs/organized/code-examples/with-assistant-transport.md +11 -11
  7. package/.docs/organized/code-examples/with-browser-extension.md +345 -0
  8. package/.docs/organized/code-examples/with-chain-of-thought.md +129 -63
  9. package/.docs/organized/code-examples/with-cloud-standalone.md +13 -13
  10. package/.docs/organized/code-examples/with-cloud.md +13 -13
  11. package/.docs/organized/code-examples/with-custom-thread-list.md +65 -20
  12. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +18 -17
  13. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +18 -17
  14. package/.docs/organized/code-examples/with-expo.md +25 -25
  15. package/.docs/organized/code-examples/with-external-store.md +10 -10
  16. package/.docs/organized/code-examples/with-ffmpeg.md +14 -14
  17. package/.docs/organized/code-examples/with-generative-ui.md +211 -14
  18. package/.docs/organized/code-examples/with-google-adk.md +12 -12
  19. package/.docs/organized/code-examples/with-heat-graph.md +8 -8
  20. package/.docs/organized/code-examples/with-image-generation.md +454 -0
  21. package/.docs/organized/code-examples/with-interactables.md +14 -14
  22. package/.docs/organized/code-examples/with-langchain.md +12 -12
  23. package/.docs/organized/code-examples/with-langgraph.md +15 -12
  24. package/.docs/organized/code-examples/with-livekit.md +19 -18
  25. package/.docs/organized/code-examples/with-mcp.md +748 -0
  26. package/.docs/organized/code-examples/with-opencode.md +107 -62
  27. package/.docs/organized/code-examples/with-parent-id-grouping.md +12 -12
  28. package/.docs/organized/code-examples/with-react-hook-form.md +14 -14
  29. package/.docs/organized/code-examples/with-react-ink.md +4 -4
  30. package/.docs/organized/code-examples/with-react-router.md +16 -16
  31. package/.docs/organized/code-examples/with-resumable-stream.md +660 -0
  32. package/.docs/organized/code-examples/with-store.md +8 -8
  33. package/.docs/organized/code-examples/with-tanstack.md +14 -14
  34. package/.docs/organized/code-examples/with-tap-runtime.md +11 -10
  35. package/.docs/raw/docs/(docs)/cli.mdx +3 -1
  36. package/.docs/raw/docs/(docs)/copilots/assistant-frame.mdx +1 -0
  37. package/.docs/raw/docs/(docs)/copilots/make-assistant-tool-ui.mdx +10 -3
  38. package/.docs/raw/docs/(docs)/copilots/make-assistant-tool.mdx +8 -3
  39. package/.docs/raw/docs/(docs)/copilots/make-assistant-visible.mdx +1 -0
  40. package/.docs/raw/docs/(docs)/copilots/model-context.mdx +1 -0
  41. package/.docs/raw/docs/(docs)/copilots/motivation.mdx +1 -0
  42. package/.docs/raw/docs/(docs)/copilots/use-assistant-instructions.mdx +1 -0
  43. package/.docs/raw/docs/(docs)/devtools.mdx +1 -0
  44. package/.docs/raw/docs/(docs)/index.mdx +3 -2
  45. package/.docs/raw/docs/(docs)/installation.mdx +2 -1
  46. package/.docs/raw/docs/(docs)/rtl.mdx +1 -0
  47. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +36 -0
  48. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
  49. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +34 -0
  50. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
  51. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +55 -0
  52. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +20 -0
  53. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
  54. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
  55. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +22 -0
  56. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
  57. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
  58. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
  59. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +36 -0
  60. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
  61. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +31 -0
  62. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +33 -0
  63. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
  64. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +28 -0
  65. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +94 -0
  66. package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +464 -0
  67. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
  68. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +22 -0
  69. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +79 -0
  70. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +52 -0
  71. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
  72. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
  73. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +125 -125
  74. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
  75. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
  76. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +46 -20
  77. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
  78. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
  79. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
  80. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
  81. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
  82. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
  83. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +70 -0
  84. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
  85. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +182 -554
  86. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
  87. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
  88. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
  89. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
  90. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
  91. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +82 -86
  92. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -314
  93. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
  94. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
  95. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
  96. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +43 -0
  97. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
  98. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
  99. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
  100. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
  101. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -42
  102. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
  103. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +68 -0
  104. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
  105. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +79 -0
  106. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
  107. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +92 -0
  108. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
  109. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
  110. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
  111. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
  112. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +131 -0
  113. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
  114. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
  115. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
  116. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +230 -2
  117. package/.docs/raw/docs/cloud/ai-sdk.mdx +222 -4
  118. package/.docs/raw/docs/cloud/index.mdx +2 -2
  119. package/.docs/raw/docs/cloud/langgraph.mdx +274 -2
  120. package/.docs/raw/docs/{(docs)/guides → guides}/attachments.mdx +45 -40
  121. package/.docs/raw/docs/guides/branching.mdx +76 -0
  122. package/.docs/raw/docs/guides/chain-of-thought.mdx +166 -0
  123. package/.docs/raw/docs/{(docs)/guides → guides}/context-api.mdx +54 -26
  124. package/.docs/raw/docs/{(docs)/guides → guides}/dictation.mdx +3 -1
  125. package/.docs/raw/docs/guides/editing.mdx +102 -0
  126. package/.docs/raw/docs/guides/generative-ui.mdx +142 -0
  127. package/.docs/raw/docs/guides/image-generation.mdx +74 -0
  128. package/.docs/raw/docs/guides/index.mdx +103 -0
  129. package/.docs/raw/docs/{(docs)/guides → guides}/interactables.mdx +51 -2
  130. package/.docs/raw/docs/{(docs)/guides → guides}/latex.mdx +53 -10
  131. package/.docs/raw/docs/guides/mcp-apps.mdx +231 -0
  132. package/.docs/raw/docs/{(docs)/guides → guides}/mentions.mdx +63 -88
  133. package/.docs/raw/docs/{(docs)/guides → guides}/message-timing.mdx +45 -6
  134. package/.docs/raw/docs/{(docs)/guides → guides}/multi-agent.mdx +66 -6
  135. package/.docs/raw/docs/{(docs)/guides → guides}/quoting.mdx +11 -18
  136. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
  137. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
  138. package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
  139. package/.docs/raw/docs/{(docs)/guides → guides}/slash-commands.mdx +104 -38
  140. package/.docs/raw/docs/guides/speech.mdx +156 -0
  141. package/.docs/raw/docs/{(docs)/guides → guides}/suggestions.mdx +91 -69
  142. package/.docs/raw/docs/{(docs)/guides → guides}/tool-ui.mdx +110 -38
  143. package/.docs/raw/docs/{(docs)/guides → guides}/tools.mdx +197 -40
  144. package/.docs/raw/docs/{(docs)/guides → guides}/voice.mdx +41 -2
  145. package/.docs/raw/docs/ink/adapters.mdx +37 -1
  146. package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
  147. package/.docs/raw/docs/ink/index.mdx +11 -14
  148. package/.docs/raw/docs/ink/migration.mdx +1 -3
  149. package/.docs/raw/docs/ink/primitives.mdx +386 -9
  150. package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +520 -0
  151. package/.docs/raw/docs/integrations/auth/better-auth.mdx +191 -0
  152. package/.docs/raw/docs/integrations/auth/clerk.mdx +172 -0
  153. package/.docs/raw/docs/integrations/auth/next-auth.mdx +196 -0
  154. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +79 -0
  155. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
  156. package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +188 -0
  157. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +57 -0
  158. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +201 -0
  159. package/.docs/raw/docs/integrations/gateways/index.mdx +162 -0
  160. package/.docs/raw/docs/integrations/index.mdx +185 -0
  161. package/.docs/raw/docs/integrations/observability/helicone.mdx +130 -0
  162. package/.docs/raw/docs/integrations/observability/langfuse.mdx +163 -0
  163. package/.docs/raw/docs/integrations/observability/langsmith.mdx +150 -0
  164. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +712 -0
  165. package/.docs/raw/docs/integrations/tools/mcp.mdx +267 -0
  166. package/.docs/raw/docs/integrations/tools/react-mcp.mdx +337 -0
  167. package/.docs/raw/docs/migrations/v0-14.mdx +297 -0
  168. package/.docs/raw/docs/primitives/action-bar.mdx +1 -0
  169. package/.docs/raw/docs/primitives/assistant-modal.mdx +1 -0
  170. package/.docs/raw/docs/primitives/attachment.mdx +1 -0
  171. package/.docs/raw/docs/primitives/branch-picker.mdx +1 -0
  172. package/.docs/raw/docs/primitives/chain-of-thought.mdx +90 -85
  173. package/.docs/raw/docs/primitives/composer.mdx +55 -1
  174. package/.docs/raw/docs/primitives/error.mdx +1 -0
  175. package/.docs/raw/docs/primitives/index.mdx +4 -3
  176. package/.docs/raw/docs/primitives/message.mdx +68 -5
  177. package/.docs/raw/docs/primitives/selection-toolbar.mdx +1 -0
  178. package/.docs/raw/docs/primitives/suggestion.mdx +10 -0
  179. package/.docs/raw/docs/primitives/thread-list.mdx +39 -0
  180. package/.docs/raw/docs/primitives/thread.mdx +16 -13
  181. package/.docs/raw/docs/react-native/hooks.mdx +2 -2
  182. package/.docs/raw/docs/react-native/index.mdx +5 -7
  183. package/.docs/raw/docs/react-native/migration.mdx +1 -3
  184. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +396 -0
  185. package/.docs/raw/docs/runtimes/a2a/overview.mdx +60 -0
  186. package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +216 -0
  187. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +70 -0
  188. package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +243 -0
  189. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +154 -0
  190. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +52 -0
  191. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +73 -128
  192. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +70 -64
  193. package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +337 -123
  194. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +265 -0
  195. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +125 -0
  196. package/.docs/raw/docs/runtimes/concepts/stability.mdx +67 -0
  197. package/.docs/raw/docs/runtimes/concepts/threads.mdx +428 -0
  198. package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +703 -0
  199. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +348 -0
  200. package/.docs/raw/docs/runtimes/custom/external-store.mdx +261 -1236
  201. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +746 -0
  202. package/.docs/raw/docs/runtimes/custom/overview.mdx +71 -0
  203. package/.docs/raw/docs/runtimes/google-adk/api.mdx +256 -0
  204. package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +717 -0
  205. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +69 -0
  206. package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +229 -0
  207. package/.docs/raw/docs/runtimes/langchain.mdx +533 -0
  208. package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +305 -0
  209. package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +104 -0
  210. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +84 -0
  211. package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +496 -0
  212. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +127 -0
  213. package/.docs/raw/docs/runtimes/langgraph/threads.mdx +113 -0
  214. package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +3 -3
  215. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -23
  216. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +1 -1
  217. package/.docs/raw/docs/runtimes/opencode/hooks.mdx +191 -0
  218. package/.docs/raw/docs/runtimes/opencode/overview.mdx +48 -0
  219. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +119 -0
  220. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +78 -203
  221. package/.docs/raw/docs/ui/accordion.mdx +1 -0
  222. package/.docs/raw/docs/ui/assistant-modal.mdx +1 -0
  223. package/.docs/raw/docs/ui/assistant-sidebar.mdx +1 -0
  224. package/.docs/raw/docs/ui/attachment.mdx +1 -0
  225. package/.docs/raw/docs/ui/badge.mdx +1 -0
  226. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +12 -1
  227. package/.docs/raw/docs/ui/context-display.mdx +1 -0
  228. package/.docs/raw/docs/ui/diff-viewer.mdx +1 -0
  229. package/.docs/raw/docs/ui/directive-text.mdx +1 -0
  230. package/.docs/raw/docs/ui/file.mdx +1 -0
  231. package/.docs/raw/docs/ui/image.mdx +1 -0
  232. package/.docs/raw/docs/ui/markdown.mdx +2 -14
  233. package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
  234. package/.docs/raw/docs/ui/mermaid.mdx +1 -0
  235. package/.docs/raw/docs/ui/message-timing.mdx +3 -2
  236. package/.docs/raw/docs/ui/model-selector.mdx +9 -8
  237. package/.docs/raw/docs/ui/part-grouping.mdx +325 -313
  238. package/.docs/raw/docs/ui/quote.mdx +1 -0
  239. package/.docs/raw/docs/ui/reasoning.mdx +66 -33
  240. package/.docs/raw/docs/ui/scrollbar.mdx +1 -0
  241. package/.docs/raw/docs/ui/select.mdx +1 -0
  242. package/.docs/raw/docs/ui/sources.mdx +18 -0
  243. package/.docs/raw/docs/ui/streamdown.mdx +35 -2
  244. package/.docs/raw/docs/ui/syntax-highlighting.mdx +1 -0
  245. package/.docs/raw/docs/ui/tabs.mdx +1 -0
  246. package/.docs/raw/docs/ui/thread-list.mdx +19 -2
  247. package/.docs/raw/docs/ui/thread.mdx +58 -3
  248. package/.docs/raw/docs/ui/tool-fallback.mdx +1 -0
  249. package/.docs/raw/docs/ui/tool-group.mdx +39 -11
  250. package/.docs/raw/docs/ui/voice.mdx +1 -0
  251. package/.docs/raw/docs/utilities/heat-graph.mdx +1 -0
  252. package/.docs/raw/docs/utilities/react-o11y.mdx +278 -0
  253. package/.docs/raw/docs/utilities/tw-shimmer.mdx +1 -0
  254. package/README.md +14 -72
  255. package/dist/constants.d.ts +12 -9
  256. package/dist/constants.d.ts.map +1 -1
  257. package/dist/constants.js +13 -9
  258. package/dist/constants.js.map +1 -1
  259. package/dist/index.d.ts +7 -3
  260. package/dist/index.d.ts.map +1 -1
  261. package/dist/index.js +25 -24
  262. package/dist/index.js.map +1 -1
  263. package/dist/prepare-docs/code-examples.d.ts +4 -1
  264. package/dist/prepare-docs/code-examples.d.ts.map +1 -1
  265. package/dist/prepare-docs/code-examples.js +109 -121
  266. package/dist/prepare-docs/code-examples.js.map +1 -1
  267. package/dist/prepare-docs/copy-raw.d.ts +4 -1
  268. package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
  269. package/dist/prepare-docs/copy-raw.js +45 -42
  270. package/dist/prepare-docs/copy-raw.js.map +1 -1
  271. package/dist/prepare-docs/prepare.d.ts +1 -2
  272. package/dist/prepare-docs/prepare.js +17 -17
  273. package/dist/prepare-docs/prepare.js.map +1 -1
  274. package/dist/stdio.d.ts +1 -3
  275. package/dist/stdio.js +6 -3
  276. package/dist/stdio.js.map +1 -1
  277. package/dist/tools/docs.d.ts +20 -15
  278. package/dist/tools/docs.d.ts.map +1 -1
  279. package/dist/tools/docs.js +140 -161
  280. package/dist/tools/docs.js.map +1 -1
  281. package/dist/tools/examples.d.ts +20 -15
  282. package/dist/tools/examples.d.ts.map +1 -1
  283. package/dist/tools/examples.js +74 -86
  284. package/dist/tools/examples.js.map +1 -1
  285. package/dist/tools/tests/test-setup.d.ts +5 -2
  286. package/dist/tools/tests/test-setup.d.ts.map +1 -1
  287. package/dist/tools/tests/test-setup.js +21 -28
  288. package/dist/tools/tests/test-setup.js.map +1 -1
  289. package/dist/utils/logger.d.ts +8 -5
  290. package/dist/utils/logger.d.ts.map +1 -1
  291. package/dist/utils/logger.js +17 -17
  292. package/dist/utils/logger.js.map +1 -1
  293. package/dist/utils/mcp-format.d.ts +8 -5
  294. package/dist/utils/mcp-format.d.ts.map +1 -1
  295. package/dist/utils/mcp-format.js +9 -9
  296. package/dist/utils/mcp-format.js.map +1 -1
  297. package/dist/utils/mdx.d.ts +8 -6
  298. package/dist/utils/mdx.d.ts.map +1 -1
  299. package/dist/utils/mdx.js +22 -22
  300. package/dist/utils/mdx.js.map +1 -1
  301. package/dist/utils/paths.d.ts +9 -6
  302. package/dist/utils/paths.d.ts.map +1 -1
  303. package/dist/utils/paths.js +66 -76
  304. package/dist/utils/paths.js.map +1 -1
  305. package/dist/utils/security.d.ts +4 -1
  306. package/dist/utils/security.d.ts.map +1 -1
  307. package/dist/utils/security.js +19 -40
  308. package/dist/utils/security.js.map +1 -1
  309. package/package.json +6 -6
  310. package/src/tools/tests/path-traversal.test.ts +1 -1
  311. package/.docs/raw/docs/(docs)/guides/branching.mdx +0 -65
  312. package/.docs/raw/docs/(docs)/guides/chain-of-thought.mdx +0 -164
  313. package/.docs/raw/docs/(docs)/guides/editing.mdx +0 -66
  314. package/.docs/raw/docs/(docs)/guides/speech.mdx +0 -38
  315. package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
  316. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
  317. package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
  318. package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
  319. package/.docs/raw/docs/(reference)/migrations/v0-14.mdx +0 -159
  320. package/.docs/raw/docs/runtimes/a2a/index.mdx +0 -298
  321. package/.docs/raw/docs/runtimes/assistant-transport.mdx +0 -1033
  322. package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +0 -314
  323. package/.docs/raw/docs/runtimes/custom/local.mdx +0 -1464
  324. package/.docs/raw/docs/runtimes/data-stream.mdx +0 -422
  325. package/.docs/raw/docs/runtimes/google-adk/index.mdx +0 -686
  326. package/.docs/raw/docs/runtimes/helicone.mdx +0 -61
  327. package/.docs/raw/docs/runtimes/langchain/comparison.mdx +0 -60
  328. package/.docs/raw/docs/runtimes/langchain/index.mdx +0 -210
  329. package/.docs/raw/docs/runtimes/langgraph/index.mdx +0 -699
  330. package/.docs/raw/docs/runtimes/langgraph/tutorial/index.mdx +0 -12
  331. package/.docs/raw/docs/runtimes/langserve.mdx +0 -116
  332. package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +0 -218
  333. package/.docs/raw/docs/runtimes/mastra/overview.mdx +0 -18
  334. package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +0 -217
  335. package/dist/prepare-docs/prepare.d.ts.map +0 -1
  336. package/dist/stdio.d.ts.map +0 -1
  337. /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
  338. /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
  339. /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
  340. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
  341. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
@@ -1,103 +0,0 @@
1
- ---
2
- title: "@assistant-ui/react-hook-form"
3
- description: React Hook Form integration for AI-assisted form filling.
4
- ---
5
-
6
- A React Hook Form integration for @assistant-ui.
7
-
8
-
9
- ## API Reference
10
-
11
- ### `useAssistantForm`
12
-
13
- Drop-in replacement hook for `useForm` that adds support for `@assistant-ui/react`.
14
-
15
- ```diff
16
- - import { useForm } from "react-hook-form";
17
- + import { useAssistantForm } from "@assistant-ui/react-hook-form";
18
-
19
- - useForm({
20
- + useAssistantForm({
21
- ...
22
- });
23
- ```
24
-
25
- #### Properties
26
-
27
- <ParametersTable
28
- type="UseAssistantFormProps"
29
- parameters={[
30
- {
31
- name: "assistant",
32
- type: "object",
33
- optional: true,
34
- description: "Configuration for useAssistantForm",
35
- children: [
36
- {
37
- parameters: [
38
- {
39
- name: "tools",
40
- type: "object",
41
- description: "Tools configuration for useAssistantForm",
42
- children: [
43
- {
44
- parameters: [
45
- {
46
- name: "set_form_field",
47
- type: "object",
48
- description: "Configuration for the set_form_field tool",
49
- children: [
50
- {
51
- parameters: [
52
- {
53
- name: "render",
54
- type: "ToolCallMessagePartComponent<{ name: string; value: string; }, {}>",
55
- description:
56
- "The component to render when set_form_field is called.",
57
- },
58
- ],
59
- },
60
- ],
61
- },
62
- {
63
- name: "submit_form",
64
- type: "object",
65
- description: "Configuration for the submit_form tool",
66
- children: [
67
- {
68
- parameters: [
69
- {
70
- name: "render",
71
- type: "ToolCallMessagePartComponent<{}, {}>",
72
- description:
73
- "The component to render when submit_form is called.",
74
- },
75
- ],
76
- },
77
- ],
78
- },
79
- ],
80
- },
81
- ],
82
- },
83
- ],
84
- },
85
- ],
86
- },
87
- ]}
88
- />
89
-
90
- ### `formTools`
91
-
92
- The set of tools to use with `useAssistantForm` on the server side. While the AI SDK now supports forwarding frontend tools via `frontendTools()`, using `formTools` directly on the server gives you more control over tool execution.
93
-
94
- ```tsx {1, 5-7}
95
- import { formTools } from "@assistant-ui/react-hook-form";
96
-
97
- const result = streamText({
98
- ...
99
- tools: {
100
- ...formTools,
101
- }
102
- });
103
- ```
@@ -1,254 +0,0 @@
1
- ---
2
- title: "@assistant-ui/react-ai-sdk"
3
- description: Vercel AI SDK integration with chat runtime hooks and transport utilities.
4
- ---
5
-
6
- Vercel AI SDK integration for assistant-ui.
7
-
8
-
9
- <Callout type="info">
10
- This package provides integration with AI SDK v6. For older versions, see the [AI
11
- SDK v5 (Legacy)](/docs/runtimes/ai-sdk/v5-legacy) or [AI SDK v4 (Legacy)](/docs/runtimes/ai-sdk/v4-legacy) documentation.
12
- </Callout>
13
-
14
- ## API Reference
15
-
16
- ### `useChatRuntime`
17
-
18
- Creates a runtime with AI SDK's `useChat` hook integration. This is the recommended approach for most use cases.
19
-
20
- ```tsx
21
- import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
22
- import { AssistantRuntimeProvider } from "@assistant-ui/react";
23
-
24
- const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
25
- const runtime = useChatRuntime({
26
- transport: new AssistantChatTransport({
27
- api: "/api/chat",
28
- }),
29
- });
30
-
31
- return (
32
- <AssistantRuntimeProvider runtime={runtime}>
33
- {children}
34
- </AssistantRuntimeProvider>
35
- );
36
- };
37
- ```
38
-
39
- To customize the API endpoint, simply change the `api` parameter:
40
-
41
- ```tsx
42
- const runtime = useChatRuntime({
43
- transport: new AssistantChatTransport({
44
- api: "/my-custom-api/chat",
45
- }),
46
- });
47
- ```
48
-
49
- <ParametersTable
50
- parameters={[
51
- {
52
- name: "options",
53
- type: "UseChatRuntimeOptions",
54
- description: "Configuration options for the chat runtime.",
55
- children: [
56
- {
57
- type: "UseChatRuntimeOptions",
58
- parameters: [
59
- {
60
- name: "transport",
61
- type: "ChatTransport",
62
- description:
63
- "Custom transport implementation. Defaults to AssistantChatTransport (which sends requests to '/api/chat' and forwards system messages and tools). Use `new AssistantChatTransport({ api: '/custom-endpoint' })` to customize the endpoint.",
64
- },
65
- {
66
- name: "cloud",
67
- type: "AssistantCloud",
68
- description:
69
- "Optional AssistantCloud instance for chat persistence.",
70
- },
71
- {
72
- name: "adapters",
73
- type: "RuntimeAdapters",
74
- description:
75
- "Optional runtime adapters to extend or override built-in functionality (attachments, speech, dictation, feedback, history).",
76
- },
77
- {
78
- name: "toCreateMessage",
79
- type: "(message: AppendMessage) => CreateUIMessage",
80
- description:
81
- "Optional custom function to convert an AppendMessage into an AI SDK CreateUIMessage before sending.",
82
- },
83
- {
84
- name: "initialMessages",
85
- type: "UIMessage[]",
86
- description: "Initial messages to populate the chat.",
87
- },
88
- {
89
- name: "onFinish",
90
- type: "(message: UIMessage) => void",
91
- description: "Callback when a message completes streaming.",
92
- },
93
- {
94
- name: "onError",
95
- type: "(error: Error) => void",
96
- description: "Callback for handling errors.",
97
- },
98
- ],
99
- },
100
- ],
101
- },
102
- ]}
103
- />
104
-
105
- <Callout type="info">
106
- By default, `useChatRuntime` uses `AssistantChatTransport` which automatically
107
- forwards system messages and frontend tools to your backend API. This enables
108
- your backend to receive the full context from the assistant-ui.
109
- </Callout>
110
-
111
- ### `useAISDKRuntime`
112
-
113
- For advanced use cases where you need direct access to the `useChat` hook from AI SDK.
114
-
115
- ```tsx
116
- import { useChat } from "@ai-sdk/react";
117
- import { useAISDKRuntime } from "@assistant-ui/react-ai-sdk";
118
- import { AssistantRuntimeProvider } from "@assistant-ui/react";
119
-
120
- const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
121
- const chat = useChat({
122
- api: "/api/chat",
123
- });
124
-
125
- const runtime = useAISDKRuntime(chat);
126
-
127
- return (
128
- <AssistantRuntimeProvider runtime={runtime}>
129
- {children}
130
- </AssistantRuntimeProvider>
131
- );
132
- };
133
- ```
134
-
135
- <ParametersTable
136
- parameters={[
137
- {
138
- name: "chat",
139
- type: "ReturnType<typeof useChat>",
140
- description: "The chat helpers from @ai-sdk/react's useChat hook.",
141
- },
142
- {
143
- name: "options",
144
- type: "AISDKRuntimeAdapter",
145
- description: "Optional configuration options.",
146
- children: [
147
- {
148
- type: "AISDKRuntimeAdapter",
149
- parameters: [
150
- {
151
- name: "adapters",
152
- type: "RuntimeAdapters",
153
- description:
154
- "Optional runtime adapters for attachments, feedback, speech, etc.",
155
- },
156
- ],
157
- },
158
- ],
159
- },
160
- ]}
161
- />
162
-
163
- ### `AssistantChatTransport`
164
-
165
- A transport that extends the default AI SDK transport to automatically forward system messages and frontend tools to your backend.
166
-
167
- ```tsx
168
- import { AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
169
- import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
170
-
171
- const runtime = useChatRuntime({
172
- transport: new AssistantChatTransport({
173
- api: "/my-custom-api/chat",
174
- }),
175
- });
176
- ```
177
-
178
- <ParametersTable
179
- parameters={[
180
- {
181
- name: "options",
182
- type: "HttpChatTransportInitOptions",
183
- description: "Transport configuration options.",
184
- children: [
185
- {
186
- type: "HttpChatTransportInitOptions",
187
- parameters: [
188
- {
189
- name: "api",
190
- type: "string",
191
- description: "The API endpoint URL.",
192
- },
193
- {
194
- name: "headers",
195
- type: "Record<string, string> | Headers",
196
- description: "Optional headers to include in requests.",
197
- },
198
- {
199
- name: "credentials",
200
- type: "RequestCredentials",
201
- description: "Optional credentials mode for fetch requests.",
202
- },
203
- ],
204
- },
205
- ],
206
- },
207
- ]}
208
- />
209
-
210
- ### `frontendTools`
211
-
212
- Helper function to convert frontend tool definitions to AI SDK format for use in your backend.
213
-
214
- ```tsx
215
- import { frontendTools } from "@assistant-ui/react-ai-sdk";
216
- import { streamText, convertToModelMessages } from "ai";
217
- import { openai } from "@ai-sdk/openai";
218
-
219
- export async function POST(req: Request) {
220
- const { messages, system, tools } = await req.json();
221
-
222
- const result = streamText({
223
- model: openai("gpt-4o"),
224
- system,
225
- messages: await convertToModelMessages(messages),
226
- tools: {
227
- // Wrap frontend tools with the helper
228
- ...frontendTools(tools),
229
- // Your backend tools
230
- myBackendTool: tool({
231
- // ...
232
- }),
233
- },
234
- });
235
-
236
- return result.toUIMessageStreamResponse();
237
- }
238
- ```
239
-
240
- <ParametersTable
241
- parameters={[
242
- {
243
- name: "tools",
244
- type: "Record<string, unknown>",
245
- description:
246
- "Frontend tools object forwarded from AssistantChatTransport.",
247
- },
248
- ]}
249
- />
250
-
251
- <Callout type="info">
252
- The `frontendTools` helper converts frontend tool definitions to the AI SDK
253
- format and ensures they are properly handled by the streaming response.
254
- </Callout>
@@ -1,159 +0,0 @@
1
- ---
2
- title: Migration to v0.14
3
- description: Primitives migrate from components prop to children render functions.
4
- ---
5
-
6
- ## Children API for Primitives
7
-
8
- Version 0.14 replaces the `components` prop on primitives with a children render function pattern. This gives you full control over rendering with simple inline logic.
9
-
10
- ### ThreadPrimitive.Messages
11
-
12
- **Before:**
13
-
14
- ```tsx
15
- <ThreadPrimitive.Messages
16
- components={{
17
- UserMessage,
18
- EditComposer,
19
- AssistantMessage,
20
- }}
21
- />
22
- ```
23
-
24
- **After:**
25
-
26
- ```tsx
27
- <ThreadPrimitive.Messages>
28
- {({ message }) => {
29
- if (message.composer.isEditing) return <EditComposer />;
30
- if (message.role === "user") return <UserMessage />;
31
- return <AssistantMessage />;
32
- }}
33
- </ThreadPrimitive.Messages>
34
- ```
35
-
36
- ### MessagePrimitive.Parts
37
-
38
- **Before:**
39
-
40
- ```tsx
41
- <MessagePrimitive.Parts
42
- components={{
43
- Text: MarkdownText,
44
- Reasoning,
45
- tools: { Fallback: ToolFallback },
46
- }}
47
- />
48
- ```
49
-
50
- **After:**
51
-
52
- ```tsx
53
- <MessagePrimitive.Parts>
54
- {({ part }) => {
55
- if (part.type === "text") return <MarkdownText />;
56
- if (part.type === "reasoning") return <Reasoning {...part} />;
57
- if (part.type === "tool-call")
58
- return part.toolUI ?? <ToolFallback {...part} />;
59
- return null;
60
- }}
61
- </MessagePrimitive.Parts>
62
- ```
63
-
64
- ### `part.toolUI` and `part.dataRendererUI`
65
-
66
- Tool-call parts now expose a `toolUI` property that resolves to the registered tool UI (via `useAssistantToolUI` / `makeAssistantToolUI`) or `null` if none is registered. Data parts similarly expose `dataRendererUI`.
67
-
68
- ```tsx
69
- // Renders the registered tool UI if available, otherwise ToolFallback
70
- if (part.type === "tool-call")
71
- return part.toolUI ?? <ToolFallback {...part} />;
72
-
73
- // Renders the registered data renderer if available
74
- if (part.type === "data")
75
- return part.dataRendererUI ?? null;
76
- ```
77
-
78
- ### Returning `null`
79
-
80
- Returning `null` from the children function renders registered tool UIs and data renderer UIs automatically via the registry. To explicitly render nothing (suppressing registered UIs), return `<></>`.
81
-
82
- ```tsx
83
- <MessagePrimitive.Parts>
84
- {({ part }) => {
85
- if (part.type === "text") return <MarkdownText />;
86
- return null; // registered tool/data UIs still render
87
- }}
88
- </MessagePrimitive.Parts>
89
- ```
90
-
91
- ### ThreadPrimitive.Suggestions
92
-
93
- **Before:**
94
-
95
- ```tsx
96
- <ThreadPrimitive.Suggestions
97
- components={{ Suggestion: SuggestionItem }}
98
- />
99
- ```
100
-
101
- **After:**
102
-
103
- ```tsx
104
- <ThreadPrimitive.Suggestions>
105
- {() => <SuggestionItem />}
106
- </ThreadPrimitive.Suggestions>
107
- ```
108
-
109
- ### ThreadListPrimitive.Items
110
-
111
- **Before:**
112
-
113
- ```tsx
114
- <ThreadListPrimitive.Items
115
- components={{ ThreadListItem: MyThreadListItem }}
116
- />
117
- ```
118
-
119
- **After:**
120
-
121
- ```tsx
122
- <ThreadListPrimitive.Items>
123
- {() => <MyThreadListItem />}
124
- </ThreadListPrimitive.Items>
125
- ```
126
-
127
- ### Attachments
128
-
129
- **Before:**
130
-
131
- ```tsx
132
- <ComposerPrimitive.Attachments
133
- components={{ Attachment: MyAttachment }}
134
- />
135
- ```
136
-
137
- **After:**
138
-
139
- ```tsx
140
- <ComposerPrimitive.Attachments>
141
- {() => <MyAttachment />}
142
- </ComposerPrimitive.Attachments>
143
- ```
144
-
145
- ### `addResult` / `resume` on enriched part state
146
-
147
- When using the children API, tool-call parts include `addResult` and `resume` methods directly on the part object. This means `<ToolFallback {...part} />` works without needing a wrapper component to provide these methods.
148
-
149
- ### Backwards Compatibility
150
-
151
- The `components` prop is still supported on all primitives but is deprecated and will be removed in a future version.
152
-
153
- ## Getting Help
154
-
155
- If you encounter issues during migration:
156
-
157
- 1. Check the updated API documentation for detailed examples
158
- 2. Review the example applications in the repository
159
- 3. Report issues at https://github.com/assistant-ui/assistant-ui/issues