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

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 (187) hide show
  1. package/.docs/organized/code-examples/waterfall.md +3 -3
  2. package/.docs/organized/code-examples/with-a2a.md +5 -4
  3. package/.docs/organized/code-examples/with-ag-ui.md +7 -6
  4. package/.docs/organized/code-examples/with-ai-sdk-v7.md +14 -13
  5. package/.docs/organized/code-examples/with-artifacts.md +12 -11
  6. package/.docs/organized/code-examples/with-assistant-transport.md +6 -5
  7. package/.docs/organized/code-examples/with-browser-extension.md +6 -6
  8. package/.docs/organized/code-examples/with-chain-of-thought.md +16 -14
  9. package/.docs/organized/code-examples/with-cloud-standalone.md +7 -7
  10. package/.docs/organized/code-examples/with-cloud.md +11 -10
  11. package/.docs/organized/code-examples/with-custom-thread-list.md +11 -10
  12. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +14 -13
  13. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +15 -14
  14. package/.docs/organized/code-examples/with-eve.md +6 -5
  15. package/.docs/organized/code-examples/with-expo.md +213 -36
  16. package/.docs/organized/code-examples/with-external-store.md +6 -5
  17. package/.docs/organized/code-examples/with-ffmpeg.md +11 -10
  18. package/.docs/organized/code-examples/with-generative-ui.md +263 -29
  19. package/.docs/organized/code-examples/with-google-adk.md +5 -4
  20. package/.docs/organized/code-examples/with-heat-graph.md +3 -3
  21. package/.docs/organized/code-examples/with-image-generation.md +8 -7
  22. package/.docs/organized/code-examples/with-interactables.md +11 -10
  23. package/.docs/organized/code-examples/with-langchain.md +10 -9
  24. package/.docs/organized/code-examples/with-langgraph.md +7 -6
  25. package/.docs/organized/code-examples/with-livekit.md +15 -14
  26. package/.docs/organized/code-examples/with-mcp.md +14 -12
  27. package/.docs/organized/code-examples/with-nuxt.md +511 -575
  28. package/.docs/organized/code-examples/with-opencode.md +4 -4
  29. package/.docs/organized/code-examples/with-openui.md +450 -0
  30. package/.docs/organized/code-examples/with-pi.md +6 -5
  31. package/.docs/organized/code-examples/with-react-hook-form.md +16 -13
  32. package/.docs/organized/code-examples/with-react-ink-web.md +65 -15
  33. package/.docs/organized/code-examples/with-react-ink.md +5 -4
  34. package/.docs/organized/code-examples/with-react-router.md +8 -7
  35. package/.docs/organized/code-examples/with-resumable-stream.md +13 -12
  36. package/.docs/organized/code-examples/with-store.md +3 -3
  37. package/.docs/organized/code-examples/with-svelte.md +415 -0
  38. package/.docs/organized/code-examples/with-sveltekit.md +1061 -0
  39. package/.docs/organized/code-examples/with-tanstack.md +10 -9
  40. package/.docs/organized/code-examples/with-tap-runtime.md +5 -4
  41. package/.docs/organized/code-examples/with-virtualized-thread.md +6 -5
  42. package/.docs/organized/code-examples/with-vue.md +2 -2
  43. package/.docs/raw/docs/{(docs) → (getting-started)}/cli.mdx +6 -1
  44. package/.docs/raw/docs/{(docs) → (getting-started)}/devtools.mdx +1 -1
  45. package/.docs/raw/docs/{(docs) → (getting-started)}/index.mdx +4 -2
  46. package/.docs/raw/docs/{(docs) → (getting-started)}/installation.mdx +26 -26
  47. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +6 -0
  48. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +1 -1
  49. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +6 -1
  50. package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +5 -1
  51. package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +9 -2
  52. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +2 -2
  53. package/.docs/raw/docs/(reference)/api-reference/integrations/{react-ai-sdk.mdx → ai-sdk.mdx} +43 -18
  54. package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +61 -2
  55. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +3 -3
  56. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +2 -2
  57. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +20 -2
  58. package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx +1 -1
  59. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +1 -1
  60. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +1 -1
  61. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +32 -1
  62. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +1 -1
  63. package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +10 -10
  64. package/.docs/raw/docs/cloud/ai-sdk.mdx +4 -2
  65. package/.docs/raw/docs/cloud/index.mdx +1 -1
  66. package/.docs/raw/docs/copilots/assistant-frame.mdx +19 -8
  67. package/.docs/raw/docs/guides/attachments.mdx +4 -4
  68. package/.docs/raw/docs/guides/branching.mdx +1 -1
  69. package/.docs/raw/docs/guides/chatgpt-subscription.mdx +1 -1
  70. package/.docs/raw/docs/guides/context-api.mdx +15 -17
  71. package/.docs/raw/docs/guides/dictation.mdx +2 -2
  72. package/.docs/raw/docs/guides/electron.mdx +1 -1
  73. package/.docs/raw/docs/guides/latex.mdx +1 -1
  74. package/.docs/raw/docs/guides/mentions.mdx +2 -0
  75. package/.docs/raw/docs/guides/message-timing.mdx +11 -5
  76. package/.docs/raw/docs/guides/quoting.mdx +1 -1
  77. package/.docs/raw/docs/guides/resumable-streams.mdx +3 -3
  78. package/.docs/raw/docs/guides/speech.mdx +1 -1
  79. package/.docs/raw/docs/guides/suggestions.mdx +8 -5
  80. package/.docs/raw/docs/guides/voice.mdx +1 -1
  81. package/.docs/raw/docs/ink/hooks.mdx +1 -1
  82. package/.docs/raw/docs/ink/index.mdx +3 -2
  83. package/.docs/raw/docs/ink/migration.mdx +1 -1
  84. package/.docs/raw/docs/ink/primitives.mdx +1 -1
  85. package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +3 -3
  86. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +3 -3
  87. package/.docs/raw/docs/integrations/frameworks/{cloudflare-agents/overview.mdx → cloudflare-agents.mdx} +4 -3
  88. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +1 -1
  89. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +1 -1
  90. package/.docs/raw/docs/integrations/index.mdx +2 -2
  91. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +149 -131
  92. package/.docs/raw/docs/migrations/toolkit-tools.mdx +2 -2
  93. package/.docs/raw/docs/migrations/v0-15.mdx +34 -0
  94. package/.docs/raw/docs/primitives/action-bar.mdx +1 -1
  95. package/.docs/raw/docs/primitives/assistant-modal.mdx +1 -1
  96. package/.docs/raw/docs/primitives/attachment.mdx +1 -1
  97. package/.docs/raw/docs/primitives/branch-picker.mdx +1 -1
  98. package/.docs/raw/docs/primitives/chain-of-thought.mdx +3 -3
  99. package/.docs/raw/docs/primitives/composer.mdx +1 -1
  100. package/.docs/raw/docs/primitives/error.mdx +1 -1
  101. package/.docs/raw/docs/primitives/message.mdx +1 -1
  102. package/.docs/raw/docs/primitives/selection-toolbar.mdx +1 -1
  103. package/.docs/raw/docs/primitives/suggestion.mdx +4 -2
  104. package/.docs/raw/docs/primitives/thread-list.mdx +1 -1
  105. package/.docs/raw/docs/primitives/thread.mdx +2 -2
  106. package/.docs/raw/docs/react-native/adapters.mdx +1 -1
  107. package/.docs/raw/docs/react-native/index.mdx +2 -2
  108. package/.docs/raw/docs/react-native/migration.mdx +2 -2
  109. package/.docs/raw/docs/react-native/primitives.mdx +142 -5
  110. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +48 -6
  111. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +3 -3
  112. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +4 -4
  113. package/.docs/raw/docs/runtimes/ai-sdk/v7.mdx +31 -16
  114. package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +118 -0
  115. package/.docs/raw/docs/runtimes/concepts/adapters.mdx +3 -3
  116. package/.docs/raw/docs/runtimes/concepts/architecture.mdx +3 -3
  117. package/.docs/raw/docs/runtimes/concepts/stability.mdx +2 -1
  118. package/.docs/raw/docs/runtimes/concepts/threads.mdx +73 -33
  119. package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +1 -1
  120. package/.docs/raw/docs/runtimes/custom/external-store.mdx +6 -2
  121. package/.docs/raw/docs/runtimes/langchain.mdx +2 -2
  122. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +4 -0
  123. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +1 -1
  124. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +9 -2
  125. package/.docs/raw/docs/tools/backend.mdx +4 -4
  126. package/.docs/raw/docs/tools/defining-tools.mdx +21 -2
  127. package/.docs/raw/docs/tools/generative-ui-primitive.mdx +180 -0
  128. package/.docs/raw/docs/tools/generative-ui-slack.mdx +167 -0
  129. package/.docs/raw/docs/tools/generative-ui-teams.mdx +160 -0
  130. package/.docs/raw/docs/tools/generative-ui.mdx +224 -211
  131. package/.docs/raw/docs/tools/index.mdx +2 -1
  132. package/.docs/raw/docs/tools/interactables.mdx +8 -7
  133. package/.docs/raw/docs/tools/mcp-apps.mdx +18 -1
  134. package/.docs/raw/docs/tools/mcp.mdx +2 -2
  135. package/.docs/raw/docs/tools/openui.mdx +175 -0
  136. package/.docs/raw/docs/tools/tool-ui.mdx +18 -7
  137. package/.docs/raw/docs/tools/user-managed-mcp.mdx +7 -3
  138. package/.docs/raw/docs/ui/assistant-modal.mdx +3 -3
  139. package/.docs/raw/docs/ui/assistant-sidebar.mdx +1 -1
  140. package/.docs/raw/docs/ui/attachment.mdx +50 -3
  141. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +36 -1
  142. package/.docs/raw/docs/ui/context-display.mdx +1 -1
  143. package/.docs/raw/docs/ui/directive-text.mdx +1 -1
  144. package/.docs/raw/docs/ui/file.mdx +2 -2
  145. package/.docs/raw/docs/ui/follow-up-suggestions.mdx +1 -1
  146. package/.docs/raw/docs/ui/image.mdx +2 -2
  147. package/.docs/raw/docs/ui/markdown.mdx +40 -1
  148. package/.docs/raw/docs/ui/mermaid.mdx +1 -1
  149. package/.docs/raw/docs/ui/message-timing.mdx +1 -1
  150. package/.docs/raw/docs/ui/model-selector.mdx +4 -4
  151. package/.docs/raw/docs/ui/part-grouping.mdx +1 -1
  152. package/.docs/raw/docs/ui/quote.mdx +3 -3
  153. package/.docs/raw/docs/ui/reasoning.mdx +31 -3
  154. package/.docs/raw/docs/ui/scrollbar.mdx +1 -1
  155. package/.docs/raw/docs/ui/sources.mdx +10 -1
  156. package/.docs/raw/docs/ui/streamdown.mdx +2 -2
  157. package/.docs/raw/docs/ui/syntax-highlighting.mdx +1 -1
  158. package/.docs/raw/docs/ui/thread-list.mdx +40 -1
  159. package/.docs/raw/docs/ui/thread.mdx +49 -2
  160. package/.docs/raw/docs/ui/tool-fallback.mdx +23 -9
  161. package/.docs/raw/docs/ui/tool-group.mdx +1 -1
  162. package/.docs/raw/docs/ui/voice.mdx +1 -1
  163. package/.docs/raw/docs/utilities/react-o11y.mdx +2 -2
  164. package/dist/xulux/catalog-client.d.ts.map +1 -1
  165. package/dist/xulux/catalog-client.js +51 -6
  166. package/dist/xulux/catalog-client.js.map +1 -1
  167. package/dist/xulux/types.d.ts +7 -7
  168. package/dist/xulux/types.d.ts.map +1 -1
  169. package/dist/xulux/types.js.map +1 -1
  170. package/package.json +5 -5
  171. package/src/tools/tests/docs.test.ts +10 -7
  172. package/src/tools/tests/path-traversal.test.ts +5 -2
  173. package/src/tools/tests/xulux-templates.test.ts +63 -0
  174. package/src/xulux/catalog-client.ts +68 -23
  175. package/src/xulux/types.ts +17 -13
  176. package/.docs/raw/docs/tools/interactables-legacy.mdx +0 -423
  177. package/.docs/raw/docs/ui/accordion.mdx +0 -266
  178. package/.docs/raw/docs/ui/badge.mdx +0 -150
  179. package/.docs/raw/docs/ui/diff-viewer.mdx +0 -280
  180. package/.docs/raw/docs/ui/dot-matrix.mdx +0 -133
  181. package/.docs/raw/docs/ui/number-roll.mdx +0 -154
  182. package/.docs/raw/docs/ui/select.mdx +0 -254
  183. package/.docs/raw/docs/ui/tabs.mdx +0 -271
  184. /package/.docs/raw/docs/{(docs) → (getting-started)}/architecture.mdx +0 -0
  185. /package/.docs/raw/docs/{(docs) → (getting-started)}/base-ui.mdx +0 -0
  186. /package/.docs/raw/docs/{(docs) → (getting-started)}/llm.mdx +0 -0
  187. /package/.docs/raw/docs/{(docs) → (getting-started)}/rtl.mdx +0 -0
@@ -6,6 +6,7 @@ description: Decision guide for choosing the right runtime, by framework or by f
6
6
  import { A2AIcon } from "@/components/icons/a2a";
7
7
  import { AdkIcon } from "@/components/icons/adk";
8
8
  import { AguiIcon } from "@/components/icons/agui";
9
+ import { ClaudeIcon } from "@/components/icons/claude";
9
10
  import { CloudflareIcon } from "@/components/icons/cloudflare";
10
11
  import { LangChainIcon } from "@/components/icons/langchain";
11
12
  import { LangGraphIcon } from "@/components/icons/langgraph";
@@ -80,14 +81,14 @@ assistant-ui ships React adapter packages for these. Pick the matching card and
80
81
 
81
82
  ### Integration guides
82
83
 
83
- For frameworks without a dedicated adapter, these wiring guides route through one of the adapters above.
84
+ For frameworks without a dedicated adapter, these wiring guides route through an existing runtime: an adapter above, or one of the core runtimes.
84
85
 
85
86
  <Cards>
86
87
  <Card
87
88
  icon={<CloudflareIcon width={20} height={20} />}
88
89
  title="Cloudflare Agents"
89
90
  description="Stateful agents on Durable Objects with WebSocket streaming. Wired through the Vercel AI SDK runtime."
90
- href="/docs/integrations/frameworks/cloudflare-agents/overview"
91
+ href="/docs/integrations/frameworks/cloudflare-agents"
91
92
  />
92
93
  <Card
93
94
  icon={<MastraIcon width={20} height={20} />}
@@ -95,6 +96,12 @@ For frameworks without a dedicated adapter, these wiring guides route through on
95
96
  description="TypeScript agent framework. Wired through the Vercel AI SDK runtime."
96
97
  href="/docs/integrations/frameworks/mastra/overview"
97
98
  />
99
+ <Card
100
+ icon={<ClaudeIcon width={20} height={20} className="text-[#D97757]" />}
101
+ title="Claude Managed Agents"
102
+ description="Anthropic-hosted agent sessions. Wired through the external store runtime: event-log replay, approval gates, sessions as threads."
103
+ href="/docs/runtimes/claude-managed-agents"
104
+ />
98
105
  </Cards>
99
106
 
100
107
  </PlatformOnly>
@@ -10,10 +10,10 @@ For authoring tools, see [Defining Tools](/docs/tools/defining-tools). For MCP s
10
10
 
11
11
  ## The request body
12
12
 
13
- `@assistant-ui/react-ai-sdk` posts `{ messages, system, tools }` to your route. `tools` is the map of **frontend** tools the client serialized for this request (the model needs their schemas to call them, even though they run in the browser):
13
+ `@assistant-ui/ai-sdk` posts `{ messages, system, tools }` to your route. `tools` is the map of **frontend** tools the client serialized for this request (the model needs their schemas to call them, even though they run in the browser):
14
14
 
15
15
  ```ts
16
- import type { FrontendTools } from "@assistant-ui/react-ai-sdk";
16
+ import type { FrontendTools } from "@assistant-ui/ai-sdk";
17
17
 
18
18
  const {
19
19
  messages,
@@ -31,7 +31,7 @@ const {
31
31
  When you author tools in a [`"use generative"` file](/docs/tools/defining-tools#quick-start-use-generative), the same import resolves to the **server build** inside a route handler — schema plus any backend `execute`, with renderers stripped. Wrap it in an `AISDKToolkit` and call `.tools()` with the uploaded `tools`:
32
32
 
33
33
  ```ts title="app/api/chat/route.ts"
34
- import { AISDKToolkit } from "@assistant-ui/react-ai-sdk";
34
+ import { AISDKToolkit } from "@assistant-ui/ai-sdk";
35
35
  import { streamText, convertToModelMessages, type UIMessage } from "ai";
36
36
  import { openai } from "@ai-sdk/openai";
37
37
  import toolkit from "../../toolkit";
@@ -70,7 +70,7 @@ serializes browser-executed tools into the request `tools`. Convert them to the
70
70
  AI SDK shape with `frontendTools` and spread your own server tools alongside:
71
71
 
72
72
  ```ts title="app/api/chat/route.ts"
73
- import { frontendTools } from "@assistant-ui/react-ai-sdk";
73
+ import { frontendTools } from "@assistant-ui/ai-sdk";
74
74
  import { streamText, convertToModelMessages, tool, zodSchema } from "ai";
75
75
  import { openai } from "@ai-sdk/openai";
76
76
  import { z } from "zod";
@@ -121,7 +121,7 @@ Import the toolkit in your runtime provider and pass it to `config` via `Tools`:
121
121
  "use client";
122
122
 
123
123
  import { AssistantRuntimeProvider, AuiConfig, Tools } from "@assistant-ui/react";
124
- import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
124
+ import { useChatRuntime } from "@assistant-ui/ai-sdk";
125
125
  import toolkit from "./toolkit";
126
126
 
127
127
  export function MyRuntimeProvider({ children }: { children: React.ReactNode }) {
@@ -148,7 +148,7 @@ export function MyRuntimeProvider({ children }: { children: React.ReactNode }) {
148
148
  The same import resolves to the **server build** inside a route handler. Wrap it in an `AISDKToolkit` so the model is configured with every tool's schema:
149
149
 
150
150
  ```ts title="app/api/chat/route.ts"
151
- import { AISDKToolkit } from "@assistant-ui/react-ai-sdk";
151
+ import { AISDKToolkit } from "@assistant-ui/ai-sdk";
152
152
  import { streamText, convertToModelMessages } from "ai";
153
153
  import { openai } from "@ai-sdk/openai";
154
154
  import toolkit from "../../toolkit";
@@ -194,6 +194,25 @@ The compiler also enforces, at build time:
194
194
  - a **frontend** tool declares a `render` or `renderText`;
195
195
  - a **human** tool declares a `render`.
196
196
 
197
+ ### Running without your own backend
198
+
199
+ The client build skips uploading frontend/human schemas because it assumes your backend imported the same file's server build and already knows them. When no server of yours does — for example, cloud-hosted runs — that assumption breaks and the model never learns about those tools. Compile with the `backendless` option so the client keeps every schema uploadable, including the `present`/`prompt_user` schema of a `JSONGenerativeUI` component library:
200
+
201
+ ```ts title="next.config.ts"
202
+ export default withAui({ ...yourConfig, aui: { backendless: true } });
203
+ ```
204
+
205
+ ```ts title="vite.config.ts"
206
+ plugins: [aui({ backendless: true })];
207
+ ```
208
+
209
+ ```js title="metro.config.js"
210
+ module.exports = withAui({
211
+ ...getDefaultConfig(__dirname),
212
+ aui: { backendless: true },
213
+ });
214
+ ```
215
+
197
216
  ## Tool kinds
198
217
 
199
218
  ### Backend tools
@@ -0,0 +1,180 @@
1
+ ---
2
+ title: Generative UI primitive
3
+ description: Render agent-described React UI from a JSON spec with a consumer-provided component allowlist, using the MessagePrimitive.GenerativeUI primitive.
4
+ platforms: ["react"]
5
+ ---
6
+
7
+ <Callout type="info">
8
+ This page is for a **backend that already emits `generative-ui` message parts**. If you are starting fresh and want the model to compose an interface, use the [`present` tool](/docs/tools/generative-ui) instead: it ships a component vocabulary, generates the model-facing schema for you, and renders inside the stock `Thread` without extra wiring. The two are not versions of one API and their specs are not interchangeable; see [Spec shape](#spec-shape).
9
+ </Callout>
10
+
11
+ `MessagePrimitive.GenerativeUI` renders UI described by the agent at runtime as a JSON spec. Instead of hard-coding a component per tool, the agent emits a `generative-ui` message part containing a tree of components by name. assistant-ui resolves each name against a **consumer-provided allowlist** and renders the result. The producer is your backend rather than a model tool call: you decide what goes into the part and prompt your agent to emit it.
12
+
13
+ The allowlist controls **which** components the agent may render: any name not in it throws a typed `GenerativeUIRenderError` (no implicit fallback). It does not constrain the props passed to those components; see [Security](#security).
14
+
15
+ <Callout type="warn">
16
+ The default shadcn `Thread` does **not** render `generative-ui` parts. You must wire the primitive explicitly, see [Opt-in wiring](#opt-in-wiring).
17
+ </Callout>
18
+
19
+ ## When not to use the primitive
20
+
21
+ - **A vocabulary the model composes freely** → the [`present` tool](/docs/tools/generative-ui)
22
+ - **User input and two-way interaction** → [Tool UI](/docs/tools/tool-ui) or [Interactables](/docs/tools/interactables)
23
+ - **LangGraph `push_ui_message`** → [LangGraph data UI](/docs/runtimes/langgraph/generative-ui)
24
+ - **Untrusted HTML or third-party widgets** → [MCP Apps](/docs/tools/mcp-apps) (sandboxed frames)
25
+
26
+ ## Quick start
27
+
28
+ ### 1. Define your component allowlist
29
+
30
+ ```tsx title="components/gui.tsx"
31
+ const Card = ({ title, children }) => (
32
+ <div className="rounded-xl border bg-card p-4 shadow-sm">
33
+ <div className="text-base font-semibold">{title}</div>
34
+ <div className="mt-2">{children}</div>
35
+ </div>
36
+ );
37
+
38
+ const Button = ({ label }) => (
39
+ <button className="rounded-md bg-primary px-3 py-1.5 text-primary-foreground">
40
+ {label}
41
+ </button>
42
+ );
43
+
44
+ export const componentsAllowlist = { Card, Button };
45
+ ```
46
+
47
+ ### 2. Wire the primitive into your message renderer
48
+
49
+ See [Opt-in wiring](#opt-in-wiring) for all three integration patterns.
50
+
51
+ ### 3. Have the agent emit UI
52
+
53
+ **ExternalStore / manual messages** attach a native part:
54
+
55
+ ```ts
56
+ {
57
+ type: "generative-ui",
58
+ spec: {
59
+ root: {
60
+ component: "Card",
61
+ props: { title: "Welcome" },
62
+ children: [
63
+ { component: "Button", props: { label: "Get started" } },
64
+ ],
65
+ },
66
+ },
67
+ }
68
+ ```
69
+
70
+ **AI SDK (`useChatRuntime`)** maps tool results to `tool-call` parts, not `generative-ui` parts. Use the [AI SDK interim bridge](#pattern-3--ai-sdk-interim-bridge).
71
+
72
+ Live routes in [`examples/with-generative-ui`](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-generative-ui): static primitive (`/primitive`), GUI chat bridge (`/gui-chat`).
73
+
74
+ ## Opt-in wiring
75
+
76
+ The stock `@assistant-ui/ui` `Thread` switch returns `null` for unknown part types, including `generative-ui`. Add one of these patterns in **your** assistant message renderer.
77
+
78
+ ### Pattern 1 — `MessagePrimitive.Parts`
79
+
80
+ ```tsx
81
+ <MessagePrimitive.Parts
82
+ components={{
83
+ generativeUI: {
84
+ components: componentsAllowlist,
85
+ Fallback: UnknownComponentFallback,
86
+ },
87
+ }}
88
+ />
89
+ ```
90
+
91
+ ### Pattern 2 — `GroupedParts` case (shadcn Thread fork)
92
+
93
+ ```tsx
94
+ case "generative-ui":
95
+ return (
96
+ <MessagePrimitive.GenerativeUI
97
+ components={componentsAllowlist}
98
+ Fallback={UnknownComponentFallback}
99
+ />
100
+ );
101
+ ```
102
+
103
+ Also exclude `render_gui` from tool-group chrome in `groupBy` if you use the AI SDK bridge (return `null` for that tool name).
104
+
105
+ ### Pattern 3 — AI SDK interim bridge
106
+
107
+ When using `useChatRuntime`, map a dedicated tool result to the renderer:
108
+
109
+ ```tsx
110
+ case "tool-call":
111
+ if (part.toolName === "render_gui") {
112
+ const spec = parseRenderGuiResult(part.result);
113
+ if (spec) {
114
+ return (
115
+ <MessagePrimitive.GenerativeUI
116
+ spec={spec}
117
+ components={componentsAllowlist}
118
+ Fallback={UnknownComponentFallback}
119
+ />
120
+ );
121
+ }
122
+ }
123
+ return part.toolUI ?? <ToolFallback {...part} />;
124
+ ```
125
+
126
+ The message store still holds a `tool-call` on this path, not a `generative-ui` part. See `examples/with-generative-ui/app/gui-chat` for a working reference.
127
+
128
+ Bare strings act as inline text leaves.
129
+
130
+ ## Spec shape
131
+
132
+ ```ts
133
+ type GenerativeUINode =
134
+ | string
135
+ | {
136
+ component: string; // resolved against the allowlist
137
+ props?: Record<string, unknown>;
138
+ children?: GenerativeUINode[];
139
+ key?: string; // optional stable React key
140
+ };
141
+
142
+ type GenerativeUISpec = {
143
+ root: GenerativeUINode | GenerativeUINode[];
144
+ };
145
+ ```
146
+
147
+ The spec is plain JSON, easy for any agent to emit and easy to validate on the server before delivery.
148
+
149
+ This is a different shape from the flat `$type` tree the [`present` tool](/docs/tools/generative-ui) uses. The two are not interchangeable, and the Slack, Teams, and A2UI converters only accept the `$type` form.
150
+
151
+ ## Streaming
152
+
153
+ When a message contains native `generative-ui` parts whose `spec` updates incrementally (for example via ExternalStore), the primitive renders progressively as nodes and props arrive.
154
+
155
+ The AI SDK `render_gui` tool path returns the full spec at **tool completion**, not incrementally during the tool execute step. For args streaming during generation, use [Tool UI](/docs/tools/tool-ui) instead.
156
+
157
+ ## Security
158
+
159
+ The allowlist is the boundary on **which** components render: a spec can only instantiate components you put in the registry, with no `eval` and no dynamic import (names are looked up in the registry and nothing else). An unknown name throws `GenerativeUIRenderError` or invokes your `Fallback`.
160
+
161
+ It does **not** constrain the `props` the agent supplies. Spec props are spread directly onto your allowlisted components, so treat every allowlisted component as receiving untrusted input: never forward agent-supplied props into `dangerouslySetInnerHTML`, validate or reject `href` and `src` values (for example block `javascript:` URLs), and avoid passing spec props anywhere they become executable. The safest allowlisted components accept only primitive, display-oriented props.
162
+
163
+ ## Error handling
164
+
165
+ Unknown component names throw `GenerativeUIRenderError` with a typed `componentName` field. Catch it with a React error boundary, or pass a `Fallback` component to opt into a soft-fail UX:
166
+
167
+ ```tsx
168
+ <MessagePrimitive.GenerativeUI
169
+ components={componentsAllowlist}
170
+ Fallback={({ component }) => (
171
+ <span className="rounded bg-muted px-1.5 py-0.5 font-mono text-xs">
172
+ unknown component: {component}
173
+ </span>
174
+ )}
175
+ />
176
+ ```
177
+
178
+ ## Composing with other primitives
179
+
180
+ `generative-ui` is a regular `MessagePart` type, so it composes cleanly with `MessagePrimitive.Parts`, `MessagePrimitive.PartByIndex`, and `MessagePrimitive.GroupedParts`. Render it alongside text, tool calls, and reasoning in the same message.
@@ -0,0 +1,167 @@
1
+ ---
2
+ title: Generative UI on Slack
3
+ description: Convert a generative UI tree into Slack Block Kit, post it, and decode the block_actions payload Slack sends back into your action handlers.
4
+ platforms: ["react"]
5
+ ---
6
+
7
+ The `$type` tree your assistant renders in the browser is plain JSON, so it does not have to stay in the browser. `@assistant-ui/react-generative-ui/slack` converts the same tree into [Block Kit](https://docs.slack.dev/reference/block-kit/blocks) JSON, decodes the interactions Slack posts back, and parses Block Kit payloads into the tree.
8
+
9
+ The subpath is React-free, so a server action, queue worker, or webhook handler imports it without pulling React into the bundle.
10
+
11
+ ## Posting a tree
12
+
13
+ ```ts
14
+ import { WebClient } from "@slack/web-api";
15
+ import { toSlackBlocks } from "@assistant-ui/react-generative-ui/slack";
16
+
17
+ const slack = new WebClient(process.env.SLACK_BOT_TOKEN);
18
+
19
+ const { blocks, warnings } = toSlackBlocks({
20
+ $type: "Card",
21
+ title: "Order #48213",
22
+ children: [{ $type: "Text", value: "Shipped, arriving Thursday." }],
23
+ });
24
+
25
+ await slack.chat.postMessage({ channel: "#orders", blocks });
26
+ ```
27
+
28
+ `toSlackBlocks(node, options?)` returns `{ blocks, warnings }` and never throws: an input it cannot convert at all comes back as empty `blocks` plus one warning rather than an exception. Pass `{ surface: "modal" }` to target a modal instead of a message; the surface changes the block budget and unlocks the native `alert` block.
29
+
30
+ ## Warnings
31
+
32
+ Conversion is total. Every downgrade is reported rather than thrown, so one unsupported node never costs you the whole message:
33
+
34
+ ```ts
35
+ type SlackConversionWarning = {
36
+ code: "clamped" | "dropped" | "fallback";
37
+ component: string; // the IR component name, or "Root" for whole-payload issues
38
+ detail: string;
39
+ };
40
+ ```
41
+
42
+ `clamped` means content was truncated to fit a Slack limit, `dropped` means a node or one of its props was discarded and may have left a placeholder note behind (an oversized button payload is dropped while the button itself is kept, a `Chart` becomes an omission note), and `fallback` means the node rendered through a different construct than requested. Warnings arrive in traversal order and are not deduplicated. Logging them in development is the fastest way to see why a composition looks different on Slack than in the browser.
43
+
44
+ ## Component mapping
45
+
46
+ | Component | Slack output | Fidelity |
47
+ |---|---|---|
48
+ | `Header` | `header` block | Only `text` survives; `size` is dropped silently, since Slack's `header` block has no size |
49
+ | `Text` | `section` block with `mrkdwn` text | Only `value` survives; `size`, `weight`, and `color` are dropped silently |
50
+ | `Markdown` | `markdown` block | Downgrades to a `section` once the payload's markdown budget is spent |
51
+ | `Caption`, `Badge` | `context` block with one element | The two become identical output and cannot be told apart coming back |
52
+ | `Image` | `image` block | Only `src` and `alt` survive; `size` and `round` are dropped silently |
53
+ | `Divider` | `divider` block | `flush` is dropped silently |
54
+ | `Fact` | Merged into one `section`'s `fields`, as `*label*` then value | Consecutive facts merge; every 10 fields start a new section |
55
+ | `Table` | `data_table` block, first row as header | Cells become `raw_number` or `raw_text`; rows are padded to a uniform width; a column without a string label keeps its position with an empty header and warns |
56
+ | `Card` | Native `card` block, or a header plus inline blocks | See [Cards](#cards) |
57
+ | `Carousel` | `carousel` block of `card` elements | A non-card child that would have rendered is dropped with a warning; a card that cannot map cleanly is reshaped to title and body, and separately reports the images, tables, charts, and controls that reshape loses |
58
+ | `Alert` | Native `alert` block on a modal; a `context` plus `section` pair on a message | Slack supports `alert` [only in modals](https://docs.slack.dev/reference/block-kit/blocks/alert-block) |
59
+ | `ListView` | One `section` per item, with `divider` blocks between them | Item children collapse into concatenated text; a non-item child that would have rendered is dropped with a warning |
60
+ | `ListViewItem` | `section`, plus an "Open" button accessory when it carries an action | |
61
+ | `Button` | `button` element inside an `actions` block | `primary` and `danger` styles survive; other styles are dropped |
62
+ | `Select` | `static_select` element | An option without a string label and value is dropped with a warning |
63
+ | `RadioGroup` | `radio_buttons` element | An option without a string label and value is dropped with a warning |
64
+ | `Checkbox` | `checkboxes` element with a single option | |
65
+ | `DatePicker` | `datepicker` element | `min` and `max` are dropped; a non-`YYYY-MM-DD` value is dropped with a warning |
66
+ | `Input` | Its own `input` block | Not grouped into an `actions` block |
67
+ | `Form` | Children inline, then a "Submit" button | Slack has no form container |
68
+ | `Row` | One `context` block when every child is a `Badge` or `Caption`, otherwise flattened | Horizontal layout is lost in the flattened case |
69
+ | `Col`, `Box` | Flattened into the sibling block stream | Slack has no nesting container |
70
+ | `Chart` | Replaced by a note block | Always warns |
71
+ | `Spacer`, `Icon` | Dropped | Silently, since neither has a Slack equivalent |
72
+
73
+ An unknown component and a bare string child are both handled: the unknown one is dropped with a warning, and the string becomes a `section`.
74
+
75
+ Presentation props the converter does not map are dropped silently, without a warning, because the node itself still renders. That covers `Box`'s `width`, `height`, `radius`, and `background`; `Card`'s `padding` and `background`; `gap` on `Row`, `Col`, and `Form`, `align` on `Row` and `Col`, and `justify` on `Row`; `Badge`'s `variant`; `Carousel`'s `label`; and `Button`'s `block`. `Card`'s `asForm` and `Button`'s `submit` are dropped for a different reason: Slack has no client-side form model to submit into, so a submit button and a click button both convert to the same `button` element carrying the node's `$action`, and a card marked `asForm` converts exactly like one that is not.
76
+
77
+ ### Cards
78
+
79
+ `Card` takes the native `card` block only when its children fit that block's fixed fields, because Slack's `card` carries `hero_image`, `title`, `body`, `subtext`, and up to three action buttons rather than nesting arbitrary blocks. The converter fills those from the first `Image`, the first `Text` or `Markdown`, and the first `Caption`.
80
+
81
+ Anything else in the card, including a second image, a `Fact`, or a loose `Button`, makes the card fall back to a header plus the children rendered inline plus an actions block, and reports a `fallback` warning. A card carrying none of an image, title, body, or actions is dropped outright.
82
+
83
+ Inside a `Carousel` that fallback is unavailable, so an over-full card is reshaped to title and body text instead, with a `fallback` warning. Text carried in a `text`, `value`, `label`, `title`, or `description` prop survives the reshape at any depth, which covers a `Caption`'s text and a `Button`'s label. An image, a `Table`, a `Chart`, and any control do not, since none of them is text, and those are reported separately as `dropped` so the two facts stay distinguishable. A control here is a `Button`, `Select`, `DatePicker`, `Checkbox`, `RadioGroup`, `Input`, or `Form`, plus a `ListViewItem` or a nested `Card` footer that carries an action. An `$action` on a layout node such as `Box`, `Col`, or `Row` does not count, because those render no control on the clean path either.
84
+
85
+ ## Limits
86
+
87
+ The converter clamps to Slack's published budgets rather than letting the API reject the payload. The ones you are most likely to hit:
88
+
89
+ | Budget | Value | Behavior when exceeded |
90
+ |---|---|---|
91
+ | Blocks per message | 50 (100 in a modal) | Extra blocks are dropped and a note block reports the count |
92
+ | Section text | 3,000 characters | Truncated |
93
+ | Section fields | 10 per section, 2,000 characters each | Chunked into further sections; text truncated |
94
+ | Actions elements | 25 per block | Chunked into further actions blocks |
95
+ | Select options | 100 | Truncated |
96
+ | Radio options | 10 | Truncated |
97
+ | Button label | 75 characters | Truncated |
98
+ | Button action payload | 2,000 characters | Dropped entirely, not truncated, so a partial payload never round-trips |
99
+ | Card title | 150 characters, body and subtext 200 | Truncated |
100
+ | Carousel cards | 10 | Truncated; a carousel with no renderable card is dropped |
101
+ | Table | 200 data rows, 20 columns, 20,000 characters across all tables in one payload | Rows truncated; a table whose header alone busts the budget is dropped |
102
+ | Markdown | 12,000 characters across the payload | Every markdown block from that point on becomes a `section` |
103
+
104
+ Traversal itself is bounded too: 200 children per level, 5,000 nodes per call, and 32 levels of element nesting, each reported as a `Root` warning. These bounds exist because the tree arrives from a model.
105
+
106
+ ## Actions
107
+
108
+ ### Outbound
109
+
110
+ A node's `$action` is split across two Block Kit fields. `$action.type` becomes the element's `action_id`, and the remaining keys are JSON-serialized into the element's `value`.
111
+
112
+ ```json
113
+ {
114
+ "$type": "Button",
115
+ "label": "Approve",
116
+ "$action": { "type": "approve_order", "orderId": "48213" }
117
+ }
118
+ ```
119
+
120
+ becomes a button with `action_id: "approve_order"` and `value: "{\"orderId\":\"48213\"}"`.
121
+
122
+ <Callout type="warn">
123
+ Only buttons carry `value`. `Select`, `Input`, `DatePicker`, `Checkbox`, and `RadioGroup` emit `action_id` alone, so any extra keys on their `$action` are dropped. Keep those controls' actions to a bare `type`, or put the payload on a button that submits alongside them.
124
+ </Callout>
125
+
126
+ ### Inbound
127
+
128
+ Slack posts interactions to your request URL as a [`block_actions` payload](https://docs.slack.dev/reference/interaction-payloads/block_actions-payload). `decodeBlockAction` takes one entry from its `actions` array and rebuilds the action your tree dispatched, with the user's runtime selection under `$input`:
129
+
130
+ ```ts
131
+ import { decodeBlockAction } from "@assistant-ui/react-generative-ui/slack";
132
+
133
+ const action = decodeBlockAction(payload.actions[0]);
134
+ // { type: "approve_order", orderId: "48213", $input: "…" }
135
+ ```
136
+
137
+ It returns `undefined` for anything without a usable `action_id`, and never throws. `type` always comes from `action_id`, so a payload key named `type` cannot override it, and a `$input` key smuggled into the serialized payload is always stripped.
138
+
139
+ What lands in `$input` depends on the element:
140
+
141
+ | Element | `$input` |
142
+ |---|---|
143
+ | `static_select`, `radio_buttons` | The selected option's value, as a string |
144
+ | `datepicker` | The selected date, as `YYYY-MM-DD` |
145
+ | `checkboxes` | An array of selected values, empty when nothing is checked |
146
+ | `plain_text_input` | The typed text |
147
+ | `button` | The raw `value` string, when it is not a serialized object |
148
+
149
+ ### Reading a tree back
150
+
151
+ `fromSlackBlocks` is the inverse direction, mapping a Block Kit payload into vocabulary nodes and returning `{ nodes, warnings }`. It accepts a bare array or a `{ blocks }` wrapper.
152
+
153
+ The round trip is faithful on the plain building blocks (text, images, facts, controls, tables, simple cards) and documented-lossy elsewhere: context elements all return as `Caption`, so the `Badge` distinction is gone, button styles beyond `primary` and `danger` are dropped, an alert's title and description come back merged into the description, and card layouts flatten to the fields the `card` block carries. Card footers are re-derived from button style, with the primary-styled button becoming `confirm`; when style cannot decide it, position does, and that emits a `fallback` warning.
154
+
155
+ ## Before interactions work
156
+
157
+ Converting and posting a tree needs only a bot token with `chat:write`. Making its buttons do anything additionally needs, on the Slack app side:
158
+
159
+ - **Interactivity enabled with a request URL**, under Interactivity & Shortcuts. Slack posts every `block_actions` payload there.
160
+ - **An acknowledgement within 3 seconds.** Return HTTP 200 first and do the work afterwards; the payload's `response_url` accepts up to five follow-up posts within 30 minutes if you need to update or replace the message.
161
+ - **[Request signature verification](https://docs.slack.dev/authentication/verifying-requests-from-slack)** on that endpoint, using your signing secret.
162
+
163
+ Receiving the webhook, verifying it, and routing the decoded action to your handler stay your application's responsibility. The converter only speaks JSON in and JSON out.
164
+
165
+ ## Reference
166
+
167
+ The generated per-export reference, including every type in the subpath, is at [Slack Block Kit](/docs/api-reference/generative-ui/slack). For the Teams equivalent of this page, see [Generative UI on Microsoft Teams](/docs/tools/generative-ui-teams).
@@ -0,0 +1,160 @@
1
+ ---
2
+ title: Generative UI on Microsoft Teams
3
+ description: Convert a generative UI tree into an Adaptive Card, send it from a bot, and decode the Action.Submit payload Teams sends back into your action handlers.
4
+ platforms: ["react"]
5
+ ---
6
+
7
+ The `$type` tree your assistant renders in the browser is plain JSON, so it does not have to stay in the browser. `@assistant-ui/react-generative-ui/teams` converts the same tree into an [Adaptive Card](https://adaptivecards.io/explorer/) and decodes the submit payload a Teams bot receives back.
8
+
9
+ The subpath is React-free, so a server action, queue worker, or bot handler imports it without pulling React into the bundle.
10
+
11
+ ## Sending a card
12
+
13
+ ```ts
14
+ import { toAdaptiveCard } from "@assistant-ui/react-generative-ui/teams";
15
+
16
+ const { card, warnings } = toAdaptiveCard({
17
+ $type: "Card",
18
+ title: "Order #48213",
19
+ children: [{ $type: "Text", value: "Shipped, arriving Thursday." }],
20
+ });
21
+
22
+ await context.sendActivity({
23
+ attachments: [
24
+ {
25
+ contentType: "application/vnd.microsoft.card.adaptive",
26
+ content: card,
27
+ },
28
+ ],
29
+ });
30
+ ```
31
+
32
+ `toAdaptiveCard(node)` returns `{ card, warnings }` and never throws; an input it cannot convert comes back as an empty card plus one warning. `toTeamsAttachments(node)` wraps the same conversion in the [attachment envelope](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference) for you, which is the form you want for a carousel.
33
+
34
+ Cards are stamped at Adaptive Cards schema **1.5**, the version [Teams supports on desktop](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference). Teams mobile clients cap at 1.2, so a card using 1.5-only elements (notably `Table`) may not render there.
35
+
36
+ ## Warnings
37
+
38
+ Conversion is total. Every downgrade is reported rather than thrown:
39
+
40
+ ```ts
41
+ type TeamsConversionWarning = {
42
+ code: "clamped" | "dropped" | "fallback" | "advisory";
43
+ component: string; // the IR component name, or "Root" for whole-payload issues
44
+ detail: string;
45
+ };
46
+ ```
47
+
48
+ `clamped` means content was truncated or capped, `dropped` means a node or one of its props was discarded and may have left a placeholder note behind (a `Chart` becomes an omission note), `fallback` means the node rendered through a different construct than requested (buttons past the sixth moved to secondary mode, a renamed input id), and `advisory` means nothing was changed at all and the result may still render poorly or be refused (a `Row` beyond three columns, a card or carousel over the byte budget).
49
+
50
+ ## Component mapping
51
+
52
+ | Component | Adaptive Card output | Fidelity |
53
+ |---|---|---|
54
+ | `Header` | `TextBlock` with heading style | `size` is ignored; the heading always emits `large` |
55
+ | `Text` | `TextBlock` | Six text sizes collapse to five rendered sizes, four weights to bold or not, and the five subtle color tokens to `isSubtle` while `emphasis` is dropped |
56
+ | `Markdown` | `TextBlock`, passed through verbatim | Teams renders [a markdown subset](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format); headings, tables, images, and blockquotes render literally |
57
+ | `Caption`, `Badge` | Small subtle `TextBlock` | The two become identical output |
58
+ | `Image` | `Image` | A numeric `size` is dropped with a warning; `round` is dropped silently |
59
+ | `Fact` | `FactSet` | Consecutive facts merge into one set |
60
+ | `Table` | Native `Table` with the first row as headers | Requires schema 1.5, so it will not render on Teams mobile; a column without a string label keeps its position with an empty header and warns |
61
+ | `Card` | `Container`, with the title as a leading heading | Footer buttons become an `ActionSet` beside the container, not inside it |
62
+ | `Alert` | `Container` with a semantic style (`accent`, `good`, `warning`, `attention`) | Title and description become two text blocks |
63
+ | `Carousel` | Multiple attachments through `toTeamsAttachments` | See [Carousels](#carousels); a non-card child that would have rendered is dropped with a warning |
64
+ | `ListView` | One `Container` per item, separated after the first | A non-item child that would have rendered is dropped with a warning, and never reserves an input id |
65
+ | `ListViewItem` | `Container`, with a select action when it carries an action | |
66
+ | `Button` | `Action.Submit` inside an `ActionSet` | Consecutive buttons merge into one set; `buttonStyle` is dropped, since Teams [ignores action styling](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference) |
67
+ | `Select` | `Input.ChoiceSet`, compact | An option without a string value is dropped with a warning |
68
+ | `RadioGroup` | `Input.ChoiceSet`, expanded | An option without a string value is dropped with a warning |
69
+ | `Checkbox` | `Input.Toggle` | Its value is the string `"true"` or `"false"` |
70
+ | `Input` | `Input.Text` | |
71
+ | `DatePicker` | `Input.Date` | `value`, `min`, and `max` are kept only in `YYYY-MM-DD` form, otherwise dropped silently |
72
+ | `Form` | Children inline, then a "Submit" `ActionSet` | Adaptive Cards has no form container; inputs on the card submit together |
73
+ | `Row` | `ColumnSet` with one auto-width column per child | Beyond three columns you get a warning, but all columns are kept |
74
+ | `Col`, `Box` | `Container` | The two become indistinguishable |
75
+ | `Divider` | Nothing; sets `separator` on the next sibling | See [Layout differences](#layout-differences) |
76
+ | `Spacer` | Nothing; sets `spacing` on the next sibling | See [Layout differences](#layout-differences) |
77
+ | `Chart` | Replaced by a subtle note | Always warns |
78
+ | `Icon` | Dropped | Silently |
79
+
80
+ `Text`'s size collapse is narrower than it looks: `sm`, `lg`, `xl`, `2xl`, and `3xl` map to `small`, `medium`, `large`, `extraLarge`, and `extraLarge`, while `md` emits no `size` at all and renders at the card's default. So six tokens reach five rendered sizes, and only `2xl` and `3xl` become indistinguishable. Color splits rather than collapses: `secondary`, `alpha-70`, `white`, `white-70`, and `white-50` all set `isSubtle: true`, while `emphasis` maps to nothing the converter emits and is dropped outright, so emphasized text renders identically to unstyled text.
81
+
82
+ Presentation props the converter does not map are dropped silently, without a warning, because the node itself still renders. That covers `Box`'s `width`, `height`, `radius`, and `background`; `Card`'s `padding` and `background`; `gap` on `Row`, `Col`, and `Form`, `align` on `Row` and `Col`, and `justify` on `Row`; `Badge`'s `variant`; `Carousel`'s `label`; `Divider`'s `flush`; and `Button`'s `block`. `Card`'s `asForm` and `Button`'s `submit` are dropped for a different reason: every input on an Adaptive Card submits together, so a submit button and a click button both convert to the same `Action.Submit`, and a card marked `asForm` converts exactly like one that is not.
83
+
84
+ ## Layout differences
85
+
86
+ Two vocabulary components behave differently here than anywhere else, because Adaptive Cards models separation as a property of an element rather than as an element:
87
+
88
+ - A `Divider` emits nothing and sets `separator: true` on the next element that does emit.
89
+ - A `Spacer` emits nothing and sets `spacing: "large"` on the next element that does emit.
90
+
91
+ A component that emits nothing, such as an `Icon`, does not consume a pending mark; it carries through to the next real element. A `Divider` or `Spacer` with nothing after it disappears entirely, without a warning. The practical consequence is that a trailing separator you would see on Slack is simply absent on Teams.
92
+
93
+ Two consolidations also apply, both run-based rather than global: consecutive `Fact` siblings merge into one `FactSet`, and consecutive `Button` siblings merge into one `ActionSet`. A different component between them breaks the run and starts a new set.
94
+
95
+ ## Inputs
96
+
97
+ Adaptive Cards merges every input's current value into one submit object keyed by the input's `id`, which has two consequences worth knowing.
98
+
99
+ **Ids come from `name`.** Each control's `id` is its `name` prop, falling back to a per-type default (`"select"`, `"radiogroup"`, `"input"`, `"datepicker"`). `Checkbox` is the exception: it falls back to its `label` first and only then to `"checkbox"`, so an unnamed checkbox keys the submit object by its visible label. Two controls that share a name on the same card would collide, so the converter renames the later one and warns. The key `aui` is reserved for the action envelope; a control named `aui` is renamed too.
100
+
101
+ **There is no change event.** Adaptive Cards has no way to dispatch when a control's value changes, so a standalone control carrying `$action` gets a companion "Submit" `ActionSet` appended, plus a `fallback` warning. Five such controls produce five separate submit buttons. The idiomatic shape is to put `$action` on a `Form` or a `Card` footer and leave the controls actionless, which yields one submit for the whole card.
102
+
103
+ ## Actions
104
+
105
+ ### Outbound
106
+
107
+ A node's `$action` is carried inside the submit payload's reserved `aui` key, so it never collides with input values:
108
+
109
+ ```json
110
+ {
111
+ "type": "Action.Submit",
112
+ "title": "Approve",
113
+ "data": { "aui": { "type": "approve_order", "payload": { "orderId": "48213" } } }
114
+ }
115
+ ```
116
+
117
+ Unlike Slack, the payload is not serialized to a string and carries no size cap of its own, so the converter never drops or truncates it the way an oversized Slack button value is dropped. Size is checked once, against the whole card, and that check only warns; whether an oversized card is then accepted is Teams' call, not the converter's.
118
+
119
+ ### Inbound
120
+
121
+ A bot receives the merged submit object as `activity.value`. `decodeSubmitData` splits it back into the action your tree dispatched, with the card's input values under `$input`:
122
+
123
+ ```ts
124
+ import { decodeSubmitData } from "@assistant-ui/react-generative-ui/teams";
125
+
126
+ const action = decodeSubmitData(context.activity.value);
127
+ // { type: "approve_order", orderId: "48213", $input: { quantity: "2" } }
128
+ ```
129
+
130
+ `$input` here is an **object keyed by input id**, which differs from Slack, where a single control's `$input` is a bare value. It is omitted when the card had no inputs. The function returns `undefined` for a payload without a well-formed `aui` envelope and never throws; `type` always comes from the envelope, and a `$input` key smuggled into the payload is stripped.
131
+
132
+ The converter emits `Action.Submit`. Teams also offers [`Action.Execute`](https://learn.microsoft.com/en-us/adaptive-cards/authoring-cards/universal-action-model) from schema 1.4, which lets a bot return a replacement card in the invoke response; reaching for that means constructing the action yourself.
133
+
134
+ ## Carousels
135
+
136
+ A carousel is an activity-level construct on Teams rather than a card-level one, so it only works through `toTeamsAttachments`:
137
+
138
+ ```ts
139
+ const { attachments, attachmentLayout } = toTeamsAttachments(tree);
140
+
141
+ await context.sendActivity({ attachments, attachmentLayout });
142
+ ```
143
+
144
+ With a `Carousel` at the root you get one attachment per card child and `attachmentLayout: "carousel"`, capped at ten cards. Anywhere other than the root, a carousel falls back to its cards rendered in sequence, with a `fallback` warning. Input ids are scoped per card, so two attachments may safely reuse the same name.
145
+
146
+ ## Limits
147
+
148
+ | Budget | Value | Behavior when exceeded |
149
+ |---|---|---|
150
+ | Carousel attachments | 10 | Truncated |
151
+ | Table | 100 rows, 20 columns | Truncated |
152
+ | Choice options | 100 | Truncated |
153
+ | Primary actions | 6 | Later actions move to secondary mode; none are dropped |
154
+ | Payload size | 80,000 serialized bytes, set below Teams' 100 KB bot message limit | Warned, never truncated, so you decide whether to split |
155
+
156
+ Traversal is bounded as well: 200 children per level, 5,000 nodes per call, and 32 levels of element nesting, each reported as a `Root` warning. These bounds exist because the tree arrives from a model.
157
+
158
+ ## Reference
159
+
160
+ The generated per-export reference, including every type in the subpath, is at [Microsoft Teams](/docs/api-reference/generative-ui/teams). For the Slack equivalent of this page, see [Generative UI on Slack](/docs/tools/generative-ui-slack).