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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (247) hide show
  1. package/.docs/organized/code-examples/waterfall.md +8 -8
  2. package/.docs/organized/code-examples/with-a2a.md +10 -10
  3. package/.docs/organized/code-examples/with-ag-ui.md +11 -11
  4. package/.docs/organized/code-examples/with-ai-sdk-v6.md +13 -13
  5. package/.docs/organized/code-examples/with-artifacts.md +13 -13
  6. package/.docs/organized/code-examples/with-assistant-transport.md +10 -10
  7. package/.docs/organized/code-examples/with-browser-extension.md +345 -0
  8. package/.docs/organized/code-examples/with-chain-of-thought.md +54 -17
  9. package/.docs/organized/code-examples/with-cloud-standalone.md +13 -13
  10. package/.docs/organized/code-examples/with-cloud.md +13 -13
  11. package/.docs/organized/code-examples/with-custom-thread-list.md +13 -13
  12. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +17 -16
  13. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +17 -16
  14. package/.docs/organized/code-examples/with-expo.md +24 -24
  15. package/.docs/organized/code-examples/with-external-store.md +10 -10
  16. package/.docs/organized/code-examples/with-ffmpeg.md +13 -13
  17. package/.docs/organized/code-examples/with-generative-ui.md +210 -13
  18. package/.docs/organized/code-examples/with-google-adk.md +10 -10
  19. package/.docs/organized/code-examples/with-heat-graph.md +8 -8
  20. package/.docs/organized/code-examples/with-image-generation.md +454 -0
  21. package/.docs/organized/code-examples/with-interactables.md +13 -13
  22. package/.docs/organized/code-examples/with-langchain.md +12 -12
  23. package/.docs/organized/code-examples/with-langgraph.md +15 -12
  24. package/.docs/organized/code-examples/with-livekit.md +18 -17
  25. package/.docs/organized/code-examples/with-mcp.md +748 -0
  26. package/.docs/organized/code-examples/with-opencode.md +11 -11
  27. package/.docs/organized/code-examples/with-parent-id-grouping.md +11 -11
  28. package/.docs/organized/code-examples/with-react-hook-form.md +14 -14
  29. package/.docs/organized/code-examples/with-react-ink.md +4 -4
  30. package/.docs/organized/code-examples/with-react-router.md +15 -15
  31. package/.docs/organized/code-examples/with-resumable-stream.md +660 -0
  32. package/.docs/organized/code-examples/with-store.md +8 -8
  33. package/.docs/organized/code-examples/with-tanstack.md +14 -14
  34. package/.docs/organized/code-examples/with-tap-runtime.md +11 -10
  35. package/.docs/raw/docs/(docs)/cli.mdx +1 -0
  36. package/.docs/raw/docs/(docs)/index.mdx +2 -2
  37. package/.docs/raw/docs/(docs)/installation.mdx +1 -1
  38. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +26 -24
  39. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
  40. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +20 -12
  41. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
  42. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +37 -16
  43. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +12 -23
  44. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
  45. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
  46. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +11 -9
  47. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
  48. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
  49. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
  50. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +36 -0
  51. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
  52. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +18 -13
  53. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +18 -57
  54. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
  55. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +15 -28
  56. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +64 -18
  57. package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +434 -0
  58. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
  59. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +11 -12
  60. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +79 -0
  61. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +52 -0
  62. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
  63. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
  64. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +110 -131
  65. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
  66. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
  67. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +39 -20
  68. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
  69. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
  70. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
  71. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
  72. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
  73. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
  74. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +29 -24
  75. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
  76. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +175 -591
  77. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
  78. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
  79. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
  80. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
  81. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
  82. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +77 -96
  83. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -349
  84. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
  85. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
  86. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
  87. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +18 -13
  88. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
  89. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
  90. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
  91. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
  92. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -47
  93. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
  94. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +68 -0
  95. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
  96. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +79 -0
  97. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
  98. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +92 -0
  99. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
  100. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
  101. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
  102. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
  103. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +131 -0
  104. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
  105. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
  106. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
  107. package/.docs/raw/docs/cloud/ai-sdk.mdx +1 -1
  108. package/.docs/raw/docs/cloud/index.mdx +2 -2
  109. package/.docs/raw/docs/guides/attachments.mdx +4 -4
  110. package/.docs/raw/docs/guides/branching.mdx +1 -1
  111. package/.docs/raw/docs/guides/chain-of-thought.mdx +5 -5
  112. package/.docs/raw/docs/guides/context-api.mdx +4 -4
  113. package/.docs/raw/docs/guides/dictation.mdx +2 -2
  114. package/.docs/raw/docs/guides/editing.mdx +1 -1
  115. package/.docs/raw/docs/guides/generative-ui.mdx +142 -0
  116. package/.docs/raw/docs/guides/image-generation.mdx +74 -0
  117. package/.docs/raw/docs/guides/index.mdx +2 -2
  118. package/.docs/raw/docs/guides/interactables.mdx +2 -2
  119. package/.docs/raw/docs/guides/latex.mdx +2 -2
  120. package/.docs/raw/docs/guides/mcp-apps.mdx +231 -0
  121. package/.docs/raw/docs/guides/mentions.mdx +2 -2
  122. package/.docs/raw/docs/guides/message-timing.mdx +38 -5
  123. package/.docs/raw/docs/guides/multi-agent.mdx +2 -2
  124. package/.docs/raw/docs/guides/quoting.mdx +1 -1
  125. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
  126. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
  127. package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
  128. package/.docs/raw/docs/guides/slash-commands.mdx +1 -1
  129. package/.docs/raw/docs/guides/speech.mdx +2 -2
  130. package/.docs/raw/docs/guides/suggestions.mdx +88 -4
  131. package/.docs/raw/docs/guides/tool-ui.mdx +2 -2
  132. package/.docs/raw/docs/guides/tools.mdx +66 -5
  133. package/.docs/raw/docs/guides/voice.mdx +2 -2
  134. package/.docs/raw/docs/ink/adapters.mdx +37 -1
  135. package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
  136. package/.docs/raw/docs/ink/index.mdx +10 -11
  137. package/.docs/raw/docs/ink/primitives.mdx +349 -8
  138. package/.docs/raw/docs/integrations/auth/better-auth.mdx +1 -1
  139. package/.docs/raw/docs/integrations/auth/clerk.mdx +1 -1
  140. package/.docs/raw/docs/integrations/auth/next-auth.mdx +1 -1
  141. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +2 -2
  142. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
  143. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +2 -2
  144. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +1 -1
  145. package/.docs/raw/docs/integrations/gateways/index.mdx +9 -4
  146. package/.docs/raw/docs/integrations/index.mdx +15 -3
  147. package/.docs/raw/docs/integrations/observability/langfuse.mdx +8 -1
  148. package/.docs/raw/docs/integrations/observability/langsmith.mdx +8 -4
  149. package/.docs/raw/docs/integrations/tools/react-mcp.mdx +337 -0
  150. package/.docs/raw/docs/primitives/composer.mdx +53 -0
  151. package/.docs/raw/docs/primitives/index.mdx +2 -2
  152. package/.docs/raw/docs/primitives/suggestion.mdx +9 -0
  153. package/.docs/raw/docs/react-native/hooks.mdx +2 -2
  154. package/.docs/raw/docs/react-native/index.mdx +4 -4
  155. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +4 -4
  156. package/.docs/raw/docs/runtimes/a2a/overview.mdx +2 -2
  157. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +2 -2
  158. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +32 -1
  159. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +2 -2
  160. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +7 -2
  161. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +1 -1
  162. package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +7 -0
  163. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +27 -2
  164. package/.docs/raw/docs/runtimes/custom/external-store.mdx +9 -1
  165. package/.docs/raw/docs/runtimes/custom/overview.mdx +2 -2
  166. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +2 -2
  167. package/.docs/raw/docs/runtimes/langchain.mdx +2 -2
  168. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +2 -2
  169. package/.docs/raw/docs/runtimes/opencode/overview.mdx +2 -2
  170. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +1 -1
  171. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +12 -5
  172. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +11 -1
  173. package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
  174. package/.docs/raw/docs/ui/model-selector.mdx +8 -8
  175. package/.docs/raw/docs/ui/sources.mdx +17 -0
  176. package/.docs/raw/docs/ui/streamdown.mdx +34 -2
  177. package/.docs/raw/docs/ui/thread-list.mdx +2 -2
  178. package/.docs/raw/docs/ui/thread.mdx +2 -2
  179. package/README.md +14 -72
  180. package/dist/constants.d.ts +12 -9
  181. package/dist/constants.d.ts.map +1 -1
  182. package/dist/constants.js +13 -9
  183. package/dist/constants.js.map +1 -1
  184. package/dist/index.d.ts +7 -3
  185. package/dist/index.d.ts.map +1 -1
  186. package/dist/index.js +25 -24
  187. package/dist/index.js.map +1 -1
  188. package/dist/prepare-docs/code-examples.d.ts +4 -1
  189. package/dist/prepare-docs/code-examples.d.ts.map +1 -1
  190. package/dist/prepare-docs/code-examples.js +109 -121
  191. package/dist/prepare-docs/code-examples.js.map +1 -1
  192. package/dist/prepare-docs/copy-raw.d.ts +4 -1
  193. package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
  194. package/dist/prepare-docs/copy-raw.js +45 -42
  195. package/dist/prepare-docs/copy-raw.js.map +1 -1
  196. package/dist/prepare-docs/prepare.d.ts +1 -2
  197. package/dist/prepare-docs/prepare.js +17 -17
  198. package/dist/prepare-docs/prepare.js.map +1 -1
  199. package/dist/stdio.d.ts +1 -3
  200. package/dist/stdio.js +6 -3
  201. package/dist/stdio.js.map +1 -1
  202. package/dist/tools/docs.d.ts +20 -15
  203. package/dist/tools/docs.d.ts.map +1 -1
  204. package/dist/tools/docs.js +140 -161
  205. package/dist/tools/docs.js.map +1 -1
  206. package/dist/tools/examples.d.ts +20 -15
  207. package/dist/tools/examples.d.ts.map +1 -1
  208. package/dist/tools/examples.js +74 -86
  209. package/dist/tools/examples.js.map +1 -1
  210. package/dist/tools/tests/test-setup.d.ts +5 -2
  211. package/dist/tools/tests/test-setup.d.ts.map +1 -1
  212. package/dist/tools/tests/test-setup.js +21 -28
  213. package/dist/tools/tests/test-setup.js.map +1 -1
  214. package/dist/utils/logger.d.ts +8 -5
  215. package/dist/utils/logger.d.ts.map +1 -1
  216. package/dist/utils/logger.js +17 -17
  217. package/dist/utils/logger.js.map +1 -1
  218. package/dist/utils/mcp-format.d.ts +8 -5
  219. package/dist/utils/mcp-format.d.ts.map +1 -1
  220. package/dist/utils/mcp-format.js +9 -9
  221. package/dist/utils/mcp-format.js.map +1 -1
  222. package/dist/utils/mdx.d.ts +8 -6
  223. package/dist/utils/mdx.d.ts.map +1 -1
  224. package/dist/utils/mdx.js +22 -22
  225. package/dist/utils/mdx.js.map +1 -1
  226. package/dist/utils/paths.d.ts +9 -6
  227. package/dist/utils/paths.d.ts.map +1 -1
  228. package/dist/utils/paths.js +66 -76
  229. package/dist/utils/paths.js.map +1 -1
  230. package/dist/utils/security.d.ts +4 -1
  231. package/dist/utils/security.d.ts.map +1 -1
  232. package/dist/utils/security.js +19 -40
  233. package/dist/utils/security.js.map +1 -1
  234. package/package.json +5 -5
  235. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback-speech.mdx +0 -41
  236. package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
  237. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
  238. package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
  239. package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
  240. package/dist/prepare-docs/prepare.d.ts.map +0 -1
  241. package/dist/stdio.d.ts.map +0 -1
  242. /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
  243. /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
  244. /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
  245. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
  246. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
  247. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-14.mdx +0 -0
@@ -1,103 +0,0 @@
1
- ---
2
- title: "@assistant-ui/react-hook-form"
3
- description: React Hook Form integration for AI-assisted form filling.
4
- ---
5
-
6
- A React Hook Form integration for @assistant-ui.
7
-
8
-
9
- ## API Reference
10
-
11
- ### `useAssistantForm`
12
-
13
- Drop-in replacement hook for `useForm` that adds support for `@assistant-ui/react`.
14
-
15
- ```diff
16
- - import { useForm } from "react-hook-form";
17
- + import { useAssistantForm } from "@assistant-ui/react-hook-form";
18
-
19
- - useForm({
20
- + useAssistantForm({
21
- ...
22
- });
23
- ```
24
-
25
- #### Properties
26
-
27
- <ParametersTable
28
- type="UseAssistantFormProps"
29
- parameters={[
30
- {
31
- name: "assistant",
32
- type: "object",
33
- optional: true,
34
- description: "Configuration for useAssistantForm",
35
- children: [
36
- {
37
- parameters: [
38
- {
39
- name: "tools",
40
- type: "object",
41
- description: "Tools configuration for useAssistantForm",
42
- children: [
43
- {
44
- parameters: [
45
- {
46
- name: "set_form_field",
47
- type: "object",
48
- description: "Configuration for the set_form_field tool",
49
- children: [
50
- {
51
- parameters: [
52
- {
53
- name: "render",
54
- type: "ToolCallMessagePartComponent<{ name: string; value: string; }, {}>",
55
- description:
56
- "The component to render when set_form_field is called.",
57
- },
58
- ],
59
- },
60
- ],
61
- },
62
- {
63
- name: "submit_form",
64
- type: "object",
65
- description: "Configuration for the submit_form tool",
66
- children: [
67
- {
68
- parameters: [
69
- {
70
- name: "render",
71
- type: "ToolCallMessagePartComponent<{}, {}>",
72
- description:
73
- "The component to render when submit_form is called.",
74
- },
75
- ],
76
- },
77
- ],
78
- },
79
- ],
80
- },
81
- ],
82
- },
83
- ],
84
- },
85
- ],
86
- },
87
- ]}
88
- />
89
-
90
- ### `formTools`
91
-
92
- The set of tools to use with `useAssistantForm` on the server side. While the AI SDK now supports forwarding frontend tools via `frontendTools()`, using `formTools` directly on the server gives you more control over tool execution.
93
-
94
- ```tsx {1, 5-7}
95
- import { formTools } from "@assistant-ui/react-hook-form";
96
-
97
- const result = streamText({
98
- ...
99
- tools: {
100
- ...formTools,
101
- }
102
- });
103
- ```
@@ -1,254 +0,0 @@
1
- ---
2
- title: "@assistant-ui/react-ai-sdk"
3
- description: Vercel AI SDK integration with chat runtime hooks and transport utilities.
4
- ---
5
-
6
- Vercel AI SDK integration for assistant-ui.
7
-
8
-
9
- <Callout type="info">
10
- This package provides integration with AI SDK v6. For older versions, see the [AI
11
- SDK v5 (Legacy)](/docs/runtimes/ai-sdk/v5-legacy) or [AI SDK v4 (Legacy)](/docs/runtimes/ai-sdk/v4-legacy) documentation.
12
- </Callout>
13
-
14
- ## API Reference
15
-
16
- ### `useChatRuntime`
17
-
18
- Creates a runtime with AI SDK's `useChat` hook integration. This is the recommended approach for most use cases.
19
-
20
- ```tsx
21
- import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
22
- import { AssistantRuntimeProvider } from "@assistant-ui/react";
23
-
24
- const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
25
- const runtime = useChatRuntime({
26
- transport: new AssistantChatTransport({
27
- api: "/api/chat",
28
- }),
29
- });
30
-
31
- return (
32
- <AssistantRuntimeProvider runtime={runtime}>
33
- {children}
34
- </AssistantRuntimeProvider>
35
- );
36
- };
37
- ```
38
-
39
- To customize the API endpoint, simply change the `api` parameter:
40
-
41
- ```tsx
42
- const runtime = useChatRuntime({
43
- transport: new AssistantChatTransport({
44
- api: "/my-custom-api/chat",
45
- }),
46
- });
47
- ```
48
-
49
- <ParametersTable
50
- parameters={[
51
- {
52
- name: "options",
53
- type: "UseChatRuntimeOptions",
54
- description: "Configuration options for the chat runtime.",
55
- children: [
56
- {
57
- type: "UseChatRuntimeOptions",
58
- parameters: [
59
- {
60
- name: "transport",
61
- type: "ChatTransport",
62
- description:
63
- "Custom transport implementation. Defaults to AssistantChatTransport (which sends requests to '/api/chat' and forwards system messages and tools). Use `new AssistantChatTransport({ api: '/custom-endpoint' })` to customize the endpoint.",
64
- },
65
- {
66
- name: "cloud",
67
- type: "AssistantCloud",
68
- description:
69
- "Optional AssistantCloud instance for chat persistence.",
70
- },
71
- {
72
- name: "adapters",
73
- type: "RuntimeAdapters",
74
- description:
75
- "Optional runtime adapters to extend or override built-in functionality (attachments, speech, dictation, feedback, history).",
76
- },
77
- {
78
- name: "toCreateMessage",
79
- type: "(message: AppendMessage) => CreateUIMessage",
80
- description:
81
- "Optional custom function to convert an AppendMessage into an AI SDK CreateUIMessage before sending.",
82
- },
83
- {
84
- name: "initialMessages",
85
- type: "UIMessage[]",
86
- description: "Initial messages to populate the chat.",
87
- },
88
- {
89
- name: "onFinish",
90
- type: "(message: UIMessage) => void",
91
- description: "Callback when a message completes streaming.",
92
- },
93
- {
94
- name: "onError",
95
- type: "(error: Error) => void",
96
- description: "Callback for handling errors.",
97
- },
98
- ],
99
- },
100
- ],
101
- },
102
- ]}
103
- />
104
-
105
- <Callout type="info">
106
- By default, `useChatRuntime` uses `AssistantChatTransport` which automatically
107
- forwards system messages and frontend tools to your backend API. This enables
108
- your backend to receive the full context from the assistant-ui.
109
- </Callout>
110
-
111
- ### `useAISDKRuntime`
112
-
113
- For advanced use cases where you need direct access to the `useChat` hook from AI SDK.
114
-
115
- ```tsx
116
- import { useChat } from "@ai-sdk/react";
117
- import { useAISDKRuntime } from "@assistant-ui/react-ai-sdk";
118
- import { AssistantRuntimeProvider } from "@assistant-ui/react";
119
-
120
- const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
121
- const chat = useChat({
122
- api: "/api/chat",
123
- });
124
-
125
- const runtime = useAISDKRuntime(chat);
126
-
127
- return (
128
- <AssistantRuntimeProvider runtime={runtime}>
129
- {children}
130
- </AssistantRuntimeProvider>
131
- );
132
- };
133
- ```
134
-
135
- <ParametersTable
136
- parameters={[
137
- {
138
- name: "chat",
139
- type: "ReturnType<typeof useChat>",
140
- description: "The chat helpers from @ai-sdk/react's useChat hook.",
141
- },
142
- {
143
- name: "options",
144
- type: "AISDKRuntimeAdapter",
145
- description: "Optional configuration options.",
146
- children: [
147
- {
148
- type: "AISDKRuntimeAdapter",
149
- parameters: [
150
- {
151
- name: "adapters",
152
- type: "RuntimeAdapters",
153
- description:
154
- "Optional runtime adapters for attachments, feedback, speech, etc.",
155
- },
156
- ],
157
- },
158
- ],
159
- },
160
- ]}
161
- />
162
-
163
- ### `AssistantChatTransport`
164
-
165
- A transport that extends the default AI SDK transport to automatically forward system messages and frontend tools to your backend.
166
-
167
- ```tsx
168
- import { AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
169
- import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
170
-
171
- const runtime = useChatRuntime({
172
- transport: new AssistantChatTransport({
173
- api: "/my-custom-api/chat",
174
- }),
175
- });
176
- ```
177
-
178
- <ParametersTable
179
- parameters={[
180
- {
181
- name: "options",
182
- type: "HttpChatTransportInitOptions",
183
- description: "Transport configuration options.",
184
- children: [
185
- {
186
- type: "HttpChatTransportInitOptions",
187
- parameters: [
188
- {
189
- name: "api",
190
- type: "string",
191
- description: "The API endpoint URL.",
192
- },
193
- {
194
- name: "headers",
195
- type: "Record<string, string> | Headers",
196
- description: "Optional headers to include in requests.",
197
- },
198
- {
199
- name: "credentials",
200
- type: "RequestCredentials",
201
- description: "Optional credentials mode for fetch requests.",
202
- },
203
- ],
204
- },
205
- ],
206
- },
207
- ]}
208
- />
209
-
210
- ### `frontendTools`
211
-
212
- Helper function to convert frontend tool definitions to AI SDK format for use in your backend.
213
-
214
- ```tsx
215
- import { frontendTools } from "@assistant-ui/react-ai-sdk";
216
- import { streamText, convertToModelMessages } from "ai";
217
- import { openai } from "@ai-sdk/openai";
218
-
219
- export async function POST(req: Request) {
220
- const { messages, system, tools } = await req.json();
221
-
222
- const result = streamText({
223
- model: openai("gpt-4o"),
224
- system,
225
- messages: await convertToModelMessages(messages),
226
- tools: {
227
- // Wrap frontend tools with the helper
228
- ...frontendTools(tools),
229
- // Your backend tools
230
- myBackendTool: tool({
231
- // ...
232
- }),
233
- },
234
- });
235
-
236
- return result.toUIMessageStreamResponse();
237
- }
238
- ```
239
-
240
- <ParametersTable
241
- parameters={[
242
- {
243
- name: "tools",
244
- type: "Record<string, unknown>",
245
- description:
246
- "Frontend tools object forwarded from AssistantChatTransport.",
247
- },
248
- ]}
249
- />
250
-
251
- <Callout type="info">
252
- The `frontendTools` helper converts frontend tool definitions to the AI SDK
253
- format and ensures they are properly handled by the streaming response.
254
- </Callout>
@@ -1 +0,0 @@
1
- {"version":3,"file":"prepare.d.ts","sourceRoot":"","sources":["../../src/prepare-docs/prepare.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"stdio.d.ts","sourceRoot":"","sources":["../src/stdio.ts"],"names":[],"mappings":""}