@assistant-ui/mcp-docs-server 0.2.3 → 0.3.1

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 (452) 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 +91 -0
  9. package/dist/proxy.js.map +1 -0
  10. package/package.json +8 -12
  11. package/src/index.ts +3 -115
  12. package/src/proxy.test.ts +385 -0
  13. package/src/proxy.ts +126 -0
  14. package/.docs/organized/code-examples/waterfall.md +0 -807
  15. package/.docs/organized/code-examples/with-a2a.md +0 -675
  16. package/.docs/organized/code-examples/with-ag-ui.md +0 -553
  17. package/.docs/organized/code-examples/with-ai-sdk-v7.md +0 -466
  18. package/.docs/organized/code-examples/with-artifacts.md +0 -815
  19. package/.docs/organized/code-examples/with-assistant-transport.md +0 -576
  20. package/.docs/organized/code-examples/with-browser-extension.md +0 -371
  21. package/.docs/organized/code-examples/with-chain-of-thought.md +0 -962
  22. package/.docs/organized/code-examples/with-cloud-standalone.md +0 -681
  23. package/.docs/organized/code-examples/with-cloud.md +0 -439
  24. package/.docs/organized/code-examples/with-custom-thread-list.md +0 -569
  25. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +0 -527
  26. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +0 -697
  27. package/.docs/organized/code-examples/with-eve.md +0 -405
  28. package/.docs/organized/code-examples/with-expo.md +0 -2246
  29. package/.docs/organized/code-examples/with-external-store.md +0 -421
  30. package/.docs/organized/code-examples/with-ffmpeg.md +0 -829
  31. package/.docs/organized/code-examples/with-generative-ui.md +0 -1810
  32. package/.docs/organized/code-examples/with-google-adk.md +0 -368
  33. package/.docs/organized/code-examples/with-heat-graph.md +0 -304
  34. package/.docs/organized/code-examples/with-image-generation.md +0 -463
  35. package/.docs/organized/code-examples/with-interactables.md +0 -733
  36. package/.docs/organized/code-examples/with-langchain.md +0 -446
  37. package/.docs/organized/code-examples/with-langgraph.md +0 -855
  38. package/.docs/organized/code-examples/with-livekit.md +0 -643
  39. package/.docs/organized/code-examples/with-mcp.md +0 -782
  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 -450
  43. package/.docs/organized/code-examples/with-pi.md +0 -2084
  44. package/.docs/organized/code-examples/with-react-hook-form.md +0 -727
  45. package/.docs/organized/code-examples/with-react-ink-web.md +0 -740
  46. package/.docs/organized/code-examples/with-react-ink.md +0 -473
  47. package/.docs/organized/code-examples/with-react-router.md +0 -936
  48. package/.docs/organized/code-examples/with-resumable-stream.md +0 -668
  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 -812
  53. package/.docs/organized/code-examples/with-tap-runtime.md +0 -813
  54. package/.docs/organized/code-examples/with-virtualized-thread.md +0 -681
  55. package/.docs/organized/code-examples/with-vue.md +0 -408
  56. package/.docs/raw/docs/(getting-started)/architecture.mdx +0 -146
  57. package/.docs/raw/docs/(getting-started)/base-ui.mdx +0 -39
  58. package/.docs/raw/docs/(getting-started)/cli.mdx +0 -542
  59. package/.docs/raw/docs/(getting-started)/devtools.mdx +0 -79
  60. package/.docs/raw/docs/(getting-started)/index.mdx +0 -23
  61. package/.docs/raw/docs/(getting-started)/installation.mdx +0 -483
  62. package/.docs/raw/docs/(getting-started)/llm.mdx +0 -211
  63. package/.docs/raw/docs/(getting-started)/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 -26
  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 -57
  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/ai-sdk.mdx +0 -200
  94. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +0 -24
  95. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +0 -118
  96. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +0 -28
  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 -637
  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 -152
  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 -604
  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 -411
  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 -215
  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 -237
  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.mdx +0 -283
  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 -976
  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 -267
  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 -731
  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 -363
  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 -1020
  289. package/.docs/raw/docs/tools/user-managed-mcp.mdx +0 -428
  290. package/.docs/raw/docs/ui/assistant-modal.mdx +0 -166
  291. package/.docs/raw/docs/ui/assistant-sidebar.mdx +0 -89
  292. package/.docs/raw/docs/ui/attachment.mdx +0 -279
  293. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +0 -247
  294. package/.docs/raw/docs/ui/context-display.mdx +0 -148
  295. package/.docs/raw/docs/ui/directive-text.mdx +0 -114
  296. package/.docs/raw/docs/ui/file.mdx +0 -159
  297. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +0 -82
  298. package/.docs/raw/docs/ui/image.mdx +0 -102
  299. package/.docs/raw/docs/ui/markdown.mdx +0 -103
  300. package/.docs/raw/docs/ui/mcp-config.mdx +0 -107
  301. package/.docs/raw/docs/ui/mermaid.mdx +0 -92
  302. package/.docs/raw/docs/ui/message-timing.mdx +0 -93
  303. package/.docs/raw/docs/ui/model-selector.mdx +0 -455
  304. package/.docs/raw/docs/ui/part-grouping.mdx +0 -614
  305. package/.docs/raw/docs/ui/quote.mdx +0 -211
  306. package/.docs/raw/docs/ui/reasoning.mdx +0 -214
  307. package/.docs/raw/docs/ui/scrollbar.mdx +0 -77
  308. package/.docs/raw/docs/ui/sources.mdx +0 -186
  309. package/.docs/raw/docs/ui/streamdown.mdx +0 -392
  310. package/.docs/raw/docs/ui/syntax-highlighting.mdx +0 -205
  311. package/.docs/raw/docs/ui/thread-list.mdx +0 -411
  312. package/.docs/raw/docs/ui/thread.mdx +0 -559
  313. package/.docs/raw/docs/ui/tool-fallback.mdx +0 -141
  314. package/.docs/raw/docs/ui/tool-group.mdx +0 -240
  315. package/.docs/raw/docs/ui/voice.mdx +0 -173
  316. package/.docs/raw/docs/utilities/heat-graph.mdx +0 -237
  317. package/.docs/raw/docs/utilities/react-o11y.mdx +0 -362
  318. package/.docs/raw/docs/utilities/tw-shimmer.mdx +0 -212
  319. package/dist/constants.d.ts +0 -14
  320. package/dist/constants.d.ts.map +0 -1
  321. package/dist/constants.js +0 -19
  322. package/dist/constants.js.map +0 -1
  323. package/dist/prepare-docs/code-examples.d.ts +0 -5
  324. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  325. package/dist/prepare-docs/code-examples.js +0 -117
  326. package/dist/prepare-docs/code-examples.js.map +0 -1
  327. package/dist/prepare-docs/copy-raw.d.ts +0 -5
  328. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  329. package/dist/prepare-docs/copy-raw.js +0 -49
  330. package/dist/prepare-docs/copy-raw.js.map +0 -1
  331. package/dist/prepare-docs/prepare.d.ts +0 -1
  332. package/dist/prepare-docs/prepare.js +0 -22
  333. package/dist/prepare-docs/prepare.js.map +0 -1
  334. package/dist/prompts/xulux-playground.d.ts +0 -12
  335. package/dist/prompts/xulux-playground.d.ts.map +0 -1
  336. package/dist/prompts/xulux-playground.js +0 -33
  337. package/dist/prompts/xulux-playground.js.map +0 -1
  338. package/dist/tools/docs.d.ts +0 -22
  339. package/dist/tools/docs.d.ts.map +0 -1
  340. package/dist/tools/docs.js +0 -177
  341. package/dist/tools/docs.js.map +0 -1
  342. package/dist/tools/examples.d.ts +0 -24
  343. package/dist/tools/examples.d.ts.map +0 -1
  344. package/dist/tools/examples.js +0 -87
  345. package/dist/tools/examples.js.map +0 -1
  346. package/dist/tools/resources.d.ts +0 -6
  347. package/dist/tools/resources.d.ts.map +0 -1
  348. package/dist/tools/resources.js +0 -75
  349. package/dist/tools/resources.js.map +0 -1
  350. package/dist/tools/search.d.ts +0 -24
  351. package/dist/tools/search.d.ts.map +0 -1
  352. package/dist/tools/search.js +0 -39
  353. package/dist/tools/search.js.map +0 -1
  354. package/dist/tools/tests/mcp-test-client.d.ts +0 -15
  355. package/dist/tools/tests/mcp-test-client.d.ts.map +0 -1
  356. package/dist/tools/tests/mcp-test-client.js +0 -68
  357. package/dist/tools/tests/mcp-test-client.js.map +0 -1
  358. package/dist/tools/tests/test-setup.d.ts +0 -7
  359. package/dist/tools/tests/test-setup.d.ts.map +0 -1
  360. package/dist/tools/tests/test-setup.js +0 -36
  361. package/dist/tools/tests/test-setup.js.map +0 -1
  362. package/dist/tools/xulux-templates.d.ts +0 -58
  363. package/dist/tools/xulux-templates.d.ts.map +0 -1
  364. package/dist/tools/xulux-templates.js +0 -84
  365. package/dist/tools/xulux-templates.js.map +0 -1
  366. package/dist/utils/cache.d.ts +0 -5
  367. package/dist/utils/cache.d.ts.map +0 -1
  368. package/dist/utils/cache.js +0 -18
  369. package/dist/utils/cache.js.map +0 -1
  370. package/dist/utils/logger.d.ts +0 -10
  371. package/dist/utils/logger.d.ts.map +0 -1
  372. package/dist/utils/logger.js +0 -20
  373. package/dist/utils/logger.js.map +0 -1
  374. package/dist/utils/mcp-format.d.ts +0 -11
  375. package/dist/utils/mcp-format.d.ts.map +0 -1
  376. package/dist/utils/mcp-format.js +0 -14
  377. package/dist/utils/mcp-format.js.map +0 -1
  378. package/dist/utils/mdx.d.ts +0 -12
  379. package/dist/utils/mdx.d.ts.map +0 -1
  380. package/dist/utils/mdx.js +0 -45
  381. package/dist/utils/mdx.js.map +0 -1
  382. package/dist/utils/paths.d.ts +0 -12
  383. package/dist/utils/paths.d.ts.map +0 -1
  384. package/dist/utils/paths.js +0 -93
  385. package/dist/utils/paths.js.map +0 -1
  386. package/dist/utils/search.d.ts +0 -10
  387. package/dist/utils/search.d.ts.map +0 -1
  388. package/dist/utils/search.js +0 -97
  389. package/dist/utils/search.js.map +0 -1
  390. package/dist/utils/security.d.ts +0 -5
  391. package/dist/utils/security.d.ts.map +0 -1
  392. package/dist/utils/security.js +0 -22
  393. package/dist/utils/security.js.map +0 -1
  394. package/dist/xulux/catalog-client.d.ts +0 -14
  395. package/dist/xulux/catalog-client.d.ts.map +0 -1
  396. package/dist/xulux/catalog-client.js +0 -112
  397. package/dist/xulux/catalog-client.js.map +0 -1
  398. package/dist/xulux/fallback-catalog.d.ts +0 -7
  399. package/dist/xulux/fallback-catalog.d.ts.map +0 -1
  400. package/dist/xulux/fallback-catalog.js +0 -47
  401. package/dist/xulux/fallback-catalog.js.map +0 -1
  402. package/dist/xulux/fetch-sandbox.d.ts +0 -5
  403. package/dist/xulux/fetch-sandbox.d.ts.map +0 -1
  404. package/dist/xulux/fetch-sandbox.js +0 -40
  405. package/dist/xulux/fetch-sandbox.js.map +0 -1
  406. package/dist/xulux/template-service.d.ts +0 -84
  407. package/dist/xulux/template-service.d.ts.map +0 -1
  408. package/dist/xulux/template-service.js +0 -223
  409. package/dist/xulux/template-service.js.map +0 -1
  410. package/dist/xulux/types.d.ts +0 -55
  411. package/dist/xulux/types.d.ts.map +0 -1
  412. package/dist/xulux/types.js +0 -6
  413. package/dist/xulux/types.js.map +0 -1
  414. package/src/constants.ts +0 -24
  415. package/src/prepare-docs/code-examples.ts +0 -158
  416. package/src/prepare-docs/copy-raw.ts +0 -50
  417. package/src/prepare-docs/prepare.ts +0 -24
  418. package/src/prompts/xulux-playground.ts +0 -36
  419. package/src/tools/docs.ts +0 -255
  420. package/src/tools/examples.ts +0 -114
  421. package/src/tools/resources.ts +0 -111
  422. package/src/tools/search.ts +0 -46
  423. package/src/tools/tests/completions.test.ts +0 -60
  424. package/src/tools/tests/directory-size-cap.test.ts +0 -50
  425. package/src/tools/tests/docs.test.ts +0 -147
  426. package/src/tools/tests/examples.test.ts +0 -94
  427. package/src/tools/tests/integration.test.ts +0 -45
  428. package/src/tools/tests/json-parsing.test.ts +0 -23
  429. package/src/tools/tests/listings-cache.test.ts +0 -19
  430. package/src/tools/tests/mcp-protocol.test.ts +0 -216
  431. package/src/tools/tests/mcp-test-client.ts +0 -111
  432. package/src/tools/tests/path-traversal.test.ts +0 -84
  433. package/src/tools/tests/resources.test.ts +0 -133
  434. package/src/tools/tests/search.test.ts +0 -37
  435. package/src/tools/tests/test-setup.ts +0 -50
  436. package/src/tools/tests/xulux-templates.test.ts +0 -325
  437. package/src/tools/xulux-templates.ts +0 -141
  438. package/src/utils/cache.ts +0 -20
  439. package/src/utils/logger.ts +0 -20
  440. package/src/utils/mcp-format.ts +0 -14
  441. package/src/utils/mdx.ts +0 -59
  442. package/src/utils/paths.ts +0 -139
  443. package/src/utils/search.ts +0 -131
  444. package/src/utils/security.ts +0 -52
  445. package/src/utils/tests/cache.test.ts +0 -51
  446. package/src/utils/tests/mcp-format.test.ts +0 -22
  447. package/src/utils/tests/security.test.ts +0 -119
  448. package/src/xulux/catalog-client.ts +0 -150
  449. package/src/xulux/fallback-catalog.ts +0 -63
  450. package/src/xulux/fetch-sandbox.ts +0 -56
  451. package/src/xulux/template-service.ts +0 -406
  452. package/src/xulux/types.ts +0 -64
@@ -1,962 +0,0 @@
1
- # Example: with-chain-of-thought
2
-
3
- ## app/api/chat/route.ts
4
-
5
- ```typescript
6
- import { createOpenAI } from "@ai-sdk/openai";
7
- import {
8
- streamText,
9
- convertToModelMessages,
10
- tool,
11
- stepCountIs,
12
- zodSchema,
13
- createUIMessageStream,
14
- JsonToSseTransformStream,
15
- } from "ai";
16
- import type { UIMessage, UIMessageStreamWriter } from "ai";
17
- import { AISDKToolkit } from "@assistant-ui/ai-sdk";
18
- import { z } from "zod";
19
- import toolkit from "../../toolkit";
20
-
21
- export const maxDuration = 30;
22
-
23
- const aiToolkit = new AISDKToolkit({ toolkit });
24
-
25
- type SearchResult = { id: string; url: string; title: string };
26
-
27
- const searchSources = (query: string): SearchResult[] => {
28
- const q = query.toLowerCase();
29
- if (q.includes("fibonacci")) {
30
- return [
31
- {
32
- id: "src-fib-1",
33
- url: "https://en.wikipedia.org/wiki/Fibonacci_number",
34
- title: "Fibonacci number (Wikipedia)",
35
- },
36
- {
37
- id: "src-fib-2",
38
- url: "https://oeis.org/A000045",
39
- title: "OEIS A000045: Fibonacci numbers",
40
- },
41
- ];
42
- }
43
- if (
44
- q.includes("renewable") ||
45
- q.includes("energy") ||
46
- q.includes("climate")
47
- ) {
48
- return [
49
- {
50
- id: "src-iea",
51
- url: "https://www.iea.org/reports/renewables-2024",
52
- title: "IEA Renewables 2024",
53
- },
54
- {
55
- id: "src-irena",
56
- url: "https://www.irena.org/Publications",
57
- title: "IRENA Publications",
58
- },
59
- ];
60
- }
61
- return [
62
- {
63
- id: "src-wiki",
64
- url: `https://en.wikipedia.org/wiki/Special:Search?search=${encodeURIComponent(query)}`,
65
- title: "Wikipedia search results",
66
- },
67
- {
68
- id: "src-web",
69
- url: `https://duckduckgo.com/?q=${encodeURIComponent(query)}`,
70
- title: `Web results for: ${query}`,
71
- },
72
- ];
73
- };
74
-
75
- export async function POST(req: Request) {
76
- const {
77
- messages,
78
- tools,
79
- }: { messages: UIMessage[]; tools: Record<string, any> } = await req.json();
80
-
81
- const uiStream = createUIMessageStream({
82
- execute: async ({ writer }) => {
83
- if (!process.env.OPENAI_API_KEY) {
84
- await streamFallback(writer, messages);
85
- return;
86
- }
87
- await streamModel(writer, messages, tools);
88
- },
89
- });
90
-
91
- return new Response(
92
- uiStream
93
- .pipeThrough(new JsonToSseTransformStream())
94
- .pipeThrough(new TextEncoderStream()),
95
- {
96
- headers: {
97
- "Content-Type": "text/event-stream",
98
- "Cache-Control": "no-cache",
99
- Connection: "keep-alive",
100
- },
101
- },
102
- );
103
- }
104
-
105
- async function streamModel(
106
- writer: UIMessageStreamWriter,
107
- messages: UIMessage[],
108
- frontendToolDefs: Record<string, any>,
109
- ) {
110
- const toolNameByCall = new Map<string, string>();
111
- const openai = createOpenAI({
112
- apiKey: process.env.OPENAI_API_KEY!,
113
- ...(process.env.OPENAI_BASE_URL && {
114
- baseURL: process.env.OPENAI_BASE_URL,
115
- }),
116
- });
117
-
118
- const toolkitTools = await aiToolkit.tools({ frontend: frontendToolDefs });
119
-
120
- const result = streamText({
121
- // Reasoning model so the chain-of-thought group has real content.
122
- model: openai("gpt-5.6-luna"),
123
- messages: await convertToModelMessages(messages),
124
- stopWhen: stepCountIs(10),
125
- tools: {
126
- ...toolkitTools,
127
- get_current_weather: tool({
128
- description: "Get the current weather for a city",
129
- inputSchema: zodSchema(z.object({ city: z.string() })),
130
- execute: async ({ city }) => `The weather in ${city} is sunny, 72°F`,
131
- }),
132
- search_web: tool({
133
- description:
134
- "Search the web for citations on a topic. Returns a list of source URLs and titles the assistant should consult.",
135
- inputSchema: zodSchema(z.object({ query: z.string() })),
136
- execute: async ({ query }) => ({ sources: searchSources(query) }),
137
- }),
138
- },
139
- providerOptions: {
140
- openai: {
141
- reasoningEffort: "high",
142
- reasoningSummary: "auto",
143
- },
144
- },
145
- });
146
-
147
- // Forward model chunks, then synthesize `source-url` parts from each
148
- // `search_web` tool output so the UI renders them as `source` parts. OpenAI
149
- // does not natively emit `source-url` chunks without web search, so the route
150
- // produces them deterministically from the tool result.
151
- for await (const chunk of result.toUIMessageStream({ sendReasoning: true })) {
152
- writer.write(chunk);
153
-
154
- if (chunk.type === "tool-input-available") {
155
- toolNameByCall.set(chunk.toolCallId, chunk.toolName);
156
- }
157
- if (
158
- chunk.type === "tool-output-available" &&
159
- toolNameByCall.get(chunk.toolCallId) === "search_web"
160
- ) {
161
- const output = chunk.output as { sources?: SearchResult[] };
162
- for (const source of output.sources ?? []) {
163
- writer.write({
164
- type: "source-url",
165
- sourceId: `${source.id}-${crypto.randomUUID()}`,
166
- url: source.url,
167
- title: source.title,
168
- });
169
- }
170
- }
171
- }
172
- }
173
-
174
- async function streamFallback(
175
- writer: UIMessageStreamWriter,
176
- messages: UIMessage[],
177
- ) {
178
- const lastUserText =
179
- messages
180
- .filter((m) => m.role === "user")
181
- .at(-1)
182
- ?.parts.flatMap((p) => (p.type === "text" ? [p.text] : []))
183
- .join(" ") ?? "your question";
184
-
185
- const messageId = `msg-${crypto.randomUUID()}`;
186
- const reasoningId = `r-${crypto.randomUUID()}`;
187
- const textId = `t-${crypto.randomUUID()}`;
188
- const toolCallId = `call-${crypto.randomUUID()}`;
189
- const sources = searchSources(lastUserText);
190
-
191
- writer.write({ type: "start", messageId });
192
- writer.write({ type: "start-step" });
193
-
194
- writer.write({ type: "reasoning-start", id: reasoningId });
195
- const reasoning =
196
- "OPENAI_API_KEY is not set, so this response is generated deterministically by the route. " +
197
- "A real run emits the same chunk shapes from the model: a reasoning step, " +
198
- "a search_web tool call, source-url parts derived from the tool output, " +
199
- "and a final answer that summarises the sources.";
200
- for (const word of reasoning.match(/\S+\s*|\s+/g) ?? [reasoning]) {
201
- writer.write({ type: "reasoning-delta", id: reasoningId, delta: word });
202
- await sleep(15);
203
- }
204
- writer.write({ type: "reasoning-end", id: reasoningId });
205
-
206
- writer.write({
207
- type: "tool-input-available",
208
- toolCallId,
209
- toolName: "search_web",
210
- input: { query: lastUserText },
211
- });
212
- await sleep(150);
213
- writer.write({
214
- type: "tool-output-available",
215
- toolCallId,
216
- output: { sources },
217
- });
218
-
219
- for (const source of sources) {
220
- writer.write({
221
- type: "source-url",
222
- sourceId: `${source.id}-${crypto.randomUUID()}`,
223
- url: source.url,
224
- title: source.title,
225
- });
226
- }
227
-
228
- writer.write({ type: "text-start", id: textId });
229
- const answer =
230
- `\n\nMock answer for: "${lastUserText}". ` +
231
- "The badges above are structured `source` message parts emitted as " +
232
- "`source-url` chunks, not URLs scraped from text. Set `OPENAI_API_KEY` " +
233
- "to switch to a real model run.";
234
- for (const word of answer.match(/\S+\s*|\s+/g) ?? [answer]) {
235
- writer.write({ type: "text-delta", id: textId, delta: word });
236
- await sleep(15);
237
- }
238
- writer.write({ type: "text-end", id: textId });
239
-
240
- writer.write({ type: "finish-step" });
241
- writer.write({ type: "finish" });
242
- }
243
-
244
- const sleep = (ms: number) =>
245
- new Promise<void>((resolve) => setTimeout(resolve, ms));
246
-
247
- ```
248
-
249
- ## app/globals.css
250
-
251
- ```css
252
- @import "tailwindcss";
253
- @import "tw-animate-css";
254
-
255
- @source "../../../packages/ui/src";
256
-
257
- @custom-variant dark (&:is(.dark *));
258
-
259
- @theme inline {
260
- --radius-sm: calc(var(--radius) - 4px);
261
- --radius-md: calc(var(--radius) - 2px);
262
- --radius-lg: var(--radius);
263
- --radius-xl: calc(var(--radius) + 4px);
264
- --color-background: var(--background);
265
- --color-foreground: var(--foreground);
266
- --color-card: var(--card);
267
- --color-card-foreground: var(--card-foreground);
268
- --color-popover: var(--popover);
269
- --color-popover-foreground: var(--popover-foreground);
270
- --color-primary: var(--primary);
271
- --color-primary-foreground: var(--primary-foreground);
272
- --color-secondary: var(--secondary);
273
- --color-secondary-foreground: var(--secondary-foreground);
274
- --color-muted: var(--muted);
275
- --color-muted-foreground: var(--muted-foreground);
276
- --color-accent: var(--accent);
277
- --color-accent-foreground: var(--accent-foreground);
278
- --color-destructive: var(--destructive);
279
- --color-border: var(--border);
280
- --color-input: var(--input);
281
- --color-ring: var(--ring);
282
- --color-chart-1: var(--chart-1);
283
- --color-chart-2: var(--chart-2);
284
- --color-chart-3: var(--chart-3);
285
- --color-chart-4: var(--chart-4);
286
- --color-chart-5: var(--chart-5);
287
- --color-sidebar: var(--sidebar);
288
- --color-sidebar-foreground: var(--sidebar-foreground);
289
- --color-sidebar-primary: var(--sidebar-primary);
290
- --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
291
- --color-sidebar-accent: var(--sidebar-accent);
292
- --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
293
- --color-sidebar-border: var(--sidebar-border);
294
- --color-sidebar-ring: var(--sidebar-ring);
295
- }
296
-
297
- :root {
298
- --radius: 0.625rem;
299
- --background: oklch(1 0 0);
300
- --foreground: oklch(0.141 0.005 285.823);
301
- --card: oklch(1 0 0);
302
- --card-foreground: oklch(0.141 0.005 285.823);
303
- --popover: oklch(1 0 0);
304
- --popover-foreground: oklch(0.141 0.005 285.823);
305
- --primary: oklch(0.21 0.006 285.885);
306
- --primary-foreground: oklch(0.985 0 0);
307
- --secondary: oklch(0.967 0.001 286.375);
308
- --secondary-foreground: oklch(0.21 0.006 285.885);
309
- --muted: oklch(0.967 0.001 286.375);
310
- --muted-foreground: oklch(0.552 0.016 285.938);
311
- --accent: oklch(0.967 0.001 286.375);
312
- --accent-foreground: oklch(0.21 0.006 285.885);
313
- --destructive: oklch(0.577 0.245 27.325);
314
- --border: oklch(0.92 0.004 286.32);
315
- --input: oklch(0.92 0.004 286.32);
316
- --ring: oklch(0.705 0.015 286.067);
317
- --chart-1: oklch(0.646 0.222 41.116);
318
- --chart-2: oklch(0.6 0.118 184.704);
319
- --chart-3: oklch(0.398 0.07 227.392);
320
- --chart-4: oklch(0.828 0.189 84.429);
321
- --chart-5: oklch(0.769 0.188 70.08);
322
- --sidebar: oklch(0.985 0 0);
323
- --sidebar-foreground: oklch(0.141 0.005 285.823);
324
- --sidebar-primary: oklch(0.21 0.006 285.885);
325
- --sidebar-primary-foreground: oklch(0.985 0 0);
326
- --sidebar-accent: oklch(0.967 0.001 286.375);
327
- --sidebar-accent-foreground: oklch(0.21 0.006 285.885);
328
- --sidebar-border: oklch(0.92 0.004 286.32);
329
- --sidebar-ring: oklch(0.705 0.015 286.067);
330
- }
331
-
332
- .dark {
333
- --background: oklch(0.141 0.005 285.823);
334
- --foreground: oklch(0.985 0 0);
335
- --card: oklch(0.21 0.006 285.885);
336
- --card-foreground: oklch(0.985 0 0);
337
- --popover: oklch(0.21 0.006 285.885);
338
- --popover-foreground: oklch(0.985 0 0);
339
- --primary: oklch(0.92 0.004 286.32);
340
- --primary-foreground: oklch(0.21 0.006 285.885);
341
- --secondary: oklch(0.274 0.006 286.033);
342
- --secondary-foreground: oklch(0.985 0 0);
343
- --muted: oklch(0.274 0.006 286.033);
344
- --muted-foreground: oklch(0.705 0.015 286.067);
345
- --accent: oklch(0.274 0.006 286.033);
346
- --accent-foreground: oklch(0.985 0 0);
347
- --destructive: oklch(0.704 0.191 22.216);
348
- --border: oklch(1 0 0 / 10%);
349
- --input: oklch(1 0 0 / 15%);
350
- --ring: oklch(0.552 0.016 285.938);
351
- --chart-1: oklch(0.488 0.243 264.376);
352
- --chart-2: oklch(0.696 0.17 162.48);
353
- --chart-3: oklch(0.769 0.188 70.08);
354
- --chart-4: oklch(0.627 0.265 303.9);
355
- --chart-5: oklch(0.645 0.246 16.439);
356
- --sidebar: oklch(0.21 0.006 285.885);
357
- --sidebar-foreground: oklch(0.985 0 0);
358
- --sidebar-primary: oklch(0.488 0.243 264.376);
359
- --sidebar-primary-foreground: oklch(0.985 0 0);
360
- --sidebar-accent: oklch(0.274 0.006 286.033);
361
- --sidebar-accent-foreground: oklch(0.985 0 0);
362
- --sidebar-border: oklch(1 0 0 / 10%);
363
- --sidebar-ring: oklch(0.552 0.016 285.938);
364
- }
365
-
366
- @layer base {
367
- * {
368
- @apply border-border outline-ring/50;
369
- }
370
- body {
371
- @apply bg-background text-foreground;
372
- }
373
- }
374
-
375
- ```
376
-
377
- ## app/layout.tsx
378
-
379
- ```tsx
380
- import type { Metadata } from "next";
381
- import "./globals.css";
382
-
383
- export const metadata: Metadata = {
384
- title: "Chain of Thought Example",
385
- description:
386
- "Reasoning, tool calls, and source citations rendered as grouped message parts.",
387
- };
388
-
389
- export default function RootLayout({
390
- children,
391
- }: Readonly<{
392
- children: React.ReactNode;
393
- }>) {
394
- return (
395
- <html lang="en">
396
- <body className="h-dvh">{children}</body>
397
- </html>
398
- );
399
- }
400
-
401
- ```
402
-
403
- ## app/MyThread.tsx
404
-
405
- ```tsx
406
- "use client";
407
-
408
- import { type FC, type PropsWithChildren } from "react";
409
- import { MarkdownText } from "@/components/assistant-ui/markdown-text";
410
- import { Sources } from "@/components/assistant-ui/sources";
411
- import { TooltipIconButton } from "@/components/assistant-ui/tooltip-icon-button";
412
- import { Button } from "@/components/ui/button";
413
- import {
414
- Reasoning,
415
- ReasoningContent,
416
- ReasoningRoot,
417
- ReasoningText,
418
- ReasoningTrigger,
419
- } from "@/components/assistant-ui/reasoning";
420
- import { ToolFallback } from "@/components/assistant-ui/tool-fallback";
421
- import {
422
- ToolGroupContent,
423
- ToolGroupRoot,
424
- ToolGroupTrigger,
425
- } from "@/components/assistant-ui/tool-group";
426
- import {
427
- AuiIf,
428
- ComposerPrimitive,
429
- groupPartByType,
430
- MessagePrimitive,
431
- SuggestionPrimitive,
432
- ThreadPrimitive,
433
- useAuiState,
434
- } from "@assistant-ui/react";
435
- import { ArrowDownIcon, ArrowUpIcon, SquareIcon } from "lucide-react";
436
-
437
- export const MyThread: FC = () => {
438
- return (
439
- <ThreadPrimitive.Root
440
- className="bg-background flex h-full flex-col"
441
- style={{ ["--thread-max-width" as string]: "44rem" }}
442
- >
443
- <ThreadPrimitive.Viewport className="flex flex-1 flex-col overflow-y-scroll scroll-smooth px-4 pt-8">
444
- <AuiIf condition={(s) => s.thread.isEmpty}>
445
- <ThreadWelcome />
446
- </AuiIf>
447
-
448
- <ThreadPrimitive.Messages>
449
- {({ message }) => {
450
- if (message.role === "user") return <UserMessage />;
451
- return <AssistantMessage />;
452
- }}
453
- </ThreadPrimitive.Messages>
454
-
455
- <ThreadPrimitive.ViewportFooter className="sticky bottom-0 mx-auto mt-auto flex w-full max-w-(--thread-max-width) flex-col gap-4 pb-4">
456
- <ThreadPrimitive.ScrollToBottom asChild>
457
- <TooltipIconButton
458
- tooltip="Scroll to bottom"
459
- variant="outline"
460
- className="absolute -top-12 self-center rounded-full p-4 disabled:invisible"
461
- >
462
- <ArrowDownIcon />
463
- </TooltipIconButton>
464
- </ThreadPrimitive.ScrollToBottom>
465
- <Composer />
466
- </ThreadPrimitive.ViewportFooter>
467
- </ThreadPrimitive.Viewport>
468
- </ThreadPrimitive.Root>
469
- );
470
- };
471
-
472
- const Text: FC<{ text: string }> = ({ text }) => {
473
- return <p>{text}</p>;
474
- };
475
-
476
- const ThreadWelcome: FC = () => {
477
- return (
478
- <div className="mx-auto flex w-full max-w-(--thread-max-width) grow flex-col justify-center gap-6">
479
- <div>
480
- <h1 className="text-2xl font-semibold">
481
- What should we think through?
482
- </h1>
483
- </div>
484
- <div className="flex flex-wrap gap-2">
485
- <ThreadPrimitive.Suggestions>
486
- {() => <ThreadSuggestionItem />}
487
- </ThreadPrimitive.Suggestions>
488
- </div>
489
- </div>
490
- );
491
- };
492
-
493
- const ThreadSuggestionItem: FC = () => {
494
- return (
495
- <SuggestionPrimitive.Trigger send asChild>
496
- <Button
497
- type="button"
498
- variant="ghost"
499
- className="bg-background hover:bg-muted h-auto w-full flex-col items-start justify-start gap-1 rounded-2xl border px-4 py-3 text-start text-sm sm:w-[calc(50%-0.25rem)]"
500
- >
501
- <SuggestionPrimitive.Title className="font-medium" />
502
- <SuggestionPrimitive.Description className="text-muted-foreground empty:hidden" />
503
- </Button>
504
- </SuggestionPrimitive.Trigger>
505
- );
506
- };
507
-
508
- const UserMessage: FC = () => {
509
- return (
510
- <MessagePrimitive.Root className="mx-auto w-full max-w-(--thread-max-width) py-3">
511
- <div className="flex justify-end">
512
- <div className="bg-primary text-primary-foreground max-w-[80%] rounded-2xl px-4 py-2">
513
- <MessagePrimitive.Parts>
514
- {({ part }) => {
515
- if (part.type === "text") return <Text {...part} />;
516
- return null;
517
- }}
518
- </MessagePrimitive.Parts>
519
- </div>
520
- </div>
521
- </MessagePrimitive.Root>
522
- );
523
- };
524
-
525
- const AssistantMessage: FC = () => {
526
- return (
527
- <MessagePrimitive.Root className="mx-auto w-full max-w-(--thread-max-width) py-3">
528
- <div className="flex flex-col gap-2 px-2 leading-relaxed">
529
- <MessagePrimitive.GroupedParts
530
- groupBy={groupPartByType({
531
- reasoning: ["group-chainOfThought", "group-reasoning"],
532
- "tool-call": ["group-chainOfThought", "group-tool"],
533
- "standalone-tool-call": [],
534
- source: ["group-sources"],
535
- })}
536
- >
537
- {({ part, children }) => {
538
- switch (part.type) {
539
- case "group-chainOfThought":
540
- return <div data-slot="aui_chain-of-thought">{children}</div>;
541
- case "group-tool":
542
- return (
543
- <ToolGroupRoot variant="ghost">
544
- <ToolGroupTrigger
545
- count={part.indices.length}
546
- active={part.status.type === "running"}
547
- />
548
- <ToolGroupContent>{children}</ToolGroupContent>
549
- </ToolGroupRoot>
550
- );
551
- case "group-reasoning": {
552
- const running = part.status.type === "running";
553
- return (
554
- <ReasoningRoot streaming={running}>
555
- <ReasoningTrigger active={running} />
556
- <ReasoningContent aria-busy={running}>
557
- <ReasoningText>{children}</ReasoningText>
558
- </ReasoningContent>
559
- </ReasoningRoot>
560
- );
561
- }
562
- case "group-sources":
563
- return <SourcesLayout>{children}</SourcesLayout>;
564
- case "text":
565
- return <MarkdownText />;
566
- case "reasoning":
567
- return <Reasoning {...part} />;
568
- case "tool-call":
569
- return part.toolUI ?? <ToolFallback {...part} />;
570
- case "source":
571
- return <Sources {...part} />;
572
- default:
573
- return null;
574
- }
575
- }}
576
- </MessagePrimitive.GroupedParts>
577
- </div>
578
- </MessagePrimitive.Root>
579
- );
580
- };
581
-
582
- const SourcesLayout: FC<PropsWithChildren> = ({ children }) => {
583
- return (
584
- <div className="flex flex-wrap items-center gap-1.5">
585
- <span className="text-muted-foreground mr-1 text-xs">Sources</span>
586
- {children}
587
- </div>
588
- );
589
- };
590
-
591
- const Composer: FC = () => {
592
- const isRunning = useAuiState((s) => s.thread.isRunning);
593
-
594
- return (
595
- <ComposerPrimitive.Root className="border-input bg-background has-[textarea:focus-visible]:border-foreground/60 flex w-full flex-col rounded-2xl border px-1 pt-2 transition-colors outline-none">
596
- <ComposerPrimitive.Input
597
- placeholder="Send a message..."
598
- className="placeholder:text-muted-foreground mb-1 max-h-32 min-h-14 w-full resize-none bg-transparent px-4 pt-2 pb-3 text-sm outline-none"
599
- rows={1}
600
- autoFocus
601
- />
602
- <div className="relative mx-2 mb-2 flex items-center justify-end">
603
- {!isRunning ? (
604
- <ComposerPrimitive.Send asChild>
605
- <TooltipIconButton
606
- tooltip="Send"
607
- side="bottom"
608
- variant="default"
609
- size="icon"
610
- className="size-8 rounded-full"
611
- >
612
- <ArrowUpIcon className="size-4" />
613
- </TooltipIconButton>
614
- </ComposerPrimitive.Send>
615
- ) : (
616
- <ComposerPrimitive.Cancel asChild>
617
- <Button
618
- type="button"
619
- variant="default"
620
- size="icon"
621
- className="size-8 rounded-full"
622
- >
623
- <SquareIcon className="size-3 fill-current" />
624
- </Button>
625
- </ComposerPrimitive.Cancel>
626
- )}
627
- </div>
628
- </ComposerPrimitive.Root>
629
- );
630
- };
631
-
632
- ```
633
-
634
- ## app/page.tsx
635
-
636
- ```tsx
637
- "use client";
638
-
639
- import {
640
- AssistantRuntimeProvider,
641
- AuiConfig,
642
- Tools,
643
- useAui,
644
- AuiProvider,
645
- Suggestions,
646
- } from "@assistant-ui/react";
647
- import { useChatRuntime } from "@assistant-ui/ai-sdk";
648
- import { MyThread } from "./MyThread";
649
- import { lastAssistantMessageIsCompleteWithApprovalResponses } from "ai";
650
- import toolkit from "./toolkit";
651
-
652
- function MyThreadWithSuggestions() {
653
- const aui = useAui();
654
- const config = AuiConfig({
655
- suggestions: Suggestions([
656
- {
657
- title: "Calculate Fibonacci(20)",
658
- label: "with chain of thought",
659
- prompt:
660
- "Calculate the 20th Fibonacci number using JavaScript and show your reasoning.",
661
- },
662
- {
663
- title: "Research with citations",
664
- label: "show sources",
665
- prompt:
666
- "Research recent developments in renewable energy and cite your sources.",
667
- },
668
- ]),
669
- });
670
- return (
671
- <AuiProvider extends={aui} config={config}>
672
- <MyThread />
673
- </AuiProvider>
674
- );
675
- }
676
-
677
- export default function Home() {
678
- const runtime = useChatRuntime({
679
- sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithApprovalResponses,
680
- });
681
- const config = AuiConfig({
682
- tools: Tools({ toolkit }),
683
- });
684
-
685
- return (
686
- <AssistantRuntimeProvider config={config} runtime={runtime}>
687
- <div className="h-full">
688
- <MyThreadWithSuggestions />
689
- </div>
690
- </AssistantRuntimeProvider>
691
- );
692
- }
693
-
694
- ```
695
-
696
- ## app/toolkit.tsx
697
-
698
- ```tsx
699
- "use generative";
700
-
701
- import { defineToolkit } from "@assistant-ui/react";
702
- import { z } from "zod";
703
-
704
- type ExecuteJsResult =
705
- | { success: true; result: string }
706
- | { success: false; error: string };
707
-
708
- export default defineToolkit({
709
- execute_js: {
710
- description: "Execute JavaScript code and return the result",
711
- parameters: z.object({
712
- code: z.string().describe("The JavaScript code to execute"),
713
- }),
714
- execute: async ({ code }) => {
715
- "use client";
716
- try {
717
- const result = eval(code);
718
- return { success: true, result: String(result) };
719
- } catch (e) {
720
- return { success: false, error: String(e) };
721
- }
722
- },
723
- render: ({ args, result, status }) => {
724
- const output = result as ExecuteJsResult | undefined;
725
- return (
726
- <div className="bg-muted/30 my-2 rounded-lg border p-4 text-sm">
727
- <p className="mb-1 font-semibold">execute_js</p>
728
- <pre className="bg-background rounded p-2 font-mono text-xs whitespace-pre-wrap">
729
- {args.code}
730
- </pre>
731
- {status.type !== "running" && output && (
732
- <div className="mt-2 border-t pt-2">
733
- <p className="text-muted-foreground font-semibold">
734
- {output.success ? "Result:" : "Error:"}
735
- </p>
736
- <pre className="font-mono text-xs whitespace-pre-wrap">
737
- {output.success ? output.result : output.error}
738
- </pre>
739
- </div>
740
- )}
741
- </div>
742
- );
743
- },
744
- },
745
- });
746
-
747
- ```
748
-
749
- ## components.json
750
-
751
- ```json
752
- {
753
- "$schema": "https://ui.shadcn.com/schema.json",
754
- "style": "new-york",
755
- "rsc": true,
756
- "tsx": true,
757
- "tailwind": {
758
- "config": "",
759
- "css": "app/globals.css",
760
- "baseColor": "zinc",
761
- "cssVariables": true,
762
- "prefix": ""
763
- },
764
- "aliases": {
765
- "components": "@/components",
766
- "utils": "@/lib/utils",
767
- "ui": "@/components/ui",
768
- "lib": "@/lib",
769
- "hooks": "@/hooks"
770
- },
771
- "iconLibrary": "lucide",
772
- "registries": {
773
- "@assistant-ui": "https://r.assistant-ui.com/{name}.json"
774
- }
775
- }
776
-
777
- ```
778
-
779
- ## next.config.js
780
-
781
- ```javascript
782
- import { withAui } from "@assistant-ui/next";
783
- /** @type {import('next').NextConfig} */
784
- const nextConfig = {
785
- transpilePackages: ["@assistant-ui/react", "@assistant-ui/ai-sdk"],
786
- };
787
-
788
- export default withAui(nextConfig);
789
-
790
- ```
791
-
792
- ## package.json
793
-
794
- ```json
795
- {
796
- "name": "with-chain-of-thought",
797
- "version": "0.0.0",
798
- "private": true,
799
- "type": "module",
800
- "scripts": {
801
- "dev": "next dev",
802
- "build": "next build",
803
- "start": "next start"
804
- },
805
- "dependencies": {
806
- "@ai-sdk/openai": "^4.0.46",
807
- "@assistant-ui/ai-sdk": "workspace:*",
808
- "@assistant-ui/react": "workspace:*",
809
- "@assistant-ui/react-markdown": "workspace:*",
810
- "@assistant-ui/ui": "workspace:*",
811
- "ai": "^7.0.77",
812
- "class-variance-authority": "^0.7.1",
813
- "clsx": "^2.1.1",
814
- "lucide-react": "^1.33.0",
815
- "next": "^16.3.2",
816
- "react": "^19.2.8",
817
- "react-dom": "^19.2.8",
818
- "tailwind-merge": "^3.6.0",
819
- "zod": "^4.4.3"
820
- },
821
- "devDependencies": {
822
- "@assistant-ui/next": "workspace:*",
823
- "@assistant-ui/x-buildutils": "workspace:*",
824
- "@tailwindcss/postcss": "^4.3.3",
825
- "@types/node": "^26.2.0",
826
- "@types/react": "^19.2.18",
827
- "@types/react-dom": "^19.2.5",
828
- "postcss": "^8.5.26",
829
- "tailwindcss": "^4.3.3",
830
- "tw-animate-css": "^1.4.0",
831
- "typescript": "^7.0.2"
832
- }
833
- }
834
-
835
- ```
836
-
837
- ## README.md
838
-
839
- ```markdown
840
- # Chain of Thought Example
841
-
842
- A real chat flow that renders reasoning, tool calls, and source citations as grouped message parts. Demonstrates `MessagePrimitive.GroupedParts` with a nested `groupBy` path, plus structured `source` parts emitted from a search tool.
843
-
844
- ## Quick start
845
-
846
- ### Using the CLI
847
-
848
- ```bash
849
- npx assistant-ui@latest create my-app --example with-chain-of-thought
850
- cd my-app
851
- ```
852
-
853
- ### Environment variables
854
-
855
- `OPENAI_API_KEY` is optional. With the key set the route runs a real reasoning model and a `search_web` tool; without it the route streams a deterministic mock response with the same chunk shapes, so the UI is fully demonstrable offline.
856
-
857
- Create `.env.local`:
858
-
859
- ```
860
- OPENAI_API_KEY=sk-...
861
- ```
862
-
863
- ### Run
864
-
865
- ```bash
866
- npm install
867
- npm run dev
868
- ```
869
-
870
- Open [http://localhost:3000](http://localhost:3000).
871
-
872
- ## What the example demonstrates
873
-
874
- | Concern | Where it lives |
875
- |---|---|
876
- | Real chat flow with `useChatRuntime` | `app/page.tsx` |
877
- | Reasoning, tool calls, source citations streamed as message parts | `app/api/chat/route.ts` |
878
- | Nested adjacency-based grouping with `MessagePrimitive.GroupedParts` | `app/MyThread.tsx` |
879
- | `Sources` component rendering `source` parts | `app/MyThread.tsx` |
880
- | Fallback path that runs without an API key | `app/api/chat/route.ts` (`streamFallback`) |
881
-
882
- ## How parts are grouped
883
-
884
- The thread groups three part types under one collapsible "Thinking" section, then renders source badges in a row below it. The grouping is configured on `MessagePrimitive.GroupedParts`:
885
-
886
- ```tsx
887
- <MessagePrimitive.GroupedParts
888
- groupBy={(part) => {
889
- if (part.type === "reasoning") return ["group-chainOfThought", "group-reasoning"];
890
- if (part.type === "tool-call") return ["group-chainOfThought", "group-tool"];
891
- if (part.type === "source") return ["group-chainOfThought", "group-sources"];
892
- return null;
893
- }}
894
- >
895
- ```
896
-
897
- Each part is mapped to a nested group key path. Adjacent parts that share a path are coalesced and rendered through the matching `group-*` case in the render function. `null` leaves a part ungrouped.
898
-
899
- This is the canonical pattern. For non-adjacent clustering (parts that share an identifier but appear at different positions in the message), see [`/docs/ui/part-grouping`](https://www.assistant-ui.com/docs/ui/part-grouping).
900
-
901
- ## How sources are emitted
902
-
903
- The route emits structured `source-url` chunks; `@assistant-ui/ai-sdk` converts them to `source` message parts that the `Sources` component renders as badges. They are not URLs scraped from assistant text.
904
-
905
- ```ts
906
- writer.write({
907
- type: "source-url",
908
- sourceId: "src-1",
909
- url: "https://example.com/report",
910
- title: "Example report",
911
- });
912
- ```
913
-
914
- In the real path the `search_web` tool returns sources in its output, and the route writes one `source-url` chunk per result immediately after the `tool-output-available` chunk. In the fallback path the same shape is written directly. The UI rendering is identical in both modes.
915
-
916
- ## Why these features live together
917
-
918
- Chain-of-thought, tool calls, and citation sources are the parts of an assistant turn a user typically wants to inspect together. Grouping them under one collapsible keeps the message tidy by default and reveals the full reasoning trail on demand.
919
-
920
- ## Related documentation
921
-
922
- - [Message Part Grouping](https://www.assistant-ui.com/docs/ui/part-grouping)
923
- - [Sources component](https://www.assistant-ui.com/docs/ui/sources)
924
- - [AI SDK v6 runtime](https://www.assistant-ui.com/docs/runtimes/ai-sdk/v6)
925
-
926
- ```
927
-
928
- ## tsconfig.json
929
-
930
- ```json
931
- {
932
- "extends": "@assistant-ui/x-buildutils/ts/next",
933
- "compilerOptions": {
934
- "paths": {
935
- "@/*": ["./*"],
936
- "@/components/assistant-ui/*": [
937
- "../../packages/ui/src/components/assistant-ui/*"
938
- ],
939
- "@/hooks/*": ["../../packages/ui/src/hooks/*"],
940
- "@/components/ui/*": [
941
- "../../packages/ui/src/components/ui/base/*",
942
- "../../packages/ui/src/components/ui/radix/*"
943
- ],
944
- "@/components/ui/radix/*": [
945
- "../../packages/ui/src/components/ui/radix/*"
946
- ],
947
- "@/lib/utils": ["../../packages/ui/src/lib/utils"],
948
- "@assistant-ui/ui/*": ["../../packages/ui/src/*"],
949
- "@assistant-ui/store/client": ["../../packages/store/src/client"],
950
- "@assistant-ui/*": ["../../packages/*/src"],
951
- "@assistant-ui/core/*": ["../../packages/core/src/*"],
952
- "@assistant-ui/react/*": ["../../packages/react/src/*"],
953
- "@assistant-ui/tap/*": ["../../packages/tap/src/*"],
954
- "assistant-stream": ["../../packages/assistant-stream/src"]
955
- }
956
- },
957
- "include": ["**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
958
- "exclude": ["node_modules"]
959
- }
960
-
961
- ```
962
-