@assistant-ui/mcp-docs-server 0.1.36 → 0.1.39

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 (246) hide show
  1. package/.docs/organized/code-examples/waterfall.md +8 -9
  2. package/.docs/organized/code-examples/with-a2a.md +16 -11
  3. package/.docs/organized/code-examples/with-ag-ui.md +16 -11
  4. package/.docs/organized/code-examples/{with-ai-sdk-v6.md → with-ai-sdk-v7.md} +32 -21
  5. package/.docs/organized/code-examples/with-artifacts.md +17 -10
  6. package/.docs/organized/code-examples/with-assistant-transport.md +15 -8
  7. package/.docs/organized/code-examples/with-browser-extension.md +15 -8
  8. package/.docs/organized/code-examples/with-chain-of-thought.md +17 -10
  9. package/.docs/organized/code-examples/with-cloud-standalone.md +10 -9
  10. package/.docs/organized/code-examples/with-cloud.md +18 -13
  11. package/.docs/organized/code-examples/with-custom-thread-list.md +17 -10
  12. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +20 -13
  13. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +20 -13
  14. package/.docs/organized/code-examples/with-eve.md +16 -9
  15. package/.docs/organized/code-examples/with-expo.md +26 -23
  16. package/.docs/organized/code-examples/with-external-store.md +16 -11
  17. package/.docs/organized/code-examples/with-ffmpeg.md +18 -13
  18. package/.docs/organized/code-examples/with-generative-ui.md +20 -15
  19. package/.docs/organized/code-examples/with-google-adk.md +16 -9
  20. package/.docs/organized/code-examples/with-heat-graph.md +8 -9
  21. package/.docs/organized/code-examples/with-image-generation.md +17 -10
  22. package/.docs/organized/code-examples/with-interactables.md +19 -15
  23. package/.docs/organized/code-examples/with-langchain.md +17 -10
  24. package/.docs/organized/code-examples/with-langgraph.md +17 -10
  25. package/.docs/organized/code-examples/with-livekit.md +21 -14
  26. package/.docs/organized/code-examples/with-mcp.md +40 -18
  27. package/.docs/organized/code-examples/with-opencode.md +22 -17
  28. package/.docs/organized/code-examples/with-pi.md +47 -12
  29. package/.docs/organized/code-examples/with-react-hook-form.md +19 -14
  30. package/.docs/organized/code-examples/with-react-ink-web.md +6 -6
  31. package/.docs/organized/code-examples/with-react-ink.md +2 -2
  32. package/.docs/organized/code-examples/with-react-router.md +20 -15
  33. package/.docs/organized/code-examples/with-resumable-stream.md +19 -12
  34. package/.docs/organized/code-examples/with-store.md +8 -9
  35. package/.docs/organized/code-examples/with-tanstack.md +17 -11
  36. package/.docs/organized/code-examples/with-tap-runtime.md +16 -11
  37. package/.docs/organized/code-examples/with-virtualized-thread.md +17 -12
  38. package/.docs/raw/docs/(docs)/base-ui.mdx +39 -0
  39. package/.docs/raw/docs/(docs)/cli.mdx +18 -2
  40. package/.docs/raw/docs/(docs)/installation.mdx +15 -1
  41. package/.docs/raw/docs/(docs)/rtl.mdx +2 -4
  42. package/.docs/raw/docs/(reference)/api-reference/generative-ui/actions.mdx +56 -0
  43. package/.docs/raw/docs/(reference)/api-reference/generative-ui/components.mdx +86 -0
  44. package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +19 -1
  45. package/.docs/raw/docs/(reference)/api-reference/generative-ui/json-generative-ui.mdx +42 -0
  46. package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +53 -2
  47. package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +81 -0
  48. package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +86 -0
  49. package/.docs/raw/docs/(reference)/api-reference/generative-ui/tokens.mdx +62 -0
  50. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +4 -1
  51. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +4 -2
  52. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +37 -0
  53. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +1 -0
  54. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +29 -29
  55. package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +1 -0
  56. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +3 -0
  57. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +2 -0
  58. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +0 -2
  59. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +12 -9
  60. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +4 -0
  61. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +7 -1
  62. package/.docs/raw/docs/cloud/langgraph.mdx +4 -2
  63. package/.docs/raw/docs/guides/chatgpt-subscription.mdx +108 -0
  64. package/.docs/raw/docs/guides/dictation.mdx +185 -257
  65. package/.docs/raw/docs/guides/index.mdx +10 -0
  66. package/.docs/raw/docs/guides/mentions.mdx +31 -3
  67. package/.docs/raw/docs/guides/resumable-streams.mdx +12 -1
  68. package/.docs/raw/docs/guides/speech.mdx +47 -29
  69. package/.docs/raw/docs/guides/suggestions.mdx +70 -1
  70. package/.docs/raw/docs/guides/voice.mdx +197 -267
  71. package/.docs/raw/docs/ink/primitives.mdx +35 -1
  72. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +13 -7
  73. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +3 -3
  74. package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +1 -1
  75. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +3 -3
  76. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +1 -1
  77. package/.docs/raw/docs/integrations/gateways/index.mdx +2 -2
  78. package/.docs/raw/docs/integrations/index.mdx +1 -1
  79. package/.docs/raw/docs/integrations/observability/helicone.mdx +1 -1
  80. package/.docs/raw/docs/integrations/observability/langfuse.mdx +1 -1
  81. package/.docs/raw/docs/integrations/observability/langsmith.mdx +3 -3
  82. package/.docs/raw/docs/migrations/index.mdx +50 -0
  83. package/.docs/raw/docs/migrations/react-langgraph-v0-7.mdx +2 -2
  84. package/.docs/raw/docs/migrations/toolkit-tools.mdx +4 -2
  85. package/.docs/raw/docs/primitives/chain-of-thought.mdx +6 -1
  86. package/.docs/raw/docs/primitives/composer.mdx +16 -0
  87. package/.docs/raw/docs/primitives/selection-toolbar.mdx +25 -0
  88. package/.docs/raw/docs/primitives/thread-list.mdx +30 -6
  89. package/.docs/raw/docs/react-native/primitives.mdx +23 -0
  90. package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +1 -1
  91. package/.docs/raw/docs/runtimes/ag-ui/agent-state.mdx +124 -0
  92. package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +1 -1
  93. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +13 -2
  94. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +13 -4
  95. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +11 -11
  96. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +5 -5
  97. package/.docs/raw/docs/runtimes/ai-sdk/{v6.mdx → v6-legacy.mdx} +8 -6
  98. package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +717 -0
  99. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +1 -1
  100. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +1 -1
  101. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +10 -19
  102. package/.docs/raw/docs/runtimes/custom/external-store.mdx +1 -1
  103. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +2 -0
  104. package/.docs/raw/docs/runtimes/eve/overview.mdx +1 -1
  105. package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +1 -1
  106. package/.docs/raw/docs/runtimes/langchain.mdx +2 -2
  107. package/.docs/raw/docs/runtimes/langgraph/agent-state.mdx +181 -0
  108. package/.docs/raw/docs/runtimes/opencode/hooks.mdx +1 -1
  109. package/.docs/raw/docs/tools/backend.mdx +6 -3
  110. package/.docs/raw/docs/tools/defining-tools.mdx +12 -1
  111. package/.docs/raw/docs/tools/generative-ui.mdx +95 -0
  112. package/.docs/raw/docs/tools/mcp-apps.mdx +37 -10
  113. package/.docs/raw/docs/tools/mcp.mdx +105 -3
  114. package/.docs/raw/docs/tools/tool-ui.mdx +6 -4
  115. package/.docs/raw/docs/tools/user-managed-mcp.mdx +41 -4
  116. package/.docs/raw/docs/ui/accordion.mdx +16 -10
  117. package/.docs/raw/docs/ui/assistant-modal.mdx +8 -4
  118. package/.docs/raw/docs/ui/attachment.mdx +5 -1
  119. package/.docs/raw/docs/ui/badge.mdx +23 -12
  120. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +80 -0
  121. package/.docs/raw/docs/ui/model-selector.mdx +69 -6
  122. package/.docs/raw/docs/ui/select.mdx +22 -14
  123. package/.docs/raw/docs/ui/sources.mdx +1 -1
  124. package/.docs/raw/docs/ui/tabs.mdx +25 -14
  125. package/.docs/raw/docs/utilities/heat-graph.mdx +2 -2
  126. package/README.md +1 -1
  127. package/dist/constants.d.ts +2 -1
  128. package/dist/constants.d.ts.map +1 -1
  129. package/dist/constants.js +2 -1
  130. package/dist/constants.js.map +1 -1
  131. package/dist/index.d.ts +0 -1
  132. package/dist/index.d.ts.map +1 -1
  133. package/dist/index.js +51 -0
  134. package/dist/index.js.map +1 -1
  135. package/dist/prepare-docs/code-examples.d.ts.map +1 -1
  136. package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
  137. package/dist/prepare-docs/copy-raw.js +0 -4
  138. package/dist/prepare-docs/copy-raw.js.map +1 -1
  139. package/dist/prompts/xulux-playground.d.ts +12 -0
  140. package/dist/prompts/xulux-playground.d.ts.map +1 -0
  141. package/dist/prompts/xulux-playground.js +33 -0
  142. package/dist/prompts/xulux-playground.js.map +1 -0
  143. package/dist/tools/docs.d.ts +2 -4
  144. package/dist/tools/docs.d.ts.map +1 -1
  145. package/dist/tools/docs.js +38 -10
  146. package/dist/tools/docs.js.map +1 -1
  147. package/dist/tools/examples.d.ts +5 -5
  148. package/dist/tools/examples.d.ts.map +1 -1
  149. package/dist/tools/examples.js +10 -7
  150. package/dist/tools/examples.js.map +1 -1
  151. package/dist/tools/resources.d.ts +6 -0
  152. package/dist/tools/resources.d.ts.map +1 -0
  153. package/dist/tools/resources.js +74 -0
  154. package/dist/tools/resources.js.map +1 -0
  155. package/dist/tools/search.d.ts +30 -0
  156. package/dist/tools/search.d.ts.map +1 -0
  157. package/dist/tools/search.js +39 -0
  158. package/dist/tools/search.js.map +1 -0
  159. package/dist/tools/tests/test-setup.d.ts.map +1 -1
  160. package/dist/tools/tests/test-setup.js +7 -1
  161. package/dist/tools/tests/test-setup.js.map +1 -1
  162. package/dist/tools/xulux-templates.d.ts +72 -0
  163. package/dist/tools/xulux-templates.d.ts.map +1 -0
  164. package/dist/tools/xulux-templates.js +82 -0
  165. package/dist/tools/xulux-templates.js.map +1 -0
  166. package/dist/utils/cache.d.ts +5 -0
  167. package/dist/utils/cache.d.ts.map +1 -0
  168. package/dist/utils/cache.js +18 -0
  169. package/dist/utils/cache.js.map +1 -0
  170. package/dist/utils/logger.d.ts.map +1 -1
  171. package/dist/utils/mcp-format.d.ts +1 -0
  172. package/dist/utils/mcp-format.d.ts.map +1 -1
  173. package/dist/utils/mcp-format.js +7 -4
  174. package/dist/utils/mcp-format.js.map +1 -1
  175. package/dist/utils/mdx.d.ts +2 -1
  176. package/dist/utils/mdx.d.ts.map +1 -1
  177. package/dist/utils/mdx.js +19 -2
  178. package/dist/utils/mdx.js.map +1 -1
  179. package/dist/utils/paths.d.ts +2 -1
  180. package/dist/utils/paths.d.ts.map +1 -1
  181. package/dist/utils/paths.js +20 -1
  182. package/dist/utils/paths.js.map +1 -1
  183. package/dist/utils/search.d.ts +10 -0
  184. package/dist/utils/search.d.ts.map +1 -0
  185. package/dist/utils/search.js +97 -0
  186. package/dist/utils/search.js.map +1 -0
  187. package/dist/utils/security.d.ts.map +1 -1
  188. package/dist/xulux/catalog-client.d.ts +14 -0
  189. package/dist/xulux/catalog-client.d.ts.map +1 -0
  190. package/dist/xulux/catalog-client.js +67 -0
  191. package/dist/xulux/catalog-client.js.map +1 -0
  192. package/dist/xulux/fallback-catalog.d.ts +7 -0
  193. package/dist/xulux/fallback-catalog.d.ts.map +1 -0
  194. package/dist/xulux/fallback-catalog.js +47 -0
  195. package/dist/xulux/fallback-catalog.js.map +1 -0
  196. package/dist/xulux/fetch-sandbox.d.ts +5 -0
  197. package/dist/xulux/fetch-sandbox.d.ts.map +1 -0
  198. package/dist/xulux/fetch-sandbox.js +40 -0
  199. package/dist/xulux/fetch-sandbox.js.map +1 -0
  200. package/dist/xulux/template-service.d.ts +84 -0
  201. package/dist/xulux/template-service.d.ts.map +1 -0
  202. package/dist/xulux/template-service.js +223 -0
  203. package/dist/xulux/template-service.js.map +1 -0
  204. package/dist/xulux/types.d.ts +55 -0
  205. package/dist/xulux/types.d.ts.map +1 -0
  206. package/dist/xulux/types.js +6 -0
  207. package/dist/xulux/types.js.map +1 -0
  208. package/package.json +5 -5
  209. package/src/constants.ts +2 -0
  210. package/src/index.ts +67 -0
  211. package/src/prepare-docs/copy-raw.ts +0 -5
  212. package/src/prompts/xulux-playground.ts +36 -0
  213. package/src/tools/docs.ts +52 -4
  214. package/src/tools/examples.ts +18 -11
  215. package/src/tools/resources.ts +114 -0
  216. package/src/tools/search.ts +46 -0
  217. package/src/tools/tests/completions.test.ts +46 -0
  218. package/src/tools/tests/directory-size-cap.test.ts +50 -0
  219. package/src/tools/tests/docs.test.ts +20 -0
  220. package/src/tools/tests/examples.test.ts +5 -5
  221. package/src/tools/tests/listings-cache.test.ts +19 -0
  222. package/src/tools/tests/mcp-protocol.test.ts +92 -1
  223. package/src/tools/tests/resources.test.ts +102 -0
  224. package/src/tools/tests/search.test.ts +37 -0
  225. package/src/tools/tests/test-setup.ts +10 -0
  226. package/src/tools/tests/xulux-templates.test.ts +262 -0
  227. package/src/tools/xulux-templates.ts +141 -0
  228. package/src/utils/cache.ts +20 -0
  229. package/src/utils/mcp-format.ts +8 -6
  230. package/src/utils/mdx.ts +21 -1
  231. package/src/utils/paths.ts +25 -0
  232. package/src/utils/search.ts +131 -0
  233. package/src/utils/tests/cache.test.ts +51 -0
  234. package/src/utils/tests/mcp-format.test.ts +22 -0
  235. package/src/utils/tests/security.test.ts +1 -1
  236. package/src/xulux/catalog-client.ts +105 -0
  237. package/src/xulux/fallback-catalog.ts +63 -0
  238. package/src/xulux/fetch-sandbox.ts +56 -0
  239. package/src/xulux/template-service.ts +406 -0
  240. package/src/xulux/types.ts +60 -0
  241. package/.docs/raw/blog/2024-07-29-hello/index.mdx +0 -64
  242. package/.docs/raw/blog/2024-09-11/index.mdx +0 -10
  243. package/.docs/raw/blog/2024-12-15/index.mdx +0 -10
  244. package/.docs/raw/blog/2025-01-31-changelog/index.mdx +0 -127
  245. package/.docs/raw/blog/2026-03-launch-week/index.mdx +0 -258
  246. package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +0 -464
@@ -0,0 +1,56 @@
1
+ ---
2
+ title: Generative UI Actions
3
+ description: "Register handlers for model-emitted $action payloads and dispatch them from interactive generative UI components."
4
+ ---
5
+
6
+ import { ActionDispatchContext, ActionRegistry, createActionRegistry } from "@/generated/typeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### ActionDispatchContext
18
+
19
+ Context handed to an [ActionHandler](/docs/api-reference/generative-ui/actions#actionhandler) when an `$action` fires.
20
+
21
+ <ParametersTable {...ActionDispatchContext} />
22
+
23
+ ### ActionHandler
24
+
25
+ Resolves a single `$action.type`. Fire-and-forget actions return `void` or a
26
+ promise that resolves to it; human-in-the-loop actions return a value the
27
+ runtime uses to resume the run (see IR doc Open question #2 — the resume
28
+ value is left as `unknown` and documented per-action). The return value is
29
+ handed back to `dispatch`'s caller as `unknown`.
30
+
31
+ ```ts
32
+ type ActionHandler = (
33
+ ctx: ActionDispatchContext,
34
+ ) => unknown | Promise<unknown>;
35
+ ```
36
+
37
+ ### ActionRegistry
38
+
39
+ The host-provided map from `$action.type` to [ActionHandler](/docs/api-reference/generative-ui/actions#actionhandler). This is the single dispatch target for rendered generative UI: every interactive component fires its `$action` here through the injected `$dispatch` (a submit Button defers to its ancestor form's dispatch instead). The payload's `$input` takes one of two shapes: a single value for a standalone control's dispatch (`Select`, `Input`, `DatePicker`, `Checkbox`, `RadioGroup`), or an object keyed by field `name` for a `Form` or a `Card` with `asForm` set. Construct it with [createActionRegistry](/docs/api-reference/generative-ui/actions#createactionregistry) and pass it to `JSONGenerativeUI`.
40
+
41
+ <ParametersTable {...ActionRegistry} />
42
+
43
+ ### createActionRegistry
44
+
45
+ <ParametersTable {...createActionRegistry} />
46
+
47
+ ### emptyActionRegistry
48
+
49
+ A no-op registry used when no handlers are provided. Dispatch resolves to
50
+ `undefined` and logs a warning in dev for unknown types, so a model-emitted
51
+ action with no handler degrades to "does nothing" rather than throwing.
52
+
53
+ ```ts
54
+ const emptyActionRegistry: ActionRegistry;
55
+ ```
56
+ {/* api-reference:end */}
@@ -0,0 +1,86 @@
1
+ ---
2
+ title: Generative UI Components
3
+ description: Define the component library JSONGenerativeUI can render, including schemas, render functions, and the default vocabulary.
4
+ ---
5
+
6
+ import { GenerativeUIComponent, defineGenerativeComponents } from "@/generated/typeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### defaultGenerativeUILibrary
18
+
19
+ The closed generative-ui vocabulary the factory ships: a fixed set of
20
+ intrinsic components the model may render, each a zod `properties` schema
21
+ plus an unstyled structural `render` (semantic HTML with a `data-aui`
22
+ attribute naming the component, plus `data-aui-<prop>` hooks, for the host
23
+ to style). Users opt in by passing it to
24
+ `new JSONGenerativeUI({ library: defaultGenerativeUILibrary })`, and override
25
+ or extend entries with their own `defineGenerativeComponents`.
26
+
27
+ ```ts
28
+ const defaultGenerativeUILibrary: GenerativeUILibrary;
29
+ ```
30
+
31
+ ### defineGenerativeComponents
32
+
33
+ Authoring helper for a `"use generative"` generative-UI library — the set of
34
+ components the model may render. Each component colocates its `properties`
35
+ schema (kept on every build, drives the tool parameters) with its `render`
36
+ (kept only on the client). Pass the result to [JSONGenerativeUI](/docs/api-reference/generative-ui/json-generative-ui#jsongenerativeui):
37
+
38
+ ```tsx
39
+ "use generative";
40
+ const generative = new JSONGenerativeUI({
41
+ library: defineGenerativeComponents({
42
+ Card: {
43
+ description: "A card.",
44
+ properties: z.object({ title: z.string() }),
45
+ render: (props) => <Card {...props} />,
46
+ },
47
+ }),
48
+ });
49
+ ```
50
+
51
+ Unlike [defineToolkit](/docs/api-reference/tools/toolkits#definetoolkit), it has **no runtime implementation**. A
52
+ `"use generative"` compiler unwraps the `defineGenerativeComponents(...)` call
53
+ per build, dropping each `render` (and its client-only imports) from the server
54
+ build. Reaching it at runtime means the module wasn't compiled (the directive
55
+ is missing, or it was used outside a `"use generative"` file), so it throws
56
+ rather than shipping client `render` code to the server.
57
+
58
+ <ParametersTable {...defineGenerativeComponents} />
59
+
60
+ ### GenerativeUIComponent
61
+
62
+ A component the model is allowed to render, with the schema for its props.
63
+
64
+ Components opt into prop streaming with `streamProperties`: they render as
65
+ props arrive, so `render` sees `Partial<P>` while `$status` is `"streaming"`
66
+ and the full `P` once it is `"done"`. By default a component opts out and is
67
+ only rendered once its props are complete.
68
+
69
+ `render` is a function of `props`, not a React component. Direct hook use is
70
+ fine (each node is mounted on its own fiber), but a given node must keep its
71
+ `type` across renders for hook identity to be stable.
72
+
73
+ <ParametersTable {...GenerativeUIComponent} />
74
+
75
+ ### GenerativeUILibrary
76
+
77
+ The consumer-provided allowlist of components the model is permitted to
78
+ render. Keys are the `type` values referenced in the generative-ui tree
79
+ (e.g. `"Card"`, `"Button"`); values describe each component.
80
+
81
+ This registry is the security boundary — any `type` not present is rejected.
82
+
83
+ ```ts
84
+ type GenerativeUILibrary = Record<string, GenerativeUIComponent>;
85
+ ```
86
+ {/* api-reference:end */}
@@ -9,10 +9,28 @@ description: Spec-driven generative UI for assistant-ui. The data format an assi
9
9
  ## Pages
10
10
 
11
11
  <Cards>
12
+ <Card title={"JSONGenerativeUI"} href={"/docs/api-reference/generative-ui/json-generative-ui"}>
13
+ {"Create present and prompt_user tools from a generative UI component library, with options for display mode and action dispatch."}
14
+ </Card>
15
+ <Card title={"Generative UI Components"} href={"/docs/api-reference/generative-ui/components"}>
16
+ {"Define the component library JSONGenerativeUI can render, including schemas, render functions, and the default vocabulary."}
17
+ </Card>
18
+ <Card title={"Generative UI Actions"} href={"/docs/api-reference/generative-ui/actions"}>
19
+ {"Register handlers for model-emitted $action payloads and dispatch them from interactive generative UI components."}
20
+ </Card>
12
21
  <Card title={"Generative UI Spec"} href={"/docs/api-reference/generative-ui/spec"}>
13
22
  {"The serializable node tree an assistant emits to describe generative UI. Covers the GenerativeUISpec format, its nodes, and the message part that carries the spec."}
14
23
  </Card>
15
24
  <Card title={"Generative UI Rendering"} href={"/docs/api-reference/generative-ui/rendering"}>
16
- {"Render a generative UI spec into React. The renderer resolves spec nodes against your component registry, and the error thrown when a component cannot be resolved."}
25
+ {"Render generative UI trees, build present-tool schemas, and inspect or serialize model-produced UI nodes."}
26
+ </Card>
27
+ <Card title={"Slack Block Kit"} href={"/docs/api-reference/generative-ui/slack"}>
28
+ {"Convert generative UI trees to Slack Block Kit payloads and decode block_actions interactions back into $action payloads."}
29
+ </Card>
30
+ <Card title={"Microsoft Teams"} href={"/docs/api-reference/generative-ui/teams"}>
31
+ {"Convert generative UI trees to Teams Adaptive Cards and decode Action.Submit payloads back into $action payloads."}
32
+ </Card>
33
+ <Card title={"Generative UI Tokens"} href={"/docs/api-reference/generative-ui/tokens"}>
34
+ {"Shared token arrays used by the default generative UI vocabulary for sizing, color, alignment, and component variants."}
17
35
  </Card>
18
36
  </Cards>
@@ -0,0 +1,42 @@
1
+ ---
2
+ title: JSONGenerativeUI
3
+ description: "Create present and prompt_user tools from a generative UI component library, with options for display mode and action dispatch."
4
+ ---
5
+
6
+ import { JSONGenerativeUI, JSONGenerativeUIOptions, PresentToolOptions } from "@/generated/typeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### JSONGenerativeUI
18
+
19
+ Client build of [JSONGenerativeUI](/docs/api-reference/generative-ui/json-generative-ui#jsongenerativeui), resolved through the package's
20
+ `default` export condition (browser and SSR).
21
+
22
+ `present` is a frontend tool that renders the model's `{ $type,...props }`
23
+ tree against the library and resolves immediately. `prompt_user` is a
24
+ human-in-the-loop tool: the model pauses and the rendered UI supplies the
25
+ result. Both draw the tree the same way, so they share one `render`. The
26
+ `actions` registry (if provided) is threaded into the render context so
27
+ interactive components can fire `$action` through `$dispatch`.
28
+
29
+ <ParametersTable {...JSONGenerativeUI} />
30
+
31
+ ### JSONGenerativeUIOptions
32
+
33
+ Options for [JSONGenerativeUI](/docs/api-reference/generative-ui/json-generative-ui#jsongenerativeui).
34
+
35
+ <ParametersTable {...JSONGenerativeUIOptions} />
36
+
37
+ ### PresentToolOptions
38
+
39
+ Options for [JSONGenerativeUI.present](/docs/api-reference/generative-ui/json-generative-ui#jsongenerativeui).
40
+
41
+ <ParametersTable {...PresentToolOptions} />
42
+ {/* api-reference:end */}
@@ -1,9 +1,9 @@
1
1
  ---
2
2
  title: Generative UI Rendering
3
- description: Render a generative UI spec into React. The renderer resolves spec nodes against your component registry, and the error thrown when a component cannot be resolved.
3
+ description: Render generative UI trees, build present-tool schemas, and inspect or serialize model-produced UI nodes.
4
4
  ---
5
5
 
6
- import { GenerativeUIRender, GenerativeUIRenderError } from "@/generated/typeDocs";
6
+ import { GenerativeUIRender, GenerativeUIRenderContext, GenerativeUIRenderError, buildPresentParameters, generativeUIToJSX, renderGenerativeUI } from "@/generated/typeDocs";
7
7
 
8
8
  {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
9
  {/* Do not edit manually. */}
@@ -14,6 +14,26 @@ import { GenerativeUIRender, GenerativeUIRenderError } from "@/generated/typeDoc
14
14
 
15
15
  ## API Reference
16
16
 
17
+ ### buildPresentParameters
18
+
19
+ Builds the JSON schema for the `present` tool from a [GenerativeUILibrary](/docs/api-reference/generative-ui/components#generativeuilibrary).
20
+
21
+ The model produces a node `{ $type, $key?,...props }` where `$type` selects
22
+ a component, the optional `$key` pins a stable identity for list items that
23
+ may reorder, and the rest are its props. The schema is a flat object: `$type`
24
+ is an enum of the component names, every component's props are merged into
25
+ one optional bag, and `children` recurses via `$defs` so the tree can nest.
26
+
27
+ It is intentionally flat rather than a per-`$type` discriminated union. Tool /
28
+ function-call schemas (OpenAI and others) require the top-level parameters to
29
+ be a plain object and reject a top-level `oneOf`/`anyOf`/`enum`. So props can't
30
+ be refined per `$type` at the root; the model is guided instead by `$type`'s
31
+ description (which lists each component) and each prop's own description. The
32
+ renderer validates nothing here — an unknown `$type` or stray prop is handled
33
+ at render time — so a looser schema only costs the model a hint, not safety.
34
+
35
+ <ParametersTable {...buildPresentParameters} />
36
+
17
37
  ### GenerativeUIRender
18
38
 
19
39
  Internal renderer. Resolves a [GenerativeUISpec](/docs/api-reference/generative-ui/spec#generativeuispec) against the consumer
@@ -22,6 +42,12 @@ allowlist. Used by `MessagePrimitive.GenerativeUI` and by
22
42
 
23
43
  <ParametersTable {...GenerativeUIRender} />
24
44
 
45
+ ### GenerativeUIRenderContext
46
+
47
+ The render context threaded through [renderGenerativeUI](/docs/api-reference/generative-ui/rendering#rendergenerativeui).
48
+
49
+ <ParametersTable {...GenerativeUIRenderContext} />
50
+
25
51
  ### GenerativeUIRenderError
26
52
 
27
53
  Thrown when a generative-ui spec references a component name that is not
@@ -30,4 +56,29 @@ boundary in the same-realm rendering path — there is no fallback by
30
56
  default. Pass `Fallback` to opt into a soft-fail UX.
31
57
 
32
58
  <ParametersTable {...GenerativeUIRenderError} />
59
+
60
+ ### generativeUIToJSX
61
+
62
+ Serializes a generative-UI node to a JSX-like string for display: the "view source" of a model-produced tree. The wire form `{ $type: "Weather", id: "x" }` becomes `<Weather id="x" />`, and nested `children` render between tags: `<Card title="Hi"><Text>hello</Text></Card>`. A model-provided `$key` becomes the JSX `key` attribute.
63
+
64
+ By default this is a faithful textual rendering, not a parser: text children are emitted verbatim (not HTML/JSX-escaped), so the result is meant to be shown, not re-parsed. Returns `""` for nodes that aren't renderable (no `$type` yet, `null`, booleans).
65
+
66
+ Pass `{ escape: true }` to make the output safe to paste back into JSX: any string child containing `<`, `>`, `&`, `{`, or `}` is emitted as a JSON-stringified expression (`{JSON.stringify(child)}`) instead of verbatim, while a string child with none of those characters still renders verbatim.
67
+
68
+ Pass `{ pretty: true }` to pretty-print nested element trees with two-space indentation, while pure text children stay on one line.
69
+
70
+ <ParametersTable {...generativeUIToJSX} />
71
+
72
+ ### renderGenerativeUI
73
+
74
+ Renders a generative-ui tree against a [GenerativeUILibrary](/docs/api-reference/generative-ui/components#generativeuilibrary).
75
+
76
+ The model emits each node as a flat object `{ $type,...props }`. We first
77
+ normalize that wire form into the canonical NormalizedUINode (with
78
+ `children` lifted to a reserved top-level key), then render: each `type` is
79
+ looked up in the library and its `props` are passed to the component's
80
+ `render(props, context)`, with `children` rendered recursively so components
81
+ can nest.
82
+
83
+ <ParametersTable {...renderGenerativeUI} />
33
84
  {/* api-reference:end */}
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: Slack Block Kit
3
+ description: "Convert generative UI trees to Slack Block Kit payloads and decode block_actions interactions back into $action payloads."
4
+ ---
5
+
6
+ import { FromSlackBlocksResult, SlackBlocksResult, SlackConversionWarning, ToSlackBlocksOptions, decodeBlockAction, fromSlackBlocks, toSlackBlocks } from "@/generated/typeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### decodeBlockAction
18
+
19
+ Decodes one structural entry from a Slack `block_actions` payload.
20
+ `$input` is reserved for the runtime selection: a `$input` key inside the
21
+ button's JSON `value` payload is dropped rather than spread into the result.
22
+
23
+ <ParametersTable {...decodeBlockAction} />
24
+
25
+ ### fromSlackBlocks
26
+
27
+ Converts Slack Block Kit JSON back into a generative-ui IR tree, inverting
28
+ [toSlackBlocks](/docs/api-reference/generative-ui/slack#toslackblocks). Accepts a blocks array or a `{ blocks }` wrapper;
29
+ malformed input resolves to an empty node list plus a warning, and an
30
+ unrecognized block or action element is skipped with a "dropped" warning.
31
+ Every array read along the way (blocks, fields, options, elements, cards,
32
+ rows, cells) is bounded to its site's cap before it is mapped over, so a
33
+ hostile array (sparse or proxied with a fabricated `length`) is clamped
34
+ with a "clamped" warning instead of stalling the event loop. Never throws.
35
+
36
+ The Slack shape is lossier than the IR, so some information cannot be
37
+ recovered: a context block's elements always decode as `Caption` (the
38
+ original `Badge` vs `Caption` distinction does not survive the round trip),
39
+ a button's `buttonStyle` is only recovered for the `primary`/`danger` Slack
40
+ styles, a native alert block's `title` and `description` merge into a
41
+ single `description` string, and a card's layout collapses to its `title`,
42
+ a flat `children` list (image, then text, then caption, in that order),
43
+ and `confirm`/`cancel` footer buttons. A section field's label and value
44
+ are split on the first `*`+newline delimiter, so a label or value that
45
+ itself contains that exact delimiter cannot be split back unambiguously.
46
+ A data-table cell that Slack carries as `raw_text` always decodes as a
47
+ string, even when its text is the stringified form of a boolean, since the
48
+ Slack shape does not distinguish a boolean from ordinary text.
49
+
50
+ <ParametersTable {...fromSlackBlocks} />
51
+
52
+ ### FromSlackBlocksResult
53
+
54
+ The IR nodes and non-fatal warnings produced by converting Slack Block Kit JSON back into generative UI.
55
+
56
+ <ParametersTable {...FromSlackBlocksResult} />
57
+
58
+ ### SlackBlocksResult
59
+
60
+ The blocks and non-fatal warnings produced by Slack conversion.
61
+
62
+ <ParametersTable {...SlackBlocksResult} />
63
+
64
+ ### SlackConversionWarning
65
+
66
+ A non-fatal downgrade reported during Slack conversion.
67
+
68
+ <ParametersTable {...SlackConversionWarning} />
69
+
70
+ ### toSlackBlocks
71
+
72
+ Converts a generative-UI tree into Slack Block Kit JSON and downgrade warnings.
73
+
74
+ <ParametersTable {...toSlackBlocks} />
75
+
76
+ ### ToSlackBlocksOptions
77
+
78
+ Options that select the target Slack surface.
79
+
80
+ <ParametersTable {...ToSlackBlocksOptions} />
81
+ {/* api-reference:end */}
@@ -0,0 +1,86 @@
1
+ ---
2
+ title: Microsoft Teams
3
+ description: "Convert generative UI trees to Teams Adaptive Cards and decode Action.Submit payloads back into $action payloads."
4
+ ---
5
+
6
+ import { AdaptiveCardResult, TeamsAttachmentsResult, TeamsConversionWarning, decodeSubmitData, toAdaptiveCard, toTeamsAttachments } from "@/generated/typeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### AdaptiveCardResult
18
+
19
+ The card and non-fatal warnings produced by [toAdaptiveCard](/docs/api-reference/generative-ui/teams#toadaptivecard).
20
+
21
+ <ParametersTable {...AdaptiveCardResult} />
22
+
23
+ ### decodeSubmitData
24
+
25
+ Decodes the merged `activity.value` object a Teams bot receives on
26
+ Action.Submit, inverting the `aui` envelope buildSubmitAction nests
27
+ the resume action under. Adaptive Cards fold every other same-card input's
28
+ value into the same submit object keyed by its `id`, so every top-level key
29
+ besides `aui` is collected into `$input` (omitted when there are none).
30
+ `aui` is reserved for the envelope: `toAdaptiveCard` renames any input
31
+ whose id would collide to an unused id derived from it before encoding, so
32
+ a same-card input value can never land on this key. `$input` and `type`
33
+ are reserved on the way out: a `$input` key inside the envelope payload is
34
+ dropped so the slot only ever reflects same-card input values, and the
35
+ envelope's own `type` wins over a payload key of the same name. Every
36
+ collected key (in `payload` or `$input`) is kept as an own data property of
37
+ the returned object, even a `__proto__` or `constructor` key, since the
38
+ object is always built by spreading and `Object.fromEntries` rather than by
39
+ keyed assignment. Envelope keys are read as own properties only, so
40
+ prototype-inherited `aui`, `type`, or `payload` values never dispatch.
41
+ Returns `undefined` for a missing or malformed `aui` envelope; never throws.
42
+
43
+ <ParametersTable {...decodeSubmitData} />
44
+
45
+ ### TeamsAttachmentsResult
46
+
47
+ The attachments and non-fatal warnings produced by [toTeamsAttachments](/docs/api-reference/generative-ui/teams#toteamsattachments).
48
+
49
+ <ParametersTable {...TeamsAttachmentsResult} />
50
+
51
+ ### TeamsConversionWarning
52
+
53
+ A non-fatal downgrade reported during Teams conversion.
54
+
55
+ <ParametersTable {...TeamsConversionWarning} />
56
+
57
+ ### toAdaptiveCard
58
+
59
+ Converts a generative-ui tree into a Microsoft Teams Adaptive Card and
60
+ non-fatal downgrade warnings. Sizes, weights, and colors map to Adaptive
61
+ Card's semantic enums rather than raw values. An Input/Select/RadioGroup/
62
+ Checkbox/DatePicker whose id would be the reserved RESERVED_INPUT_ID
63
+ is renamed with a warning (see `decodeSubmitData`). Never throws: an
64
+ unknown `$type` is skipped with a "dropped" warning, and a malformed input
65
+ resolves to an empty card plus a "dropped" warning instead of throwing.
66
+
67
+ <ParametersTable {...toAdaptiveCard} />
68
+
69
+ ### ToAdaptiveCardOptions
70
+
71
+ Options accepted by [toAdaptiveCard](/docs/api-reference/generative-ui/teams#toadaptivecard) and [toTeamsAttachments](/docs/api-reference/generative-ui/teams#toteamsattachments). Reserved for future extension; no options are currently defined.
72
+
73
+ ```ts
74
+ export interface ToAdaptiveCardOptions {}
75
+ ```
76
+
77
+ ### toTeamsAttachments
78
+
79
+ Converts a generative-ui tree into Teams bot-framework message attachments.
80
+ A root-level `Carousel` becomes one attachment per `Card` child (clamped to
81
+ CAROUSEL_ATTACHMENT_CAP) with `attachmentLayout: "carousel"`;
82
+ anything else converts through [toAdaptiveCard](/docs/api-reference/generative-ui/teams#toadaptivecard)'s engine into a
83
+ single attachment. Never throws.
84
+
85
+ <ParametersTable {...toTeamsAttachments} />
86
+ {/* api-reference:end */}
@@ -0,0 +1,62 @@
1
+ ---
2
+ title: Generative UI Tokens
3
+ description: Shared token arrays used by the default generative UI vocabulary for sizing, color, alignment, and component variants.
4
+ ---
5
+
6
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
7
+ {/* Do not edit manually. */}
8
+
9
+ {/* api-reference:start */}
10
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
11
+ {/* Do not edit this block manually. */}
12
+
13
+ ## API Reference
14
+
15
+ ### ALERT_TONES
16
+
17
+ ```ts
18
+ const ALERT_TONES: readonly ["info", "success", "warning", "danger"];
19
+ ```
20
+
21
+ ### ALIGNS
22
+
23
+ ```ts
24
+ const ALIGNS: readonly ["start", "center", "end"];
25
+ ```
26
+
27
+ ### BUTTON_STYLES
28
+
29
+ ```ts
30
+ const BUTTON_STYLES: readonly ["primary", "secondary", "outline", "ghost", "danger"];
31
+ ```
32
+
33
+ ### COLORS
34
+
35
+ ```ts
36
+ const COLORS: readonly ["emphasis", "secondary", "alpha-70", "white", "white-70", "white-50"];
37
+ ```
38
+
39
+ ### IMAGE_SIZE_TOKENS
40
+
41
+ ```ts
42
+ const IMAGE_SIZE_TOKENS: readonly ["sm", "md", "lg"];
43
+ ```
44
+
45
+ ### JUSTIFIES
46
+
47
+ ```ts
48
+ const JUSTIFIES: readonly ["start", "center", "end", "between"];
49
+ ```
50
+
51
+ ### TEXT_SIZES
52
+
53
+ ```ts
54
+ const TEXT_SIZES: readonly ["sm", "md", "lg", "xl", "2xl", "3xl"];
55
+ ```
56
+
57
+ ### WEIGHTS
58
+
59
+ ```ts
60
+ const WEIGHTS: readonly ["normal", "medium", "semibold", "bold"];
61
+ ```
62
+ {/* api-reference:end */}
@@ -7,7 +7,7 @@ description: Package-level APIs for connecting assistant-ui React to the Vercel
7
7
  {/* The page list is generated from exported APIs; edit only the manual prose slot. */}
8
8
 
9
9
  {/* api-manual:start */}
10
- Integration packages connect assistant-ui to adjacent React and AI ecosystems. Use this section when you need the exact hooks, options, and helper exports for a package such as `@assistant-ui/react-ai-sdk`, `@assistant-ui/cloud-ai-sdk`, or `@assistant-ui/eve`.
10
+ Integration packages connect assistant-ui to adjacent React and AI ecosystems. Use this section when you need the exact hooks, options, and helper exports for a package such as `@assistant-ui/react-ai-sdk`, `@assistant-ui/react-data-stream`, `@assistant-ui/cloud-ai-sdk`, or `@assistant-ui/eve`.
11
11
  {/* api-manual:end */}
12
12
 
13
13
  ## Pages
@@ -16,6 +16,9 @@ Integration packages connect assistant-ui to adjacent React and AI ecosystems. U
16
16
  <Card title={"@assistant-ui/react-ai-sdk"} href={"/docs/api-reference/integrations/react-ai-sdk"}>
17
17
  {"Vercel AI SDK runtime hooks, chat transports, and message conversion utilities for assistant-ui React applications."}
18
18
  </Card>
19
+ <Card title={"@assistant-ui/react-data-stream"} href={"/docs/api-reference/integrations/react-data-stream"}>
20
+ {"Data stream runtime hook and message conversion utilities for custom assistant-ui streaming backends."}
21
+ </Card>
19
22
  <Card title={"@assistant-ui/cloud-ai-sdk"} href={"/docs/api-reference/integrations/cloud-ai-sdk"}>
20
23
  {"Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes."}
21
24
  </Card>
@@ -24,14 +24,14 @@ import { reactAiSdk_AISDKToolkit, reactAiSdk_AssistantChatTransport, reactAiSdk_
24
24
 
25
25
  ### createResumableSessionStorage
26
26
 
27
- `sessionStorage`-backed storage for the pending resumable stream id.
27
+ `sessionStorage`-backed storage for the pending resumable stream id. See the [Resumable Streams](/docs/guides/resumable-streams) guide for end-to-end wiring.
28
28
 
29
29
  <ParametersTable {...reactAiSdk_createResumableSessionStorage} />
30
30
 
31
31
  ### frontendTools
32
32
 
33
33
  ```ts
34
- const frontendTools: (tools: Record<string, ToolJSONSchema>) => ToolSet;
34
+ const frontendTools: (tools: FrontendTools) => ToolSet;
35
35
  ```
36
36
 
37
37
  ### getThreadMessageTokenUsage
@@ -63,6 +63,8 @@ export async function POST(req: Request) {
63
63
 
64
64
  ### RESUMABLE_STREAM_ID_HEADER
65
65
 
66
+ Response header used by the [Resumable Streams](/docs/guides/resumable-streams) server and client wiring.
67
+
66
68
  ```ts
67
69
  const RESUMABLE_STREAM_ID_HEADER: "x-resumable-stream-id";
68
70
  ```
@@ -0,0 +1,37 @@
1
+ ---
2
+ title: "@assistant-ui/react-data-stream"
3
+ description: Data stream runtime hook and message conversion utilities for custom assistant-ui streaming backends.
4
+ ---
5
+
6
+ import { reactDataStream_toLanguageModelMessages, reactDataStream_useCloudRuntime, reactDataStream_useDataStreamRuntime } from "@/generated/integrationTypeDocs";
7
+
8
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
9
+ {/* Do not edit manually. */}
10
+
11
+ {/* api-reference:start */}
12
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
13
+ {/* Do not edit this block manually. */}
14
+
15
+ ## API Reference
16
+
17
+ ### useDataStreamRuntime
18
+
19
+ <ParametersTable {...reactDataStream_useDataStreamRuntime} />
20
+
21
+ ### toLanguageModelMessages
22
+
23
+ <Callout type="warn">
24
+ <strong>Deprecated.</strong> Use `toGenericMessages` from `assistant-stream` for framework-agnostic conversion.
25
+ This function is kept for AI SDK compatibility.
26
+ </Callout>
27
+
28
+ <ParametersTable {...reactDataStream_toLanguageModelMessages} />
29
+
30
+ ### useCloudRuntime
31
+
32
+ <Callout type="warn">
33
+ <strong>Deprecated.</strong> This is under active development and not yet ready for prod use.
34
+ </Callout>
35
+
36
+ <ParametersTable {...reactDataStream_useCloudRuntime} />
37
+ {/* api-reference:end */}
@@ -3,6 +3,7 @@ title: API Reference
3
3
  description: Complete assistant-ui React API reference for building AI chat UIs with primitives, hooks, runtimes, adapters, tools, transport, voice, and integrations.
4
4
  ---
5
5
 
6
+ {/* api-reference:skip-auto-generation */}
6
7
 
7
8
  import { Component, ContextLevel } from "./context";
8
9