@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,901 +0,0 @@
1
- ---
2
- title: LangChain React Runtime
3
- description: Use LangChain's useStream hook with a React chat UI through assistant-ui — a lighter LangGraph adapter that delegates streaming to @langchain/react.
4
- ---
5
-
6
- import { LangGraphIcon } from "@/components/icons/langgraph";
7
-
8
- `@assistant-ui/react-langchain` wraps [`useStream`](https://reference.langchain.com/javascript/langchain-react/use-stream) from `@langchain/react` and exposes it as an assistant-ui runtime. It targets the same backend as [`@assistant-ui/react-langgraph`](/docs/runtimes/langgraph/overview) (LangGraph Cloud) but at a higher level, delegating stream plumbing to the upstream hook.
9
-
10
- ## When to use it
11
-
12
- Pick `react-langchain` over `react-langgraph` when:
13
-
14
- - You are scaffolding via `npx create-assistant-ui -t langchain` (the official template uses it).
15
- - Your app already depends on `@langchain/react` and uses `useStream` elsewhere.
16
- - You want to read custom state keys (`todos`, `files`, plans) reactively with `useLangChainState<T>(key)`.
17
- - You prefer a thin wrapper that stays pinned to upstream behavior.
18
-
19
- Pick `react-langgraph` instead when:
20
-
21
- - You need a fully custom/bespoke backend stream (your own async generator) rather than `useStream`'s transport, or you're maintaining an existing `react-langgraph` app.
22
-
23
- Both adapters are first-class and now at feature parity (the [comparison](#comparison-with-react-langgraph) below has the full table); `react-langchain` is the newer, thinner wrapper pinned to upstream `useStream`.
24
-
25
- ## Architecture
26
-
27
- `@assistant-ui/react-langchain` is layered on `ExternalStoreRuntime` (see [architecture](/docs/runtimes/concepts/architecture)). Graph state is the source of truth; the runtime renders messages from `state.values.messages` and submits user input back to the graph.
28
-
29
- Shared adapters (attachments, speech, feedback) work the same way described in [adapters](/docs/runtimes/concepts/adapters). Cloud thread persistence is built in.
30
-
31
- `thread.isLoading` reflects `useStream`'s `isThreadLoading` (initial history hydration), separate from `isRunning` (a run being in-flight).
32
-
33
- ## Requirements
34
-
35
- - A LangGraph Cloud API server (locally via [LangGraph Studio](https://docs.langchain.com/langsmith/quick-start-studio) or hosted via [LangSmith](https://www.langchain.com/langsmith)).
36
- - The graph state must include a `messages` key with LangChain-alike messages, or pass a custom `messagesKey`.
37
-
38
- ## Quickstart
39
-
40
- <Steps>
41
- <Step>
42
-
43
- ### Install dependencies
44
-
45
- <PlatformTabs>
46
- <Tab value="React">
47
-
48
- <InstallCommand npm={["@assistant-ui/react", "@assistant-ui/react-langchain", "@langchain/react", "@langchain/langgraph-sdk"]} />
49
-
50
- </Tab>
51
- <Tab value="React Native">
52
-
53
- <InstallCommand expo={["@assistant-ui/react-native", "@assistant-ui/react-langchain", "@langchain/react", "@langchain/langgraph-sdk"]} />
54
-
55
- </Tab>
56
- <Tab value="React Ink">
57
-
58
- <InstallCommand npm={["@assistant-ui/react-ink", "@assistant-ui/react-langchain", "@langchain/react", "@langchain/langgraph-sdk", "ink", "react"]} />
59
-
60
- </Tab>
61
- </PlatformTabs>
62
-
63
- </Step>
64
- <Step>
65
-
66
- ### Define the assistant component
67
-
68
- <PlatformTabs>
69
- <Tab value="React">
70
-
71
- ```tsx title="@/components/MyAssistant.tsx"
72
- "use client";
73
-
74
- import { Thread } from "@/components/assistant-ui/thread";
75
- import { AssistantRuntimeProvider } from "@assistant-ui/react";
76
- import { useStreamRuntime } from "@assistant-ui/react-langchain";
77
-
78
- export function MyAssistant() {
79
- const runtime = useStreamRuntime({
80
- assistantId: process.env["NEXT_PUBLIC_LANGGRAPH_ASSISTANT_ID"]!,
81
- apiUrl: process.env["NEXT_PUBLIC_LANGGRAPH_API_URL"],
82
- });
83
-
84
- return (
85
- <AssistantRuntimeProvider runtime={runtime}>
86
- <Thread />
87
- </AssistantRuntimeProvider>
88
- );
89
- }
90
- ```
91
-
92
- </Tab>
93
- <Tab value="React Native">
94
-
95
- ```tsx title="components/MyAssistant.tsx"
96
- import { Thread } from "@/components/assistant-ui/thread";
97
- import { AssistantRuntimeProvider } from "@assistant-ui/react-native";
98
- import { useStreamRuntime } from "@assistant-ui/react-langchain";
99
-
100
- export function MyAssistant() {
101
- const runtime = useStreamRuntime({
102
- assistantId: process.env.EXPO_PUBLIC_LANGGRAPH_ASSISTANT_ID!,
103
- apiUrl: process.env.EXPO_PUBLIC_LANGGRAPH_API_URL,
104
- });
105
-
106
- return (
107
- <AssistantRuntimeProvider runtime={runtime}>
108
- <Thread />
109
- </AssistantRuntimeProvider>
110
- );
111
- }
112
- ```
113
-
114
- </Tab>
115
- <Tab value="React Ink">
116
-
117
- ```tsx title="components/MyAssistant.tsx"
118
- import { Thread } from "./thread.js";
119
- import { AssistantRuntimeProvider } from "@assistant-ui/react-ink";
120
- import { useStreamRuntime } from "@assistant-ui/react-langchain";
121
-
122
- export function MyAssistant() {
123
- const runtime = useStreamRuntime({
124
- assistantId: process.env.LANGGRAPH_ASSISTANT_ID!,
125
- apiUrl: process.env.LANGGRAPH_API_URL,
126
- });
127
-
128
- return (
129
- <AssistantRuntimeProvider runtime={runtime}>
130
- <Thread />
131
- </AssistantRuntimeProvider>
132
- );
133
- }
134
- ```
135
-
136
- </Tab>
137
- </PlatformTabs>
138
-
139
- </Step>
140
- <Step>
141
-
142
- ### Mount the component
143
-
144
- <PlatformTabs>
145
- <Tab value="React">
146
-
147
- ```tsx title="@/app/page.tsx"
148
- import { MyAssistant } from "@/components/MyAssistant";
149
-
150
- export default function Home() {
151
- return (
152
- <main className="h-dvh">
153
- <MyAssistant />
154
- </main>
155
- );
156
- }
157
- ```
158
-
159
- </Tab>
160
- <Tab value="React Native">
161
-
162
- ```tsx title="app/index.tsx"
163
- import { View } from "react-native";
164
- import { MyAssistant } from "@/components/MyAssistant";
165
-
166
- export default function Home() {
167
- return (
168
- <View style={{ flex: 1 }}>
169
- <MyAssistant />
170
- </View>
171
- );
172
- }
173
- ```
174
-
175
- </Tab>
176
- <Tab value="React Ink">
177
-
178
- ```tsx title="app.tsx"
179
- import { Box } from "ink";
180
- import { MyAssistant } from "./components/MyAssistant.js";
181
-
182
- export function App() {
183
- return (
184
- <Box flexDirection="column">
185
- <MyAssistant />
186
- </Box>
187
- );
188
- }
189
- ```
190
-
191
- </Tab>
192
- </PlatformTabs>
193
-
194
- </Step>
195
- <Step>
196
-
197
- ### Set environment variables
198
-
199
- <PlatformTabs>
200
- <Tab value="React">
201
-
202
- ```sh title=".env.local"
203
- NEXT_PUBLIC_LANGGRAPH_API_URL=http://localhost:2024
204
- NEXT_PUBLIC_LANGGRAPH_ASSISTANT_ID=your_graph_id
205
- ```
206
-
207
- </Tab>
208
- <Tab value="React Native">
209
-
210
- ```sh title=".env"
211
- EXPO_PUBLIC_LANGGRAPH_API_URL=http://localhost:2024
212
- EXPO_PUBLIC_LANGGRAPH_ASSISTANT_ID=your_graph_id
213
- ```
214
-
215
- </Tab>
216
- <Tab value="React Ink">
217
-
218
- ```sh title=".env"
219
- LANGGRAPH_API_URL=http://localhost:2024
220
- LANGGRAPH_ASSISTANT_ID=your_graph_id
221
- ```
222
-
223
- </Tab>
224
- </PlatformTabs>
225
-
226
- </Step>
227
- <Step>
228
-
229
- ### Set up UI components
230
-
231
- <PlatformTabs>
232
- <Tab value="React">
233
-
234
- Follow the [UI Components guide](/docs/ui/thread).
235
-
236
- </Tab>
237
- <Tab value="React Native">
238
-
239
- Follow the [React Native setup](/docs/react-native).
240
-
241
- </Tab>
242
- <Tab value="React Ink">
243
-
244
- Follow the [Ink setup](/docs/ink).
245
-
246
- </Tab>
247
- </PlatformTabs>
248
-
249
- </Step>
250
- </Steps>
251
-
252
- ## `useStreamRuntime` options
253
-
254
- `useStreamRuntime` accepts every option upstream `useStream` does, plus these assistant-ui-specific fields:
255
-
256
- | Option | Type | Description |
257
- | --- | --- | --- |
258
- | `cloud` | `AssistantCloud` | Optional. Persists threads via assistant-cloud. |
259
- | `adapters` | `{ attachments?, speech?, feedback? }` | Optional. Attachment, speech, and feedback adapters. |
260
- | `messagesKey` | `string` | The state key that holds messages. Defaults to `"messages"`. |
261
- | `uiStateKey` | `string` | The state key that holds generative `UIMessage`s. Defaults to `"ui"`. |
262
-
263
- ### Forwarding per-run config
264
-
265
- When a message is sent, its `runConfig.custom` (for example a selected mode or model) is forwarded on the underlying `useStream().submit` call as `config.configurable`. Automatic tool-result resumes and the interrupt helpers (`useLangChainRespond`, `useLangChainRespondAll`, and `useLangChainSubmit(null, { command })`) reuse that same recorded `configurable` unless the caller passes `config`. Raw `useLangChainSubmit` / `useLangChainSend` calls that start a new run do not inherit it. The recording is session-scoped and does not survive a reload. Read it in the graph from `config["configurable"]`; on LangGraph v1 the same values are also reachable through the Runtime `context`, which `config.configurable` is aliased to. This lets per-run app config reach the graph without extra wiring.
266
-
267
- ## Reading custom state keys
268
-
269
- LangGraph agents often expose structured state beyond messages (plans, todos, scratch files, generative-UI artifacts). Read them directly with `useLangChainState`. It mirrors `useStream().values[key]` upstream and updates when the stream emits new state.
270
-
271
- <PlatformTabs>
272
- <Tab value="React">
273
-
274
- ```tsx
275
- import { useLangChainState } from "@assistant-ui/react-langchain";
276
-
277
- type Todo = { id: string; title: string; done: boolean };
278
-
279
- function TodoList() {
280
- const todos = useLangChainState<Todo[]>("todos", []);
281
- return (
282
- <ul>
283
- {todos.map((t) => (
284
- <li key={t.id}>
285
- {t.done ? "✓" : "○"} {t.title}
286
- </li>
287
- ))}
288
- </ul>
289
- );
290
- }
291
- ```
292
-
293
- </Tab>
294
- <Tab value="React Native">
295
-
296
- ```tsx
297
- import { useLangChainState } from "@assistant-ui/react-langchain";
298
- import { Text, View } from "react-native";
299
-
300
- type Todo = { id: string; title: string; done: boolean };
301
-
302
- function TodoList() {
303
- const todos = useLangChainState<Todo[]>("todos", []);
304
- return (
305
- <View>
306
- {todos.map((t) => (
307
- <Text key={t.id}>
308
- {t.done ? "✓" : "○"} {t.title}
309
- </Text>
310
- ))}
311
- </View>
312
- );
313
- }
314
- ```
315
-
316
- </Tab>
317
- <Tab value="React Ink">
318
-
319
- ```tsx
320
- import { useLangChainState } from "@assistant-ui/react-langchain";
321
- import { Box, Text } from "ink";
322
-
323
- type Todo = { id: string; title: string; done: boolean };
324
-
325
- function TodoList() {
326
- const todos = useLangChainState<Todo[]>("todos", []);
327
- return (
328
- <Box flexDirection="column">
329
- {todos.map((t) => (
330
- <Text key={t.id}>
331
- {t.done ? "✓" : "○"} {t.title}
332
- </Text>
333
- ))}
334
- </Box>
335
- );
336
- }
337
- ```
338
-
339
- </Tab>
340
- </PlatformTabs>
341
-
342
- Signatures:
343
-
344
- ```ts
345
- useLangChainState<T>(key: string): T | undefined;
346
- useLangChainState<T>(key: string, defaultValue: T): T;
347
- ```
348
-
349
- Useful with the [`deepagents`](https://docs.langchain.com/oss/python/deepagents) middleware, whose `write_todos` step updates `state.todos` alongside the tool-call stream. Reading the state key directly avoids reconstructing the list from partial tool-call args.
350
-
351
- <Callout type="info">
352
- Added in v0.0.2 — see issue [#3862](https://github.com/assistant-ui/assistant-ui/issues/3862) for motivation.
353
- </Callout>
354
-
355
- ## Interrupts
356
-
357
- LangGraph interrupts pause the graph and wait for client input. `useLangChainInterruptState` exposes the current interrupt; `useLangChainRespond` resumes it with a response payload, while `useLangChainSubmit` resumes the graph with a raw state update.
358
-
359
- `useLangChainRespond` is the cleaner resume path; it carries the response payload via `useStream().respond` and handles interrupt namespaces, so you don't have to construct a `Command`.
360
-
361
- <PlatformTabs>
362
- <Tab value="React">
363
-
364
- ```tsx
365
- import {
366
- useLangChainInterruptState,
367
- useLangChainRespond,
368
- } from "@assistant-ui/react-langchain";
369
-
370
- function InterruptPrompt() {
371
- const interrupt = useLangChainInterruptState();
372
- const respond = useLangChainRespond();
373
- if (!interrupt) return null;
374
- return (
375
- <div>
376
- <pre>{JSON.stringify(interrupt.value, null, 2)}</pre>
377
- <button onClick={() => respond({ approved: true })}>Approve</button>
378
- </div>
379
- );
380
- }
381
- ```
382
-
383
- </Tab>
384
- <Tab value="React Native">
385
-
386
- ```tsx
387
- import {
388
- useLangChainInterruptState,
389
- useLangChainRespond,
390
- } from "@assistant-ui/react-langchain";
391
- import { Pressable, Text, View } from "react-native";
392
-
393
- function InterruptPrompt() {
394
- const interrupt = useLangChainInterruptState();
395
- const respond = useLangChainRespond();
396
- if (!interrupt) return null;
397
- return (
398
- <View>
399
- <Text>{JSON.stringify(interrupt.value, null, 2)}</Text>
400
- <Pressable onPress={() => respond({ approved: true })}>
401
- <Text>Approve</Text>
402
- </Pressable>
403
- </View>
404
- );
405
- }
406
- ```
407
-
408
- </Tab>
409
- <Tab value="React Ink">
410
-
411
- ```tsx
412
- import {
413
- useLangChainInterruptState,
414
- useLangChainRespond,
415
- } from "@assistant-ui/react-langchain";
416
- import { Box, Text, useInput } from "ink";
417
-
418
- function InterruptPrompt() {
419
- const interrupt = useLangChainInterruptState();
420
- const respond = useLangChainRespond();
421
-
422
- useInput((input) => {
423
- if (!interrupt || input !== "a") return;
424
- respond({ approved: true });
425
- });
426
-
427
- if (!interrupt) return null;
428
- return (
429
- <Box flexDirection="column">
430
- <Text>{JSON.stringify(interrupt.value, null, 2)}</Text>
431
- <Text>Press a to approve.</Text>
432
- </Box>
433
- );
434
- }
435
- ```
436
-
437
- </Tab>
438
- </PlatformTabs>
439
-
440
- When several interrupts are pending at once (e.g. parallel approvals), use `useLangChainRespondAll()` to resume them all in one run. Sequential `useLangChainRespond` calls can't, since the first resume starts a run and strands the rest.
441
-
442
- ```tsx
443
- import {
444
- useLangChainInterrupts,
445
- useLangChainRespondAll,
446
- } from "@assistant-ui/react-langchain";
447
-
448
- const interrupts = useLangChainInterrupts();
449
- const respondAll = useLangChainRespondAll();
450
- // resume every pending interrupt with the same payload:
451
- await respondAll(
452
- Object.fromEntries(
453
- interrupts.flatMap((i) => (i.id ? [[i.id, { approved: true }]] : [])),
454
- ),
455
- );
456
- ```
457
-
458
- You can also resume with a raw `Command` via `useLangChainSubmit`:
459
-
460
- <PlatformTabs>
461
- <Tab value="React">
462
-
463
- ```tsx
464
- import {
465
- useLangChainInterruptState,
466
- useLangChainSubmit,
467
- } from "@assistant-ui/react-langchain";
468
- import { Command } from "@langchain/langgraph-sdk";
469
-
470
- function InterruptPrompt() {
471
- const interrupt = useLangChainInterruptState();
472
- const submit = useLangChainSubmit();
473
- if (!interrupt) return null;
474
- return (
475
- <div>
476
- <pre>{JSON.stringify(interrupt.value, null, 2)}</pre>
477
- <button
478
- onClick={() =>
479
- submit(null, { command: new Command({ resume: "approved" }) })
480
- }
481
- >
482
- Approve
483
- </button>
484
- </div>
485
- );
486
- }
487
- ```
488
-
489
- </Tab>
490
- <Tab value="React Native">
491
-
492
- ```tsx
493
- import {
494
- useLangChainInterruptState,
495
- useLangChainSubmit,
496
- } from "@assistant-ui/react-langchain";
497
- import { Command } from "@langchain/langgraph-sdk";
498
- import { Pressable, Text, View } from "react-native";
499
-
500
- function InterruptPrompt() {
501
- const interrupt = useLangChainInterruptState();
502
- const submit = useLangChainSubmit();
503
- if (!interrupt) return null;
504
- return (
505
- <View>
506
- <Text>{JSON.stringify(interrupt.value, null, 2)}</Text>
507
- <Pressable
508
- onPress={() =>
509
- submit(null, { command: new Command({ resume: "approved" }) })
510
- }
511
- >
512
- <Text>Approve</Text>
513
- </Pressable>
514
- </View>
515
- );
516
- }
517
- ```
518
-
519
- </Tab>
520
- <Tab value="React Ink">
521
-
522
- ```tsx
523
- import {
524
- useLangChainInterruptState,
525
- useLangChainSubmit,
526
- } from "@assistant-ui/react-langchain";
527
- import { Command } from "@langchain/langgraph-sdk";
528
- import { Box, Text, useInput } from "ink";
529
-
530
- function InterruptPrompt() {
531
- const interrupt = useLangChainInterruptState();
532
- const submit = useLangChainSubmit();
533
-
534
- useInput((input) => {
535
- if (!interrupt || input !== "a") return;
536
- submit(null, { command: new Command({ resume: "approved" }) });
537
- });
538
-
539
- if (!interrupt) return null;
540
- return (
541
- <Box flexDirection="column">
542
- <Text>{JSON.stringify(interrupt.value, null, 2)}</Text>
543
- <Text>Press a to approve.</Text>
544
- </Box>
545
- );
546
- }
547
- ```
548
-
549
- </Tab>
550
- </PlatformTabs>
551
-
552
- ## Tool calls
553
-
554
- `useLangChainToolCalls` exposes the root tool calls `useStream` assembles from the `tools` channel — each entry carries a `name`, `args`, and `id`. Use it to render pending or streamed tool calls and approval UIs. It defaults to an empty array, so you can `.map` without a guard.
555
-
556
- <PlatformTabs>
557
- <Tab value="React">
558
-
559
- ```tsx
560
- import { useLangChainToolCalls } from "@assistant-ui/react-langchain";
561
-
562
- function PendingToolCalls() {
563
- const toolCalls = useLangChainToolCalls();
564
- return (
565
- <ul>
566
- {toolCalls.map((tc) => (
567
- <li key={tc.id}>
568
- {tc.name}: <code>{JSON.stringify(tc.args)}</code>
569
- </li>
570
- ))}
571
- </ul>
572
- );
573
- }
574
- ```
575
-
576
- </Tab>
577
- <Tab value="React Native">
578
-
579
- ```tsx
580
- import { useLangChainToolCalls } from "@assistant-ui/react-langchain";
581
- import { Text, View } from "react-native";
582
-
583
- function PendingToolCalls() {
584
- const toolCalls = useLangChainToolCalls();
585
- return (
586
- <View>
587
- {toolCalls.map((tc) => (
588
- <Text key={tc.id}>
589
- {tc.name}: {JSON.stringify(tc.args)}
590
- </Text>
591
- ))}
592
- </View>
593
- );
594
- }
595
- ```
596
-
597
- </Tab>
598
- <Tab value="React Ink">
599
-
600
- ```tsx
601
- import { useLangChainToolCalls } from "@assistant-ui/react-langchain";
602
- import { Box, Text } from "ink";
603
-
604
- function PendingToolCalls() {
605
- const toolCalls = useLangChainToolCalls();
606
- return (
607
- <Box flexDirection="column">
608
- {toolCalls.map((tc) => (
609
- <Text key={tc.id}>
610
- {tc.name}: {JSON.stringify(tc.args)}
611
- </Text>
612
- ))}
613
- </Box>
614
- );
615
- }
616
- ```
617
-
618
- </Tab>
619
- </PlatformTabs>
620
-
621
- ## Subagent and subgraph discovery
622
-
623
- For multi-agent graphs, `useStream` tracks which subagents and subgraphs it has seen on the current run as cheap discovery maps. `useLangChainSubagents` and `useLangChainSubgraphs` surface those maps — keyed by namespace, each value a `SubagentDiscoverySnapshot` / `SubgraphDiscoverySnapshot`. Both default to a stable empty map, so you can iterate without a guard.
624
-
625
- These replace `react-langgraph`'s subgraph `eventHandlers`: v1 surfaces discovery as maps you read reactively rather than per-event callbacks.
626
-
627
- ```tsx
628
- import {
629
- useLangChainSubagents,
630
- useLangChainSubgraphs,
631
- } from "@assistant-ui/react-langchain";
632
-
633
- function Discovered() {
634
- const subagents = useLangChainSubagents();
635
- const subgraphs = useLangChainSubgraphs();
636
- return (
637
- <ul>
638
- {[...subagents.keys()].map((ns) => (
639
- <li key={ns}>subagent: {ns}</li>
640
- ))}
641
- {[...subgraphs.keys()].map((ns) => (
642
- <li key={ns}>subgraph: {ns}</li>
643
- ))}
644
- </ul>
645
- );
646
- }
647
- ```
648
-
649
- ## Subagent and subgraph views
650
-
651
- The discovery maps above pair with v1's scoped selector hooks to render a subagent's or subgraph's own messages and tool calls. `useLangChainStream` exposes the underlying `useStream` handle; feed it to `useMessages(stream, target)` / `useToolCalls(stream, target)` from `@langchain/react`, with a `SubagentDiscoverySnapshot` / `SubgraphDiscoverySnapshot` from `useLangChainSubagents` / `useLangChainSubgraphs` as the target. `useLangChainStream` returns `undefined` outside the runtime provider.
652
-
653
- ```tsx
654
- import {
655
- useLangChainStream,
656
- useLangChainSubagents,
657
- } from "@assistant-ui/react-langchain";
658
- import { useMessages, useToolCalls } from "@langchain/react";
659
-
660
- function SubagentCard({ stream, subagent }) {
661
- const messages = useMessages(stream, subagent);
662
- const toolCalls = useToolCalls(stream, subagent);
663
- return (
664
- <div>
665
- <strong>{subagent.namespace.join("/")}</strong>
666
- <pre>{messages.map((m) => m.content).join("\n")}</pre>
667
- <ul>
668
- {toolCalls.map((tc) => (
669
- <li key={tc.id}>{tc.name}</li>
670
- ))}
671
- </ul>
672
- </div>
673
- );
674
- }
675
-
676
- function Subagents() {
677
- const stream = useLangChainStream();
678
- const subagents = useLangChainSubagents();
679
- if (!stream) return null;
680
- return [...subagents.values()].map((s) => (
681
- <SubagentCard key={s.namespace.join("/")} stream={stream} subagent={s} />
682
- ));
683
- }
684
- ```
685
-
686
- ## Per-message metadata
687
-
688
- `useMessageMetadata` (from `@langchain/react`) reads per-message metadata (e.g. `parentCheckpointId`) for a given message id. Pair it with `useLangChainStream`, which returns `undefined` outside the runtime provider; guard the stream before calling the selector, since `useMessageMetadata` throws on an undefined stream.
689
-
690
- ```tsx
691
- import { useLangChainStream } from "@assistant-ui/react-langchain";
692
- import { useMessageMetadata } from "@langchain/react";
693
-
694
- function MessageInfoView({
695
- stream,
696
- messageId,
697
- }: {
698
- stream: NonNullable<ReturnType<typeof useLangChainStream>>;
699
- messageId: string;
700
- }) {
701
- const { parentCheckpointId } = useMessageMetadata(stream, messageId) ?? {};
702
- // …render per-message metadata…
703
- }
704
-
705
- function MessageInfo({ messageId }: { messageId: string }) {
706
- const stream = useLangChainStream();
707
- if (!stream) return null;
708
- return <MessageInfoView stream={stream} messageId={messageId} />;
709
- }
710
- ```
711
-
712
- ## Media
713
-
714
- The v1 media hooks surface multimodal media streamed by the agent. Feed the `useLangChainStream` handle to them — the same pattern as the views and metadata sections above.
715
-
716
- ```tsx
717
- import { useLangChainStream } from "@assistant-ui/react-langchain";
718
- import { useImages, useAudio } from "@langchain/react";
719
-
720
- function MediaView({
721
- stream,
722
- }: {
723
- stream: NonNullable<ReturnType<typeof useLangChainStream>>;
724
- }) {
725
- const images = useImages(stream);
726
- // useAudio / useVideo / useFiles likewise
727
- return <>{/* …render media… */}</>;
728
- }
729
-
730
- function Media() {
731
- const stream = useLangChainStream();
732
- if (!stream) return null;
733
- return <MediaView stream={stream} />;
734
- }
735
- ```
736
-
737
- ## Generative UI
738
-
739
- Graphs can accumulate UI components in their state and attach each one to the assistant message that produced it. The runtime reads these from `stream.values[uiStateKey]` (default `"ui"`) and, for every `UIMessage` whose parent id matches an assistant message, emits a `data` part on that message. The parent id is read from `metadata.message_id` (Python SDK) or `metadata.id` (JS SDK). Pass `uiStateKey` if your graph stores them elsewhere.
740
-
741
- Register the components with `makeAssistantDataUI`, keyed by the `UIMessage`'s `name`, and mount the returned element once inside the runtime provider:
742
-
743
- ```tsx
744
- import {
745
- AssistantRuntimeProvider,
746
- makeAssistantDataUI,
747
- } from "@assistant-ui/react";
748
- import { Thread } from "@/components/assistant-ui/thread";
749
- import { useStreamRuntime } from "@assistant-ui/react-langchain";
750
-
751
- const ChartUI = makeAssistantDataUI({
752
- name: "chart",
753
- render: ({ data }) => <Chart points={data.points} />,
754
- });
755
-
756
- function App() {
757
- const runtime = useStreamRuntime({
758
- assistantId: "agent",
759
- apiUrl: "http://localhost:2024",
760
- });
761
-
762
- return (
763
- <AssistantRuntimeProvider runtime={runtime}>
764
- <ChartUI />
765
- <Thread />
766
- </AssistantRuntimeProvider>
767
- );
768
- }
769
- ```
770
-
771
- This covers two paths transparently. The **state-snapshot** path renders whatever UI the graph has committed to its state. The **live** path renders UI streamed over the `custom` channel by `push_ui_message` / `remove_ui_message` before (or instead of) it lands in state, so components appear as the graph emits them. The runtime accumulates the live events and merges them with the state snapshot, with the snapshot authoritative once a UI lands in state. Both feed the same `makeAssistantDataUI` renderers.
772
-
773
- The live path requires the graph's `streamMode` to include `"custom"` so the UI events reach the client.
774
-
775
- ## Errors
776
-
777
- `useLangChainError` exposes the last run or hydration error from upstream `useStream().error`. It is untyped (`unknown`), so narrow it at the use site before rendering.
778
-
779
- ```tsx
780
- import { useLangChainError } from "@assistant-ui/react-langchain";
781
-
782
- function ErrorBanner() {
783
- const error = useLangChainError();
784
- if (!error) return null;
785
- return <div role="alert">{error instanceof Error ? error.message : String(error)}</div>;
786
- }
787
- ```
788
-
789
- ## Message conversion
790
-
791
- `convertLangChainBaseMessage` transforms a LangChain `BaseMessage` into an assistant-ui message. Use it when building a custom `ExternalStoreAdapter` that consumes LangChain messages outside `useStreamRuntime`.
792
-
793
- ```ts
794
- import { convertLangChainBaseMessage } from "@assistant-ui/react-langchain";
795
- ```
796
-
797
- ## Cloud persistence
798
-
799
- Pass an `AssistantCloud` instance to persist threads across sessions. The runtime automatically wires thread list management and resumes state from the cloud.
800
-
801
- ```tsx
802
- // see "AssistantCloud" in /docs/runtimes/concepts/threads for cloud setup
803
- const runtime = useStreamRuntime({
804
- cloud,
805
- assistantId: "agent",
806
- apiUrl: "http://localhost:2024",
807
- });
808
- ```
809
-
810
- ## Custom `messagesKey`
811
-
812
- If your graph stores messages under a non-default key, pass `messagesKey` so the runtime submits tool results and human turns to the correct state slot:
813
-
814
- ```tsx
815
- const runtime = useStreamRuntime({
816
- assistantId: "agent",
817
- apiUrl: "http://localhost:2024",
818
- messagesKey: "chat_messages",
819
- });
820
- ```
821
-
822
- ## Comparison with `react-langgraph`
823
-
824
- Both packages connect assistant-ui to LangGraph backends. They are independent adapters for different upstream libraries; one is not a successor to the other. The official `create-assistant-ui` template (`-t langchain`) ships `react-langchain`. The two are now at feature parity; `react-langgraph` remains the choice for a fully custom backend stream or an existing `react-langgraph` app.
825
-
826
- | Aspect | `react-langgraph` | `react-langchain` |
827
- | --- | --- | --- |
828
- | Wraps | `@langchain/langgraph-sdk` (raw SDK) | `@langchain/react` (`useStream` hook) |
829
- | Age | Sept 2024 onward | April 2026 onward |
830
- | Version | `0.13.x` | `0.0.x` |
831
- | Lines of source | ~7,500 | ~600 |
832
- | Built on | `useExternalStoreRuntime` | `useExternalStoreRuntime` |
833
- | `create-assistant-ui` template | No template | `-t langchain` |
834
-
835
- ### Feature coverage
836
-
837
- | Feature | `react-langgraph` | `react-langchain` |
838
- | --- | --- | --- |
839
- | Stream messages | Yes (`useLangGraphRuntime`) | Yes (`useStreamRuntime`) |
840
- | Interrupt state | Yes | Yes |
841
- | Thread history loading state (`thread.isLoading`) | Yes | Yes |
842
- | Send raw state update / resume command | Yes | Yes (`useLangChainSubmit`; `useLangChainRespond` for payload resume) |
843
- | Forward per-run `runConfig` | Yes (whole object → `config`) | Yes (`custom` → `config.configurable`) |
844
- | Read arbitrary custom state key | No | Yes (`useLangChainState<T>(key)`) |
845
- | Root tool-calls projection | Via message parts | Yes (`useLangChainToolCalls`) |
846
- | File content parts in messages | Yes | Yes |
847
- | Regenerate (checkpoint fork) | Yes (`getCheckpointId`) | Yes (auto-resolved) |
848
- | Edit message (checkpoint fork) | Yes | Yes (auto-resolved) |
849
- | Per-message metadata (`messages-tuple`) | Yes | Yes (`useMessageMetadata` via `useLangChainStream`) |
850
- | Multimodal media (audio/image/video/file) | Via parts | Yes (v1 media hooks via `useLangChainStream`) |
851
- | Generative UI (state snapshot) | Yes | Yes (`uiStateKey`) |
852
- | Generative UI (live `push_ui_message`) | Yes | Yes (`streamMode: ["custom"]`) |
853
- | Subgraph / namespaced stream events | Yes (via `eventHandlers`) | Replaced by `useLangChainSubagents` / `useLangChainSubgraphs` + views |
854
- | Subagent discovery | Via `eventHandlers` | Yes (`useLangChainSubagents`) |
855
- | Subgraph discovery | Via `eventHandlers` | Yes (`useLangChainSubgraphs`) |
856
- | Subagent/subgraph message views | Via `eventHandlers` | Yes (via `useLangChainStream` + v1 selector hooks) |
857
- | End-to-end cancellation primitive | Yes (`unstable_createLangGraphStream`) | n/a — cancellation via `useStream().stop()` (Cancel button on by default) |
858
- | Message accumulator utility | Yes (`LangGraphMessageAccumulator`) | n/a — `useStream` owns accumulation |
859
- | Streaming timing (per-message) | Yes | Yes |
860
- | Cloud thread persistence | Yes | Yes |
861
-
862
- Per-message streaming timing is attached automatically to `message.metadata.timing` (no setup), matching `react-langgraph`. It captures time-to-first-token, total stream time, chunk count, and tokens/sec, computed from message growth while the run is in flight.
863
-
864
- `react-langchain` is the newer, thinner wrapper. It delegates to upstream `useStream` rather than re-implementing the stream plumbing, which is why its footprint is smaller.
865
-
866
- Regenerate works without configuration. Clicking regenerate resolves the server checkpoint to fork from (the checkpoint each message records as it streams in, falling back to a `stream.client.threads.getHistory(threadId)` id match for older turns), then re-runs with `submit(null, { forkFrom })`. It works on checkpoint-enabled backends (for example LangGraph Cloud) and degrades gracefully; when no checkpoint resolves the regenerate is a no-op. `react-langgraph` instead requires a user-supplied `getCheckpointId` callback. Editing a message forks from the same checkpoint and submits the edited human content instead of re-running the prior turn; editing the first message forks from the thread's initial checkpoint to restart it.
867
-
868
- ### Hook name mapping
869
-
870
- | `react-langgraph` | `react-langchain` | Notes |
871
- | --- | --- | --- |
872
- | `useLangGraphRuntime` | `useStreamRuntime` | Options extend upstream `UseStreamOptions`; no `stream` / `create` / `load` to write. |
873
- | `useLangGraphInterruptState` | `useLangChainInterruptState` | Same return shape. |
874
- | `useLangGraphSendCommand` | `useLangChainRespond` | Preferred resume; carries a payload via `stream.respond`. For a raw `Command`, use `useLangChainSubmit(null, { command })`. |
875
- | `useLangGraphSend` | _(use `runtime.thread.append`)_ | No direct equivalent; send turns through the runtime. |
876
- | `useLangGraphMessageMetadata` | _(use `useMessageMetadata(useLangChainStream(), id)`)_ | Per-message metadata via the upstream selector hook. |
877
- | `useLangGraphUIMessages` | _(UI renders as data parts; register with `makeAssistantDataUI`)_ | See [Generative UI](#generative-ui). |
878
- | _(none)_ | `useLangChainState<T>(key)` | New — reads any custom state key reactively. |
879
- | _(none)_ | `useLangChainToolCalls` | New — root tool calls assembled by `useStream`. |
880
- | _(none)_ | `useLangChainError()` | New — reads the last run/hydration error reactively. |
881
- | _(none)_ | `useLangChainRespondAll` | Resume multiple interrupts at one checkpoint (`stream.respondAll`). |
882
- | _(none)_ | `useLangChainInterrupts` | New — every interrupt pending at the checkpoint, each with `id` and `value`. |
883
- | _(via `eventHandlers`)_ | `useLangChainSubagents` | New — subagents discovered on the current run; replaces subgraph event handlers. |
884
- | _(via `eventHandlers`)_ | `useLangChainSubgraphs` | New — subgraphs discovered on the current run; replaces subgraph event handlers. |
885
- | _(none)_ | `useLangChainStream` | New — the raw `useStream` handle for v1's scoped `useMessages` / `useToolCalls` selector hooks. |
886
-
887
- ## Related
888
-
889
- <Cards>
890
- <Card
891
- icon={<LangGraphIcon width={20} height={20} className="text-[#1C3C3C] dark:text-[#5b9595]" />}
892
- title="LangGraph"
893
- description="The original LangGraph adapter, built on the raw SDK."
894
- href="/docs/runtimes/langgraph/overview"
895
- />
896
- <Card
897
- title="ExternalStoreRuntime"
898
- description="The core runtime react-langchain is built on."
899
- href="/docs/runtimes/custom/external-store"
900
- />
901
- </Cards>