@assistant-ui/mcp-docs-server 0.2.2 → 0.3.0

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 (459) hide show
  1. package/README.md +16 -43
  2. package/dist/index.d.ts +2 -3
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +3 -91
  5. package/dist/index.js.map +1 -1
  6. package/dist/proxy.d.ts +9 -0
  7. package/dist/proxy.d.ts.map +1 -0
  8. package/dist/proxy.js +76 -0
  9. package/dist/proxy.js.map +1 -0
  10. package/package.json +9 -13
  11. package/src/index.ts +3 -115
  12. package/src/proxy.test.ts +250 -0
  13. package/src/proxy.ts +111 -0
  14. package/.docs/organized/code-examples/waterfall.md +0 -807
  15. package/.docs/organized/code-examples/with-a2a.md +0 -674
  16. package/.docs/organized/code-examples/with-ag-ui.md +0 -552
  17. package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -465
  18. package/.docs/organized/code-examples/with-artifacts.md +0 -814
  19. package/.docs/organized/code-examples/with-assistant-transport.md +0 -575
  20. package/.docs/organized/code-examples/with-browser-extension.md +0 -371
  21. package/.docs/organized/code-examples/with-chain-of-thought.md +0 -960
  22. package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
  23. package/.docs/organized/code-examples/with-cloud.md +0 -438
  24. package/.docs/organized/code-examples/with-custom-thread-list.md +0 -568
  25. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -526
  26. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -696
  27. package/.docs/organized/code-examples/with-eve.md +0 -404
  28. package/.docs/organized/code-examples/with-expo.md +0 -2063
  29. package/.docs/organized/code-examples/with-external-store.md +0 -420
  30. package/.docs/organized/code-examples/with-ffmpeg.md +0 -828
  31. package/.docs/organized/code-examples/with-generative-ui.md +0 -1812
  32. package/.docs/organized/code-examples/with-google-adk.md +0 -367
  33. package/.docs/organized/code-examples/with-heat-graph.md +0 -304
  34. package/.docs/organized/code-examples/with-image-generation.md +0 -462
  35. package/.docs/organized/code-examples/with-interactables.md +0 -732
  36. package/.docs/organized/code-examples/with-langchain.md +0 -445
  37. package/.docs/organized/code-examples/with-langgraph.md +0 -854
  38. package/.docs/organized/code-examples/with-livekit.md +0 -642
  39. package/.docs/organized/code-examples/with-mcp.md +0 -780
  40. package/.docs/organized/code-examples/with-nuxt.md +0 -2428
  41. package/.docs/organized/code-examples/with-opencode.md +0 -1974
  42. package/.docs/organized/code-examples/with-openui.md +0 -449
  43. package/.docs/organized/code-examples/with-pi.md +0 -2083
  44. package/.docs/organized/code-examples/with-react-hook-form.md +0 -724
  45. package/.docs/organized/code-examples/with-react-ink-web.md +0 -690
  46. package/.docs/organized/code-examples/with-react-ink.md +0 -472
  47. package/.docs/organized/code-examples/with-react-router.md +0 -935
  48. package/.docs/organized/code-examples/with-resumable-stream.md +0 -667
  49. package/.docs/organized/code-examples/with-store.md +0 -679
  50. package/.docs/organized/code-examples/with-svelte.md +0 -415
  51. package/.docs/organized/code-examples/with-sveltekit.md +0 -1061
  52. package/.docs/organized/code-examples/with-tanstack.md +0 -811
  53. package/.docs/organized/code-examples/with-tap-runtime.md +0 -812
  54. package/.docs/organized/code-examples/with-virtualized-thread.md +0 -680
  55. package/.docs/organized/code-examples/with-vue.md +0 -408
  56. package/.docs/raw/docs/(docs)/architecture.mdx +0 -146
  57. package/.docs/raw/docs/(docs)/base-ui.mdx +0 -39
  58. package/.docs/raw/docs/(docs)/cli.mdx +0 -542
  59. package/.docs/raw/docs/(docs)/devtools.mdx +0 -79
  60. package/.docs/raw/docs/(docs)/index.mdx +0 -21
  61. package/.docs/raw/docs/(docs)/installation.mdx +0 -483
  62. package/.docs/raw/docs/(docs)/llm.mdx +0 -211
  63. package/.docs/raw/docs/(docs)/rtl.mdx +0 -78
  64. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +0 -36
  65. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +0 -20
  66. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +0 -34
  67. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +0 -44
  68. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +0 -59
  69. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +0 -20
  70. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +0 -20
  71. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -84
  72. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +0 -22
  73. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +0 -64
  74. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +0 -22
  75. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +0 -52
  76. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +0 -49
  77. package/.docs/raw/docs/(reference)/api-reference/generative-ui/a2ui.mdx +0 -40
  78. package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +0 -56
  79. package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +0 -86
  80. package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +0 -39
  81. package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +0 -42
  82. package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +0 -84
  83. package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +0 -85
  84. package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +0 -45
  85. package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +0 -93
  86. package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +0 -62
  87. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +0 -129
  88. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +0 -31
  89. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +0 -34
  90. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +0 -350
  91. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +0 -28
  92. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +0 -97
  93. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
  94. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -97
  95. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
  96. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +0 -200
  97. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -37
  98. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +0 -50
  99. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +0 -22
  100. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +0 -20
  101. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +0 -566
  102. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +0 -152
  103. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +0 -239
  104. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -208
  105. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +0 -108
  106. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -99
  107. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -145
  108. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +0 -82
  109. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +0 -619
  110. package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -22
  111. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -65
  112. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +0 -73
  113. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +0 -117
  114. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -339
  115. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +0 -77
  116. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +0 -88
  117. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -81
  118. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -129
  119. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +0 -138
  120. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +0 -122
  121. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -289
  122. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -20
  123. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +0 -24
  124. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +0 -32
  125. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +0 -43
  126. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +0 -43
  127. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +0 -24
  128. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +0 -20
  129. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -24
  130. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -24
  131. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +0 -36
  132. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +0 -85
  133. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +0 -45
  134. package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx +0 -55
  135. package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +0 -151
  136. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +0 -106
  137. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -62
  138. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +0 -178
  139. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +0 -48
  140. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +0 -62
  141. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +0 -22
  142. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +0 -19
  143. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +0 -149
  144. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +0 -22
  145. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +0 -54
  146. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +0 -36
  147. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +0 -527
  148. package/.docs/raw/docs/cloud/ai-sdk.mdx +0 -602
  149. package/.docs/raw/docs/cloud/authorization.mdx +0 -252
  150. package/.docs/raw/docs/cloud/index.mdx +0 -46
  151. package/.docs/raw/docs/cloud/langgraph.mdx +0 -554
  152. package/.docs/raw/docs/copilots/assistant-frame.mdx +0 -400
  153. package/.docs/raw/docs/copilots/make-assistant-visible.mdx +0 -82
  154. package/.docs/raw/docs/copilots/model-context.mdx +0 -156
  155. package/.docs/raw/docs/copilots/motivation.mdx +0 -202
  156. package/.docs/raw/docs/copilots/use-assistant-instructions.mdx +0 -64
  157. package/.docs/raw/docs/guides/attachments.mdx +0 -619
  158. package/.docs/raw/docs/guides/branching.mdx +0 -76
  159. package/.docs/raw/docs/guides/chain-of-thought.mdx +0 -164
  160. package/.docs/raw/docs/guides/chatgpt-subscription.mdx +0 -108
  161. package/.docs/raw/docs/guides/context-api.mdx +0 -619
  162. package/.docs/raw/docs/guides/dictation.mdx +0 -298
  163. package/.docs/raw/docs/guides/editing.mdx +0 -102
  164. package/.docs/raw/docs/guides/electron.mdx +0 -369
  165. package/.docs/raw/docs/guides/headless-composer-input.mdx +0 -113
  166. package/.docs/raw/docs/guides/image-generation.mdx +0 -74
  167. package/.docs/raw/docs/guides/index.mdx +0 -117
  168. package/.docs/raw/docs/guides/input-history.mdx +0 -55
  169. package/.docs/raw/docs/guides/latex.mdx +0 -158
  170. package/.docs/raw/docs/guides/mentions.mdx +0 -575
  171. package/.docs/raw/docs/guides/message-timing.mdx +0 -209
  172. package/.docs/raw/docs/guides/quoting.mdx +0 -169
  173. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +0 -212
  174. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +0 -152
  175. package/.docs/raw/docs/guides/resumable-streams.mdx +0 -292
  176. package/.docs/raw/docs/guides/slash-commands.mdx +0 -358
  177. package/.docs/raw/docs/guides/speech.mdx +0 -172
  178. package/.docs/raw/docs/guides/suggestions.mdx +0 -384
  179. package/.docs/raw/docs/guides/virtualization.mdx +0 -133
  180. package/.docs/raw/docs/guides/voice.mdx +0 -310
  181. package/.docs/raw/docs/ink/adapters.mdx +0 -99
  182. package/.docs/raw/docs/ink/custom-backend.mdx +0 -254
  183. package/.docs/raw/docs/ink/hooks.mdx +0 -469
  184. package/.docs/raw/docs/ink/index.mdx +0 -236
  185. package/.docs/raw/docs/ink/migration.mdx +0 -138
  186. package/.docs/raw/docs/ink/primitives.mdx +0 -1259
  187. package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +0 -528
  188. package/.docs/raw/docs/integrations/auth/better-auth.mdx +0 -188
  189. package/.docs/raw/docs/integrations/auth/clerk.mdx +0 -166
  190. package/.docs/raw/docs/integrations/auth/next-auth.mdx +0 -191
  191. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +0 -88
  192. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +0 -282
  193. package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +0 -188
  194. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +0 -57
  195. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +0 -201
  196. package/.docs/raw/docs/integrations/gateways/index.mdx +0 -162
  197. package/.docs/raw/docs/integrations/index.mdx +0 -178
  198. package/.docs/raw/docs/integrations/observability/helicone.mdx +0 -129
  199. package/.docs/raw/docs/integrations/observability/langfuse.mdx +0 -161
  200. package/.docs/raw/docs/integrations/observability/langsmith.mdx +0 -151
  201. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +0 -773
  202. package/.docs/raw/docs/migrations/deprecation-policy.mdx +0 -42
  203. package/.docs/raw/docs/migrations/index.mdx +0 -50
  204. package/.docs/raw/docs/migrations/react-compatibility.mdx +0 -74
  205. package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +0 -328
  206. package/.docs/raw/docs/migrations/toolkit-tools.mdx +0 -236
  207. package/.docs/raw/docs/migrations/v0-11.mdx +0 -172
  208. package/.docs/raw/docs/migrations/v0-12.mdx +0 -302
  209. package/.docs/raw/docs/migrations/v0-14.mdx +0 -297
  210. package/.docs/raw/docs/migrations/v0-15.mdx +0 -270
  211. package/.docs/raw/docs/primitives/action-bar.mdx +0 -352
  212. package/.docs/raw/docs/primitives/assistant-modal.mdx +0 -216
  213. package/.docs/raw/docs/primitives/attachment.mdx +0 -217
  214. package/.docs/raw/docs/primitives/branch-picker.mdx +0 -222
  215. package/.docs/raw/docs/primitives/chain-of-thought.mdx +0 -315
  216. package/.docs/raw/docs/primitives/composer.mdx +0 -659
  217. package/.docs/raw/docs/primitives/error.mdx +0 -142
  218. package/.docs/raw/docs/primitives/index.mdx +0 -99
  219. package/.docs/raw/docs/primitives/message.mdx +0 -618
  220. package/.docs/raw/docs/primitives/selection-toolbar.mdx +0 -191
  221. package/.docs/raw/docs/primitives/suggestion.mdx +0 -254
  222. package/.docs/raw/docs/primitives/thread-list.mdx +0 -467
  223. package/.docs/raw/docs/primitives/thread.mdx +0 -509
  224. package/.docs/raw/docs/react-native/adapters.mdx +0 -94
  225. package/.docs/raw/docs/react-native/custom-backend.mdx +0 -207
  226. package/.docs/raw/docs/react-native/hooks.mdx +0 -339
  227. package/.docs/raw/docs/react-native/index.mdx +0 -289
  228. package/.docs/raw/docs/react-native/migration.mdx +0 -142
  229. package/.docs/raw/docs/react-native/primitives.mdx +0 -839
  230. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +0 -399
  231. package/.docs/raw/docs/runtimes/a2a/overview.mdx +0 -60
  232. package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +0 -216
  233. package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +0 -124
  234. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +0 -70
  235. package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +0 -243
  236. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +0 -255
  237. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +0 -61
  238. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -122
  239. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +0 -135
  240. package/.docs/raw/docs/runtimes/ai-sdk/v6-legacy.mdx +0 -636
  241. package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +0 -716
  242. package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +0 -118
  243. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +0 -265
  244. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +0 -167
  245. package/.docs/raw/docs/runtimes/concepts/stability.mdx +0 -68
  246. package/.docs/raw/docs/runtimes/concepts/threads.mdx +0 -513
  247. package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +0 -763
  248. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +0 -339
  249. package/.docs/raw/docs/runtimes/custom/external-store.mdx +0 -957
  250. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +0 -902
  251. package/.docs/raw/docs/runtimes/custom/overview.mdx +0 -71
  252. package/.docs/raw/docs/runtimes/eve/overview.mdx +0 -151
  253. package/.docs/raw/docs/runtimes/eve/quickstart.mdx +0 -192
  254. package/.docs/raw/docs/runtimes/google-adk/api.mdx +0 -256
  255. package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +0 -784
  256. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +0 -69
  257. package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +0 -229
  258. package/.docs/raw/docs/runtimes/langchain.mdx +0 -901
  259. package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +0 -181
  260. package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +0 -305
  261. package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +0 -104
  262. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +0 -84
  263. package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +0 -496
  264. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +0 -144
  265. package/.docs/raw/docs/runtimes/langgraph/threads.mdx +0 -113
  266. package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +0 -29
  267. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -93
  268. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +0 -347
  269. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -393
  270. package/.docs/raw/docs/runtimes/opencode/hooks.mdx +0 -194
  271. package/.docs/raw/docs/runtimes/opencode/overview.mdx +0 -58
  272. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +0 -119
  273. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +0 -133
  274. package/.docs/raw/docs/tools/a2ui.mdx +0 -107
  275. package/.docs/raw/docs/tools/backend.mdx +0 -147
  276. package/.docs/raw/docs/tools/defining-tools.mdx +0 -574
  277. package/.docs/raw/docs/tools/dynamic-tools.mdx +0 -112
  278. package/.docs/raw/docs/tools/generative-ui-primitive.mdx +0 -180
  279. package/.docs/raw/docs/tools/generative-ui-slack.mdx +0 -167
  280. package/.docs/raw/docs/tools/generative-ui-teams.mdx +0 -160
  281. package/.docs/raw/docs/tools/generative-ui.mdx +0 -322
  282. package/.docs/raw/docs/tools/index.mdx +0 -72
  283. package/.docs/raw/docs/tools/interactables.mdx +0 -1084
  284. package/.docs/raw/docs/tools/mcp-apps.mdx +0 -346
  285. package/.docs/raw/docs/tools/mcp.mdx +0 -466
  286. package/.docs/raw/docs/tools/multi-agent.mdx +0 -237
  287. package/.docs/raw/docs/tools/openui.mdx +0 -175
  288. package/.docs/raw/docs/tools/tool-ui.mdx +0 -1008
  289. package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
  290. package/.docs/raw/docs/ui/accordion.mdx +0 -266
  291. package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
  292. package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
  293. package/.docs/raw/docs/ui/attachment.mdx +0 -259
  294. package/.docs/raw/docs/ui/badge.mdx +0 -150
  295. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -212
  296. package/.docs/raw/docs/ui/context-display.mdx +0 -148
  297. package/.docs/raw/docs/ui/diff-viewer.mdx +0 -280
  298. package/.docs/raw/docs/ui/directive-text.mdx +0 -114
  299. package/.docs/raw/docs/ui/dot-matrix.mdx +0 -133
  300. package/.docs/raw/docs/ui/file.mdx +0 -159
  301. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
  302. package/.docs/raw/docs/ui/image.mdx +0 -102
  303. package/.docs/raw/docs/ui/markdown.mdx +0 -64
  304. package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
  305. package/.docs/raw/docs/ui/mermaid.mdx +0 -92
  306. package/.docs/raw/docs/ui/message-timing.mdx +0 -93
  307. package/.docs/raw/docs/ui/model-selector.mdx +0 -455
  308. package/.docs/raw/docs/ui/number-roll.mdx +0 -154
  309. package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
  310. package/.docs/raw/docs/ui/quote.mdx +0 -211
  311. package/.docs/raw/docs/ui/reasoning.mdx +0 -186
  312. package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
  313. package/.docs/raw/docs/ui/select.mdx +0 -254
  314. package/.docs/raw/docs/ui/sources.mdx +0 -177
  315. package/.docs/raw/docs/ui/streamdown.mdx +0 -392
  316. package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
  317. package/.docs/raw/docs/ui/tabs.mdx +0 -271
  318. package/.docs/raw/docs/ui/thread-list.mdx +0 -372
  319. package/.docs/raw/docs/ui/thread.mdx +0 -512
  320. package/.docs/raw/docs/ui/tool-fallback.mdx +0 -127
  321. package/.docs/raw/docs/ui/tool-group.mdx +0 -240
  322. package/.docs/raw/docs/ui/voice.mdx +0 -173
  323. package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
  324. package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
  325. package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
  326. package/dist/constants.d.ts +0 -14
  327. package/dist/constants.d.ts.map +0 -1
  328. package/dist/constants.js +0 -19
  329. package/dist/constants.js.map +0 -1
  330. package/dist/prepare-docs/code-examples.d.ts +0 -5
  331. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  332. package/dist/prepare-docs/code-examples.js +0 -117
  333. package/dist/prepare-docs/code-examples.js.map +0 -1
  334. package/dist/prepare-docs/copy-raw.d.ts +0 -5
  335. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  336. package/dist/prepare-docs/copy-raw.js +0 -49
  337. package/dist/prepare-docs/copy-raw.js.map +0 -1
  338. package/dist/prepare-docs/prepare.d.ts +0 -1
  339. package/dist/prepare-docs/prepare.js +0 -22
  340. package/dist/prepare-docs/prepare.js.map +0 -1
  341. package/dist/prompts/xulux-playground.d.ts +0 -12
  342. package/dist/prompts/xulux-playground.d.ts.map +0 -1
  343. package/dist/prompts/xulux-playground.js +0 -33
  344. package/dist/prompts/xulux-playground.js.map +0 -1
  345. package/dist/tools/docs.d.ts +0 -22
  346. package/dist/tools/docs.d.ts.map +0 -1
  347. package/dist/tools/docs.js +0 -177
  348. package/dist/tools/docs.js.map +0 -1
  349. package/dist/tools/examples.d.ts +0 -24
  350. package/dist/tools/examples.d.ts.map +0 -1
  351. package/dist/tools/examples.js +0 -87
  352. package/dist/tools/examples.js.map +0 -1
  353. package/dist/tools/resources.d.ts +0 -6
  354. package/dist/tools/resources.d.ts.map +0 -1
  355. package/dist/tools/resources.js +0 -75
  356. package/dist/tools/resources.js.map +0 -1
  357. package/dist/tools/search.d.ts +0 -24
  358. package/dist/tools/search.d.ts.map +0 -1
  359. package/dist/tools/search.js +0 -39
  360. package/dist/tools/search.js.map +0 -1
  361. package/dist/tools/tests/mcp-test-client.d.ts +0 -15
  362. package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
  363. package/dist/tools/tests/mcp-test-client.js +0 -68
  364. package/dist/tools/tests/mcp-test-client.js.map +0 -1
  365. package/dist/tools/tests/test-setup.d.ts +0 -7
  366. package/dist/tools/tests/test-setup.d.ts.map +0 -1
  367. package/dist/tools/tests/test-setup.js +0 -36
  368. package/dist/tools/tests/test-setup.js.map +0 -1
  369. package/dist/tools/xulux-templates.d.ts +0 -58
  370. package/dist/tools/xulux-templates.d.ts.map +0 -1
  371. package/dist/tools/xulux-templates.js +0 -84
  372. package/dist/tools/xulux-templates.js.map +0 -1
  373. package/dist/utils/cache.d.ts +0 -5
  374. package/dist/utils/cache.d.ts.map +0 -1
  375. package/dist/utils/cache.js +0 -18
  376. package/dist/utils/cache.js.map +0 -1
  377. package/dist/utils/logger.d.ts +0 -10
  378. package/dist/utils/logger.d.ts.map +0 -1
  379. package/dist/utils/logger.js +0 -20
  380. package/dist/utils/logger.js.map +0 -1
  381. package/dist/utils/mcp-format.d.ts +0 -11
  382. package/dist/utils/mcp-format.d.ts.map +0 -1
  383. package/dist/utils/mcp-format.js +0 -14
  384. package/dist/utils/mcp-format.js.map +0 -1
  385. package/dist/utils/mdx.d.ts +0 -12
  386. package/dist/utils/mdx.d.ts.map +0 -1
  387. package/dist/utils/mdx.js +0 -45
  388. package/dist/utils/mdx.js.map +0 -1
  389. package/dist/utils/paths.d.ts +0 -12
  390. package/dist/utils/paths.d.ts.map +0 -1
  391. package/dist/utils/paths.js +0 -93
  392. package/dist/utils/paths.js.map +0 -1
  393. package/dist/utils/search.d.ts +0 -10
  394. package/dist/utils/search.d.ts.map +0 -1
  395. package/dist/utils/search.js +0 -97
  396. package/dist/utils/search.js.map +0 -1
  397. package/dist/utils/security.d.ts +0 -5
  398. package/dist/utils/security.d.ts.map +0 -1
  399. package/dist/utils/security.js +0 -22
  400. package/dist/utils/security.js.map +0 -1
  401. package/dist/xulux/catalog-client.d.ts +0 -14
  402. package/dist/xulux/catalog-client.d.ts.map +0 -1
  403. package/dist/xulux/catalog-client.js +0 -67
  404. package/dist/xulux/catalog-client.js.map +0 -1
  405. package/dist/xulux/fallback-catalog.d.ts +0 -7
  406. package/dist/xulux/fallback-catalog.d.ts.map +0 -1
  407. package/dist/xulux/fallback-catalog.js +0 -47
  408. package/dist/xulux/fallback-catalog.js.map +0 -1
  409. package/dist/xulux/fetch-sandbox.d.ts +0 -5
  410. package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
  411. package/dist/xulux/fetch-sandbox.js +0 -40
  412. package/dist/xulux/fetch-sandbox.js.map +0 -1
  413. package/dist/xulux/template-service.d.ts +0 -84
  414. package/dist/xulux/template-service.d.ts.map +0 -1
  415. package/dist/xulux/template-service.js +0 -223
  416. package/dist/xulux/template-service.js.map +0 -1
  417. package/dist/xulux/types.d.ts +0 -55
  418. package/dist/xulux/types.d.ts.map +0 -1
  419. package/dist/xulux/types.js +0 -6
  420. package/dist/xulux/types.js.map +0 -1
  421. package/src/constants.ts +0 -24
  422. package/src/prepare-docs/code-examples.ts +0 -158
  423. package/src/prepare-docs/copy-raw.ts +0 -50
  424. package/src/prepare-docs/prepare.ts +0 -24
  425. package/src/prompts/xulux-playground.ts +0 -36
  426. package/src/tools/docs.ts +0 -255
  427. package/src/tools/examples.ts +0 -114
  428. package/src/tools/resources.ts +0 -111
  429. package/src/tools/search.ts +0 -46
  430. package/src/tools/tests/completions.test.ts +0 -60
  431. package/src/tools/tests/directory-size-cap.test.ts +0 -50
  432. package/src/tools/tests/docs.test.ts +0 -144
  433. package/src/tools/tests/examples.test.ts +0 -94
  434. package/src/tools/tests/integration.test.ts +0 -45
  435. package/src/tools/tests/json-parsing.test.ts +0 -23
  436. package/src/tools/tests/listings-cache.test.ts +0 -19
  437. package/src/tools/tests/mcp-protocol.test.ts +0 -216
  438. package/src/tools/tests/mcp-test-client.ts +0 -111
  439. package/src/tools/tests/path-traversal.test.ts +0 -81
  440. package/src/tools/tests/resources.test.ts +0 -133
  441. package/src/tools/tests/search.test.ts +0 -37
  442. package/src/tools/tests/test-setup.ts +0 -50
  443. package/src/tools/tests/xulux-templates.test.ts +0 -262
  444. package/src/tools/xulux-templates.ts +0 -141
  445. package/src/utils/cache.ts +0 -20
  446. package/src/utils/logger.ts +0 -20
  447. package/src/utils/mcp-format.ts +0 -14
  448. package/src/utils/mdx.ts +0 -59
  449. package/src/utils/paths.ts +0 -139
  450. package/src/utils/search.ts +0 -131
  451. package/src/utils/security.ts +0 -52
  452. package/src/utils/tests/cache.test.ts +0 -51
  453. package/src/utils/tests/mcp-format.test.ts +0 -22
  454. package/src/utils/tests/security.test.ts +0 -119
  455. package/src/xulux/catalog-client.ts +0 -105
  456. package/src/xulux/fallback-catalog.ts +0 -63
  457. package/src/xulux/fetch-sandbox.ts +0 -56
  458. package/src/xulux/template-service.ts +0 -406
  459. package/src/xulux/types.ts +0 -60
@@ -1,289 +0,0 @@
1
- ---
2
- title: ThreadPrimitive
3
- description: Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui.
4
- ---
5
-
6
- import { ThreadPrimitiveIfProps, ThreadPrimitiveMessageByIndexProps, ThreadPrimitiveMessagesProps, ThreadPrimitiveRootProps, ThreadPrimitiveScrollToBottomProps, ThreadPrimitiveSuggestionByIndexProps, ThreadPrimitiveSuggestionProps, ThreadPrimitiveSuggestionsProps, ThreadPrimitiveUnstable_MessageByIdProps, ThreadPrimitiveViewportFooterProps, ThreadPrimitiveViewportProps, ThreadPrimitiveViewportProviderProps } from "@/generated/typeDocs";
7
- import { ThreadPrimitive as ThreadPrimitiveDocs } from "@/generated/primitiveDocs";
8
-
9
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
- {/* Do not edit manually. */}
11
-
12
- For examples and usage patterns, see [Thread](/docs/primitives/thread).
13
-
14
- {/* api-manual:start */}
15
- ## Anatomy
16
-
17
- ```tsx
18
- import { ThreadPrimitive } from "@assistant-ui/react";
19
-
20
- const Thread = () => (
21
- <ThreadPrimitive.Root>
22
- <ThreadPrimitive.Viewport>
23
- <AuiIf condition={(s) => s.thread.isEmpty}>...</AuiIf>
24
- <ThreadPrimitive.Messages>{...}</ThreadPrimitive.Messages>
25
- <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
26
- <Composer />
27
- </ThreadPrimitive.ViewportFooter>
28
- </ThreadPrimitive.Viewport>
29
- </ThreadPrimitive.Root>
30
- );
31
- ```
32
- {/* api-manual:end */}
33
-
34
- {/* api-reference:start */}
35
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
36
- {/* Do not edit this block manually. */}
37
-
38
- ## API Reference
39
-
40
- ### Root
41
-
42
- {ThreadPrimitiveDocs.Root?.deprecated && (
43
- <Callout type="warn">
44
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Root.deprecated}
45
- </Callout>
46
- )}
47
-
48
- {ThreadPrimitiveDocs.Root?.description}
49
-
50
- {ThreadPrimitiveDocs.Root?.element && (
51
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
52
- )}
53
-
54
- ```tsx
55
- <ThreadPrimitive.Root>
56
- <ThreadPrimitive.Viewport>
57
- <ThreadPrimitive.Messages>
58
- {() => <MyMessage />}
59
- </ThreadPrimitive.Messages>
60
- </ThreadPrimitive.Viewport>
61
- </ThreadPrimitive.Root>
62
- ```
63
-
64
- <ParametersTable {...ThreadPrimitiveRootProps} />
65
-
66
- ### Empty
67
-
68
- {ThreadPrimitiveDocs.Empty?.deprecated && (
69
- <Callout type="warn">
70
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Empty.deprecated}
71
- </Callout>
72
- )}
73
-
74
- {ThreadPrimitiveDocs.Empty?.description}
75
-
76
- {ThreadPrimitiveDocs.Empty?.element && (
77
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Empty?.element}>`}</code> element unless <code>asChild</code> is set.</p>
78
- )}
79
-
80
- {ThreadPrimitiveDocs.Empty?.props && (
81
- <ParametersTable type={ThreadPrimitiveDocs.Empty?.element} parameters={ThreadPrimitiveDocs.Empty.props} />
82
- )}
83
-
84
- ### If
85
-
86
- {ThreadPrimitiveDocs.If?.deprecated && (
87
- <Callout type="warn">
88
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.If.deprecated}
89
- </Callout>
90
- )}
91
-
92
- {ThreadPrimitiveDocs.If?.description}
93
-
94
- {ThreadPrimitiveDocs.If?.element && (
95
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.If?.element}>`}</code> element unless <code>asChild</code> is set.</p>
96
- )}
97
-
98
- <ParametersTable {...ThreadPrimitiveIfProps} />
99
-
100
- ### Viewport
101
-
102
- {ThreadPrimitiveDocs.Viewport?.deprecated && (
103
- <Callout type="warn">
104
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Viewport.deprecated}
105
- </Callout>
106
- )}
107
-
108
- {ThreadPrimitiveDocs.Viewport?.description}
109
-
110
- {ThreadPrimitiveDocs.Viewport?.element && (
111
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Viewport?.element}>`}</code> element unless <code>asChild</code> is set.</p>
112
- )}
113
-
114
- ```tsx
115
- <ThreadPrimitive.Viewport turnAnchor="top">
116
- <ThreadPrimitive.Messages>
117
- {() => <MyMessage />}
118
- </ThreadPrimitive.Messages>
119
- </ThreadPrimitive.Viewport>
120
- ```
121
-
122
- <ParametersTable {...ThreadPrimitiveViewportProps} />
123
-
124
- ### ViewportProvider
125
-
126
- {ThreadPrimitiveDocs.ViewportProvider?.deprecated && (
127
- <Callout type="warn">
128
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ViewportProvider.deprecated}
129
- </Callout>
130
- )}
131
-
132
- {ThreadPrimitiveDocs.ViewportProvider?.description}
133
-
134
- {ThreadPrimitiveDocs.ViewportProvider?.element && (
135
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportProvider?.element}>`}</code> element unless <code>asChild</code> is set.</p>
136
- )}
137
-
138
- <ParametersTable {...ThreadPrimitiveViewportProviderProps} />
139
-
140
- ### ViewportFooter
141
-
142
- {ThreadPrimitiveDocs.ViewportFooter?.deprecated && (
143
- <Callout type="warn">
144
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ViewportFooter.deprecated}
145
- </Callout>
146
- )}
147
-
148
- {ThreadPrimitiveDocs.ViewportFooter?.description}
149
-
150
- {ThreadPrimitiveDocs.ViewportFooter?.element && (
151
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportFooter?.element}>`}</code> element unless <code>asChild</code> is set.</p>
152
- )}
153
-
154
- ```tsx
155
- <ThreadPrimitive.Viewport>
156
- <ThreadPrimitive.Messages>
157
- {() => <MyMessage />}
158
- </ThreadPrimitive.Messages>
159
- <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
160
- <Composer />
161
- </ThreadPrimitive.ViewportFooter>
162
- </ThreadPrimitive.Viewport>
163
- ```
164
-
165
- <ParametersTable {...ThreadPrimitiveViewportFooterProps} />
166
-
167
- ### Messages
168
-
169
- {ThreadPrimitiveDocs.Messages?.deprecated && (
170
- <Callout type="warn">
171
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Messages.deprecated}
172
- </Callout>
173
- )}
174
-
175
- {ThreadPrimitiveDocs.Messages?.description}
176
-
177
- {ThreadPrimitiveDocs.Messages?.element && (
178
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Messages?.element}>`}</code> element unless <code>asChild</code> is set.</p>
179
- )}
180
-
181
- <ParametersTable {...ThreadPrimitiveMessagesProps} />
182
-
183
- ### MessageByIndex
184
-
185
- {ThreadPrimitiveDocs.MessageByIndex?.deprecated && (
186
- <Callout type="warn">
187
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.MessageByIndex.deprecated}
188
- </Callout>
189
- )}
190
-
191
- {ThreadPrimitiveDocs.MessageByIndex?.description}
192
-
193
- {ThreadPrimitiveDocs.MessageByIndex?.element && (
194
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.MessageByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
195
- )}
196
-
197
- <ParametersTable {...ThreadPrimitiveMessageByIndexProps} />
198
-
199
- ### Unstable_MessageById
200
-
201
- {ThreadPrimitiveDocs.Unstable_MessageById?.deprecated && (
202
- <Callout type="tip">
203
- <strong>Experimental.</strong> {ThreadPrimitiveDocs.Unstable_MessageById.deprecated}
204
- </Callout>
205
- )}
206
-
207
- {ThreadPrimitiveDocs.Unstable_MessageById?.description}
208
-
209
- {ThreadPrimitiveDocs.Unstable_MessageById?.element && (
210
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Unstable_MessageById?.element}>`}</code> element unless <code>asChild</code> is set.</p>
211
- )}
212
-
213
- ```tsx
214
- const messageIds = unstable_useThreadMessageIds();
215
- return messageIds.map((messageId) => (
216
- <ThreadPrimitive.Unstable_MessageById
217
- key={messageId}
218
- messageId={messageId}
219
- components={MESSAGE_COMPONENTS}
220
- />
221
- ));
222
- ```
223
-
224
- <ParametersTable {...ThreadPrimitiveUnstable_MessageByIdProps} />
225
-
226
- ### ScrollToBottom
227
-
228
- {ThreadPrimitiveDocs.ScrollToBottom?.deprecated && (
229
- <Callout type="warn">
230
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ScrollToBottom.deprecated}
231
- </Callout>
232
- )}
233
-
234
- {ThreadPrimitiveDocs.ScrollToBottom?.description}
235
-
236
- {ThreadPrimitiveDocs.ScrollToBottom?.element && (
237
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ScrollToBottom?.element}>`}</code> element unless <code>asChild</code> is set.</p>
238
- )}
239
-
240
- <ParametersTable {...ThreadPrimitiveScrollToBottomProps} />
241
-
242
- ### Suggestion
243
-
244
- {ThreadPrimitiveDocs.Suggestion?.deprecated && (
245
- <Callout type="warn">
246
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Suggestion.deprecated}
247
- </Callout>
248
- )}
249
-
250
- {ThreadPrimitiveDocs.Suggestion?.description}
251
-
252
- {ThreadPrimitiveDocs.Suggestion?.element && (
253
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Suggestion?.element}>`}</code> element unless <code>asChild</code> is set.</p>
254
- )}
255
-
256
- <ParametersTable {...ThreadPrimitiveSuggestionProps} />
257
-
258
- ### Suggestions
259
-
260
- {ThreadPrimitiveDocs.Suggestions?.deprecated && (
261
- <Callout type="warn">
262
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Suggestions.deprecated}
263
- </Callout>
264
- )}
265
-
266
- {ThreadPrimitiveDocs.Suggestions?.description}
267
-
268
- {ThreadPrimitiveDocs.Suggestions?.element && (
269
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Suggestions?.element}>`}</code> element unless <code>asChild</code> is set.</p>
270
- )}
271
-
272
- <ParametersTable {...ThreadPrimitiveSuggestionsProps} />
273
-
274
- ### SuggestionByIndex
275
-
276
- {ThreadPrimitiveDocs.SuggestionByIndex?.deprecated && (
277
- <Callout type="warn">
278
- <strong>Deprecated.</strong> {ThreadPrimitiveDocs.SuggestionByIndex.deprecated}
279
- </Callout>
280
- )}
281
-
282
- {ThreadPrimitiveDocs.SuggestionByIndex?.description}
283
-
284
- {ThreadPrimitiveDocs.SuggestionByIndex?.element && (
285
- <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.SuggestionByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
286
- )}
287
-
288
- <ParametersTable {...ThreadPrimitiveSuggestionByIndexProps} />
289
- {/* api-reference:end */}
@@ -1,20 +0,0 @@
1
- ---
2
- title: AssistantRuntime
3
- description: Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior.
4
- ---
5
-
6
- import { AssistantRuntime } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### AssistantRuntime
18
-
19
- <ParametersTable {...AssistantRuntime} />
20
- {/* api-reference:end */}
@@ -1,24 +0,0 @@
1
- ---
2
- title: AttachmentRuntime
3
- description: AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers.
4
- ---
5
-
6
- import { AttachmentRuntime, AttachmentState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### AttachmentRuntime
18
-
19
- <ParametersTable {...AttachmentRuntime} />
20
-
21
- ### AttachmentState
22
-
23
- <ParametersTable {...AttachmentState} />
24
- {/* api-reference:end */}
@@ -1,32 +0,0 @@
1
- ---
2
- title: ComposerRuntime
3
- description: ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and pending input.
4
- ---
5
-
6
- import { ComposerRuntime, ComposerState, EditComposerRuntime, EditComposerState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### ComposerRuntime
18
-
19
- <ParametersTable {...ComposerRuntime} />
20
-
21
- ### ComposerState
22
-
23
- <ParametersTable {...ComposerState} />
24
-
25
- ### EditComposerRuntime
26
-
27
- <ParametersTable {...EditComposerRuntime} />
28
-
29
- ### EditComposerState
30
-
31
- <ParametersTable {...EditComposerState} />
32
- {/* api-reference:end */}
@@ -1,43 +0,0 @@
1
- ---
2
- title: Runtime State API Reference
3
- description: Runtime state and actions exposed through useAui and useAuiState, covering AssistantRuntime, ThreadRuntime, ThreadListRuntime, ComposerRuntime, MessageRuntime, and attachment APIs for controlling assistant-ui chat.
4
- ---
5
-
6
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
7
- {/* The page list is generated from exported APIs; edit only the manual prose slot. */}
8
-
9
- {/* api-manual:start */}
10
- Runtime state is the typed control surface behind assistant-ui. These pages document the actions and state objects available through `useAui`, `useAuiState`, and scoped runtimes.
11
- {/* api-manual:end */}
12
-
13
- ## Pages
14
-
15
- <Cards>
16
- <Card title={"AssistantRuntime"} href={"/docs/api-reference/runtimes/assistant-runtime"}>
17
- {"Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior."}
18
- </Card>
19
- <Card title={"AttachmentRuntime"} href={"/docs/api-reference/runtimes/attachment-runtime"}>
20
- {"AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers."}
21
- </Card>
22
- <Card title={"ComposerRuntime"} href={"/docs/api-reference/runtimes/composer-runtime"}>
23
- {"ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and pending input."}
24
- </Card>
25
- <Card title={"MessagePartRuntime"} href={"/docs/api-reference/runtimes/message-part-runtime"}>
26
- {"MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom message content."}
27
- </Card>
28
- <Card title={"MessageRuntime"} href={"/docs/api-reference/runtimes/message-runtime"}>
29
- {"MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages."}
30
- </Card>
31
- <Card title={"QueueItemState"} href={"/docs/api-reference/runtimes/queue-state"}>
32
- {"State shape for queued assistant-ui thread operations and pending runtime work."}
33
- </Card>
34
- <Card title={"ThreadListItemRuntime"} href={"/docs/api-reference/runtimes/thread-list-item-runtime"}>
35
- {"ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conversations."}
36
- </Card>
37
- <Card title={"ThreadListRuntime"} href={"/docs/api-reference/runtimes/thread-list-runtime"}>
38
- {"ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation."}
39
- </Card>
40
- <Card title={"ThreadRuntime"} href={"/docs/api-reference/runtimes/thread-runtime"}>
41
- {"ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the full thread lifecycle."}
42
- </Card>
43
- </Cards>
@@ -1,43 +0,0 @@
1
- ---
2
- title: MessagePartRuntime
3
- description: MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom message content.
4
- ---
5
-
6
- import { EnrichedPartState, MessagePartRuntime, MessagePartState, PartState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### EnrichedPartState
18
-
19
- Enriched part state passed to children render functions.
20
-
21
- For tool-call parts, adds `toolUI`, `addResult`, and `resume`.
22
- For data parts, adds `dataRendererUI`.
23
-
24
- The render function is also invoked once with a synthetic empty text part
25
- (`{ type: "text", text: "", status: { type: "running" } }`) when the
26
- assistant message has no parts yet but is in the running state, so a
27
- loading indicator can render. Differentiate this from a real empty text
28
- via `part.status?.type === "running" && part.text === ""`.
29
-
30
- <ParametersTable {...EnrichedPartState} />
31
-
32
- ### MessagePartRuntime
33
-
34
- <ParametersTable {...MessagePartRuntime} />
35
-
36
- ### MessagePartState
37
-
38
- <ParametersTable {...MessagePartState} />
39
-
40
- ### PartState
41
-
42
- <ParametersTable {...PartState} />
43
- {/* api-reference:end */}
@@ -1,24 +0,0 @@
1
- ---
2
- title: MessageRuntime
3
- description: MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages.
4
- ---
5
-
6
- import { MessageRuntime, MessageState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### MessageRuntime
18
-
19
- <ParametersTable {...MessageRuntime} />
20
-
21
- ### MessageState
22
-
23
- <ParametersTable {...MessageState} />
24
- {/* api-reference:end */}
@@ -1,20 +0,0 @@
1
- ---
2
- title: QueueItemState
3
- description: State shape for queued assistant-ui thread operations and pending runtime work.
4
- ---
5
-
6
- import { QueueItemState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### QueueItemState
18
-
19
- <ParametersTable {...QueueItemState} />
20
- {/* api-reference:end */}
@@ -1,24 +0,0 @@
1
- ---
2
- title: ThreadListItemRuntime
3
- description: ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conversations.
4
- ---
5
-
6
- import { ThreadListItemRuntime, ThreadListItemState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### ThreadListItemRuntime
18
-
19
- <ParametersTable {...ThreadListItemRuntime} />
20
-
21
- ### ThreadListItemState
22
-
23
- <ParametersTable {...ThreadListItemState} />
24
- {/* api-reference:end */}
@@ -1,24 +0,0 @@
1
- ---
2
- title: ThreadListRuntime
3
- description: ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation.
4
- ---
5
-
6
- import { ThreadListRuntime, ThreadListState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### ThreadListRuntime
18
-
19
- <ParametersTable {...ThreadListRuntime} />
20
-
21
- ### ThreadListState
22
-
23
- <ParametersTable {...ThreadListState} />
24
- {/* api-reference:end */}
@@ -1,36 +0,0 @@
1
- ---
2
- title: ThreadRuntime
3
- description: ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the full thread lifecycle.
4
- ---
5
-
6
- import { ThreadComposerRuntime, ThreadComposerState, ThreadRuntime, ThreadState, ThreadViewportState } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-reference:start */}
12
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
- {/* Do not edit this block manually. */}
14
-
15
- ## API Reference
16
-
17
- ### ThreadComposerRuntime
18
-
19
- <ParametersTable {...ThreadComposerRuntime} />
20
-
21
- ### ThreadComposerState
22
-
23
- <ParametersTable {...ThreadComposerState} />
24
-
25
- ### ThreadRuntime
26
-
27
- <ParametersTable {...ThreadRuntime} />
28
-
29
- ### ThreadState
30
-
31
- <ParametersTable {...ThreadState} />
32
-
33
- ### ThreadViewportState
34
-
35
- <ParametersTable {...ThreadViewportState} />
36
- {/* api-reference:end */}
@@ -1,85 +0,0 @@
1
- ---
2
- title: Component Tools
3
- description: Register assistant tools from mounted React components, scoped to the lifetime of part of the UI tree.
4
- ---
5
-
6
- import { useAssistantTool } from "@/generated/typeDocs";
7
-
8
- {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
- {/* Do not edit manually. */}
10
-
11
- {/* api-manual:start */}
12
- <Callout type="warn">
13
- `makeAssistantTool` and `useAssistantTool` are **deprecated** compatibility
14
- APIs, documented here for reference only. New code should define a toolkit —
15
- see [Defining Tools](/docs/tools/defining-tools) and [Migrating Tools to
16
- Toolkits](/docs/migrations/toolkit-tools).
17
- </Callout>
18
- {/* api-manual:end */}
19
-
20
- {/* api-reference:start */}
21
- {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
22
- {/* Do not edit this block manually. */}
23
-
24
- ## API Reference
25
-
26
- ### makeAssistantTool
27
-
28
- <Callout type="warn">
29
- <strong>Deprecated.</strong> Use a toolkit with `Tools({ toolkit })` and register it via
30
- `useAui({ tools: Tools({ toolkit }) })` instead. See
31
- https://assistant-ui.com/docs/migrations/toolkit-tools.
32
- </Callout>
33
-
34
- Creates a React component that registers an assistant tool when rendered.
35
-
36
- Use this when exporting reusable tool modules that can be included in JSX
37
- rather than calling [useAssistantTool](/docs/api-reference/tools/component-tools#useassistanttool) directly.
38
-
39
- ```ts
40
- type AssistantToolProps = CoreAssistantToolProps<TArgs, TResult> & {
41
- /** Component used to render calls to this tool in assistant messages. */
42
- render?: ToolCallMessagePartComponent<TArgs, TResult> | undefined;
43
- /** Lightweight text rendered while a tool call is running or complete. */
44
- renderText?: ToolCallText<TArgs, TResult> | undefined;
45
- };
46
-
47
- const makeAssistantTool: <TArgs extends Record<string, unknown>, TResult>(tool: AssistantToolProps<TArgs, TResult>) => AssistantTool;
48
- ```
49
-
50
- ### useAssistantTool
51
-
52
- <Callout type="warn">
53
- <strong>Deprecated.</strong> Use a toolkit with `Tools({ toolkit })` and register it via
54
- `useAui({ tools: Tools({ toolkit }) })` instead. See
55
- https://assistant-ui.com/docs/migrations/toolkit-tools.
56
- </Callout>
57
-
58
- Registers a tool with the assistant model context while the component is
59
- mounted.
60
-
61
- If `render` is provided, it is also installed as the renderer for matching
62
- tool-call message parts. The registration is removed automatically when the
63
- component unmounts or the tool definition changes.
64
-
65
- Pass a referentially stable tool object, such as one declared at module
66
- scope or memoized with `useMemo`, to avoid re-registering on every render.
67
-
68
- ```tsx
69
- const weatherTool = {
70
- toolName: "get_weather",
71
- type: "frontend",
72
- description: "Get the weather for a city.",
73
- parameters: weatherSchema,
74
- execute: async ({ city }: { city: string }) => fetchWeather(city),
75
- render: WeatherToolUI,
76
- } satisfies AssistantToolProps<{ city: string }, Weather>;
77
-
78
- function WeatherToolRegistration() {
79
- useAssistantTool(weatherTool);
80
- return null;
81
- }
82
- ```
83
-
84
- <ParametersTable {...useAssistantTool} />
85
- {/* api-reference:end */}