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

package/.docs/raw/docs/guides/index.mdx

@@ -0,0 +1,103 @@
+---
+title: Overview
+description: Practical patterns for building features with assistant-ui.
+platforms: ["react"]
+---
+
+Guides are task-oriented walkthroughs for building specific features on top of assistant-ui. They sit between the [Primitives](/docs/primitives) (low-level building blocks) and [Components](/docs/ui/thread) (pre-styled installs) — pick a guide when you know what you want to build and need the recommended pattern.
+
+## Composer
+
+Extend the message input with file attachments, mentions, slash commands, voice, and quoting.
+
+<Cards>
+  <Card title="Attachments" href="/docs/guides/attachments">
+    Let users attach files, images, and documents to messages. Covers upload adapters, validation, and the typed `attachmentAddError` event.
+  </Card>
+  <Card title="Mentions" href="/docs/guides/mentions">
+    `@`-style triggers that insert directives into the composer. Sync and async search patterns.
+  </Card>
+  <Card title="Slash Commands" href="/docs/guides/slash-commands">
+    `/`-style commands with arguments, async loading, and combining with mentions.
+  </Card>
+  <Card title="Quoting" href="/docs/guides/quoting">
+    Selection toolbar, programmatic `setQuote`, and forwarding quote context to the LLM.
+  </Card>
+  <Card title="Dictation" href="/docs/guides/dictation">
+    Speech-to-text into the composer using `DictationAdapter` and `ComposerPrimitive.Dictate`.
+  </Card>
+</Cards>
+
+## Messages
+
+Customize how messages render, are edited, branched, and suggested.
+
+<Cards>
+  <Card title="Suggestions" href="/docs/guides/suggestions">
+    Welcome-screen prompts, dynamic suggestions, and the `AuiIf` empty-thread pattern.
+  </Card>
+  <Card title="Editing" href="/docs/guides/editing">
+    Edit user messages with `UserEditComposer`, `beginEdit()`, and edit-during-streaming behavior.
+  </Card>
+  <Card title="Branching" href="/docs/guides/branching">
+    Navigate alternative message versions with `BranchPickerPrimitive`, reload, and direct branch-id navigation.
+  </Card>
+  <Card title="Message Timing" href="/docs/guides/message-timing">
+    Display response duration and stream timing with `useMessageTiming` (experimental).
+  </Card>
+</Cards>
+
+## Tools & Generative UI
+
+Connect tools to the LLM and render their outputs as interactive UI.
+
+<Cards>
+  <Card title="Tools" href="/docs/guides/tools">
+    Define tools with the Toolkit API, stream args, handle cancellation, and integrate with AI SDK / LangGraph / LangChain.
+  </Card>
+  <Card title="Tool UI" href="/docs/guides/tool-ui">
+    Render tool calls and `DataMessagePart` into custom components, with fallback handling.
+  </Card>
+  <Card title="Interactables" href="/docs/guides/interactables">
+    Persisted, schema-validated interactive UI driven by AI state.
+  </Card>
+  <Card title="Multi-Agent" href="/docs/guides/multi-agent">
+    Sub-agent message attribution via `ToolCallMessagePart.messages` and LangGraph subgraph events.
+  </Card>
+</Cards>
+
+## Display
+
+Render specialized message content.
+
+<Cards>
+  <Card title="Chain of Thought" href="/docs/guides/chain-of-thought">
+    Display the assistant's reasoning steps in a collapsible accordion.
+  </Card>
+  <Card title="LaTeX" href="/docs/guides/latex">
+    Render math via React Markdown or Streamdown, with streaming-safe escape rules.
+  </Card>
+</Cards>
+
+## Audio
+
+Voice input and output.
+
+<Cards>
+  <Card title="Voice" href="/docs/guides/voice">
+    Realtime bidirectional audio with `RealtimeVoiceAdapter` and `createVoiceSession`.
+  </Card>
+  <Card title="Speech" href="/docs/guides/speech">
+    Text-to-speech for assistant messages via `SpeechSynthesisAdapter`.
+  </Card>
+</Cards>
+
+## Programmatic
+
+Read and drive runtime state from your own code.
+
+<Cards>
+  <Card title="Context API" href="/docs/guides/context-api">
+    Access threads, messages, composer, and tool state via `useAui` and the runtime scope tree.
+  </Card>
+</Cards>

package/.docs/raw/docs/{(docs)/guides → guides}/interactables.mdx

@@ -1,6 +1,7 @@
 ---
 title: Interactables
 description: Persistent UI whose state can be read and updated by the AI assistant.
+platforms: ["react"]
 ---
 
 import { InteractableSample } from "@/components/docs/samples/interactable";
@@ -344,6 +345,49 @@ const aui = useAui({
 });
 ```
 
+## Streaming Updates
+
+While the AI is generating tool arguments, `useInteractableState` reflects the partial state in real time as fields stream in. You can use the partial state itself plus the thread's running status to show a skeleton UI while the AI is mid-stream:
+
+```tsx
+import { useAuiState } from "@assistant-ui/react";
+
+function TaskBoard() {
+  const id = useAssistantInteractable("taskBoard", config);
+  const [state] = useInteractableState(id, taskBoardInitialState);
+  const isRunning = useAuiState((s) => s.thread.isRunning);
+
+  const isLoading = isRunning && state.tasks.length === 0;
+
+  return (
+    <div>
+      <h2>Tasks</h2>
+      {isLoading ? (
+        <div className="animate-pulse h-8 rounded bg-muted" />
+      ) : (
+        <ul>
+          {state.tasks.map((task) => (
+            <li key={task.id}>{task.title}</li>
+          ))}
+        </ul>
+      )}
+    </div>
+  );
+}
+```
+
+The state object updates progressively as the AI streams in each field, so partial renders work without any extra wiring. Use the runtime's `isRunning` to distinguish "still streaming, no fields yet" from "model returned an empty result".
+
+## Schema Evolution
+
+<Callout type="warn">
+  If you change a Zod schema after state has been persisted, the imported snapshot may silently mis-match the new shape. The adapter does a shallow merge, so extra fields are preserved and missing fields keep their initial values, but type mismatches are not caught at runtime. To avoid silent corruption, version your schema key (e.g. `"taskBoard_v2"`) or namespace it by schema hash whenever you make breaking changes. Alternatively, add a migration step in your `importState` call.
+</Callout>
+
+## Unmount Behavior
+
+When a component that called `useAssistantInteractable` unmounts, the interactable is unregistered from the AI's tool list and system prompt. However, its state is preserved in the `Interactables` scope. When the component mounts again with the same name and id, the scope re-merges the preserved state rather than resetting to `initialState`. This means transient unmounts (such as React Strict Mode double-mounts or tab switches) do not lose state.
+
 ## Full Example
 
 See the complete [with-interactables example](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-interactables) for a working implementation featuring:
@@ -352,3 +396,8 @@ See the complete [with-interactables example](https://github.com/assistant-ui/as
 - **Sticky Notes** — multi-instance interactables with selection and partial updates
 - **localStorage persistence** — state survives page refresh via `setPersistenceAdapter`
 - **Sync indicator** — spinning icon while a save is in-flight (`isPending`)
+
+## Related
+
+- [Generative UI](/docs/guides/tool-ui) — Inline tool call UIs rendered inside messages
+- [LangGraph Generative UI](/docs/runtimes/langgraph/generative-ui) — Structured UI components emitted by a LangGraph graph alongside messages

package/.docs/raw/docs/{(docs)/guides → guides}/latex.mdx

@@ -1,21 +1,24 @@
 ---
 title: LaTeX
 description: Render mathematical expressions in chat messages using KaTeX.
+platforms: ["react"]
 ---
 
+import { PackageManagerTabs } from "@/components/docs/fumadocs/install/package-manager-tabs";
 
 Render LaTeX mathematical expressions in chat messages using KaTeX.
 
-<Callout type="warn">LaTeX rendering is not enabled in markdown by default.</Callout>
+<Callout type="warn">LaTeX rendering is not enabled by default.</Callout>
+
+<Tabs items={["react-markdown", "Streamdown"]}>
+  <Tab value="react-markdown">
 
 <Steps>
   <Step>
 
 ### Install dependencies
 
-```bash
-npm i katex rehype-katex remark-math
-```
+<PackageManagerTabs packages={["katex", "rehype-katex", "remark-math"]} />
 
   </Step>
   <Step>
@@ -53,9 +56,50 @@ export const MarkdownText = memo(MarkdownTextImpl);
   </Step>
 </Steps>
 
+  </Tab>
+  <Tab value="Streamdown">
+
+<Callout type="info">
+  Using [Streamdown](/docs/ui/streamdown) as your renderer? Math support is a first-party plugin — no remark or rehype packages needed.
+</Callout>
+
+<Steps>
+  <Step>
+
+### Install dependencies
+
+<PackageManagerTabs packages={["@streamdown/math", "katex"]} />
+
+  </Step>
+  <Step>
+
+### Add KaTeX CSS to your layout
+
+```tsx title="/app/layout.tsx"
+import "katex/dist/katex.min.css"; // [!code ++]
+```
+
+  </Step>
+  <Step>
+
+### Pass the `math` plugin to `StreamdownTextPrimitive`
+
+```tsx title="/components/assistant-ui/streamdown-text.tsx"
+import { math } from "@streamdown/math"; // [!code ++]
+import "katex/dist/katex.min.css";       // [!code ++]
+
+<StreamdownTextPrimitive plugins={{ math }} /> // [!code ++]
+```
+
+  </Step>
+</Steps>
+
+  </Tab>
+</Tabs>
+
 ## Supported Formats
 
-By default, remark-math supports:
+By default, remark-math (react-markdown path) supports:
 - `$...$` for inline math
 - `$$...$$` for display math
 - Fenced code blocks with the `math` language identifier
@@ -67,7 +111,7 @@ Many language models generate LaTeX using different delimiter formats:
 - `\[...\]` for display math
 - Custom formats like `[/math]...[/math]`
 
-You can use the `preprocess` prop to normalize these formats:
+You can use the `preprocess` prop on `MarkdownTextPrimitive` to normalize these formats before parsing:
 
 ```tsx title="/components/assistant-ui/markdown-text.tsx"
 import { MarkdownTextPrimitive } from "@assistant-ui/react-markdown";
@@ -104,6 +148,5 @@ function normalizeCustomMathTags(input: string): string {
 ```
 
 <Callout type="tip">
-The preprocessing function runs before markdown parsing, allowing you to transform any delimiter format into the standard `$` and `$$` format.
+Inside `MarkdownTextPrimitive`, the streamed text first passes through `preprocess` (delimiter normalization) and then through `useSmooth` (character-by-character accumulation), and only then reaches the markdown parser. Both run before remark-math sees the text, so delimiter replacement and the streaming smoothing are streaming-safe — partially-received delimiters are accumulated in the smoothing buffer rather than parsed mid-fragment.
 </Callout>
-