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

package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx

@@ -0,0 +1,36 @@
+---
+title: Speech and Dictation
+description: Connect speech synthesis and dictation adapters to assistant-ui voice and composer workflows.
+---
+
+import { DictationAdapter, DictationState, SpeechSynthesisAdapter, WebSpeechDictationAdapter, WebSpeechSynthesisAdapter } from "@/generated/typeDocs";
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
+
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
+
+## API Reference
+
+### DictationAdapter
+
+<ParametersTable {...DictationAdapter} />
+
+### DictationState
+
+<ParametersTable {...DictationState} />
+
+### SpeechSynthesisAdapter
+
+<ParametersTable {...SpeechSynthesisAdapter} />
+
+### WebSpeechDictationAdapter
+
+<ParametersTable {...WebSpeechDictationAdapter} />
+
+### WebSpeechSynthesisAdapter
+
+<ParametersTable {...WebSpeechSynthesisAdapter} />
+{/* api-reference:end */}

package/.docs/raw/docs/cloud/ai-sdk.mdx

@@ -3,8 +3,6 @@ title: AI SDK
 description: Add cloud persistence to your existing AI SDK app with a single hook.
 ---
 
-import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
-
 ## Overview
 
 The `@assistant-ui/cloud-ai-sdk` package provides a single hook that adds full message and thread persistence to any [AI SDK](https://sdk.vercel.ai/) application:
@@ -380,7 +378,7 @@ The `useCloudChat` hook automatically reports run telemetry to Assistant Cloud a
 **Requires route configuration:**
 - `model_id` — The model used for the response
 - `input_tokens` / `output_tokens` — Token usage statistics
-- `reasoning_tokens` — Tokens used for chain-of-thought reasoning (e.g. o1/o3 models)
+- `reasoning_tokens` — Tokens used for chain-of-thought reasoning (e.g. GPT-5.4 Mini or GPT-5.5 models)
 - `cached_input_tokens` — Input tokens served from the provider's prompt cache
 
 To capture model and usage data, configure the `messageMetadata` callback in your AI SDK route:

package/.docs/raw/docs/cloud/index.mdx

@@ -1,6 +1,6 @@
 ---
-title: Overview
-description: Add thread persistence and chat history to your AI app in minutes.
+title: Cloud Persistence
+description: Add managed thread persistence and chat history to your AI app in minutes — assistant-ui Cloud handles thread sync, search, and multi-tenant storage.
 ---
 
 Assistant Cloud is a hosted service that adds thread management, message persistence, and user authorization to AI chat applications. It works with any React UI—whether you use assistant-ui components or your own.

package/.docs/raw/docs/guides/attachments.mdx

@@ -1,6 +1,6 @@
 ---
-title: Attachments
-description: Let users attach files, images, and documents to messages.
+title: File Attachments
+description: Let users attach images, PDFs, and other files to AI chat messages in React. Drag-drop, paste, and vision-model support, built into assistant-ui.
 platforms: ["react"]
 ---
 
@@ -118,7 +118,7 @@ Build your own adapters for specialized file handling. Below are complete exampl
 
 ### Vision-Capable Image Adapter
 
-Send images to vision-capable LLMs like GPT-4V, Claude 3, or Gemini Pro Vision:
+Send images to vision-capable LLMs like GPT-5.4, Claude Sonnet 4.6, or Gemini Pro Vision:
 
 ```tsx
 import {
@@ -276,7 +276,7 @@ const MyModelAdapter: ChatModelAdapter = {
         msg.role === "user" &&
         msg.content.some((part) => part.type === "image")
       ) {
-        // Format for GPT-4V or similar vision models
+        // Format for GPT-5.4 or similar vision models
         return {
           role: "user",
           content: msg.content.map((part) => {

package/.docs/raw/docs/guides/branching.mdx

@@ -1,6 +1,6 @@
 ---
 title: Message Branching
-description: Navigate between alternative message versions created by editing or reloading.
+description: Edit messages or regenerate AI responses, then switch between alternative replies. Branching navigation built into assistant-ui's React chat UI.
 platforms: ["react"]
 ---
 

package/.docs/raw/docs/guides/chain-of-thought.mdx

@@ -1,6 +1,6 @@
 ---
-title: Chain of Thought
-description: Group reasoning and tool calls into a collapsible accordion UI.
+title: Chain of Thought UI
+description: Show AI reasoning steps and tool calls in a collapsible thinking accordion. Build chain-of-thought visualizations in React chat with assistant-ui.
 platforms: ["react"]
 ---
 
@@ -8,7 +8,7 @@ LLMs often produce reasoning steps and tool calls in succession. Chain of Though
 
 ## Overview
 
-When a model like OpenAI's `o4-mini` responds, it may emit a sequence of reasoning tokens and tool calls before producing its final text answer. Use `MessagePrimitive.GroupedParts` to group those adjacent reasoning and tool-call parts into a single collapsible "thinking" section.
+When a reasoning model responds, it may emit a sequence of reasoning tokens and tool calls before producing its final text answer. Use `MessagePrimitive.GroupedParts` to group those adjacent reasoning and tool-call parts into a single collapsible "thinking" section.
 
 <Callout type="info">
 The older `components.ChainOfThought` prop on `MessagePrimitive.Parts` and `components` prop on `ChainOfThoughtPrimitive.Parts` are legacy APIs. They still work for existing code, but new code should use `MessagePrimitive.GroupedParts`.
@@ -26,6 +26,7 @@ Return the same top-level group for reasoning and tool calls, with nested groups
 ```tsx
 import {
   MessagePrimitive,
+  groupPartByType,
 } from "@assistant-ui/react";
 import { MarkdownText } from "@/components/assistant-ui/markdown-text";
 import {
@@ -47,13 +48,10 @@ const AssistantMessage: FC = () => {
   return (
     <MessagePrimitive.Root>
       <MessagePrimitive.GroupedParts
-        groupBy={(part) => {
-          if (part.type === "reasoning")
-            return ["group-chainOfThought", "group-reasoning"];
-          if (part.type === "tool-call")
-            return ["group-chainOfThought", "group-tool"];
-          return null;
-        }}
+        groupBy={groupPartByType({
+          reasoning: ["group-chainOfThought", "group-reasoning"],
+          "tool-call": ["group-chainOfThought", "group-tool"],
+        })}
       >
         {({ part, children }) => {
           switch (part.type) {
@@ -101,7 +99,7 @@ const AssistantMessage: FC = () => {
 
 ### Use a Reasoning Model
 
-Chain of Thought is most useful with models that produce reasoning tokens (e.g. OpenAI `o4-mini`). Here's an example backend route using the AI SDK:
+Chain of Thought is most useful with models that produce reasoning tokens. Here's an example backend route using the AI SDK:
 
 ```tsx title="app/api/chat/route.ts"
 import { openai } from "@ai-sdk/openai";
@@ -111,7 +109,7 @@ export async function POST(req: Request) {
   const { messages } = await req.json();
 
   const result = streamText({
-    model: openai("o4-mini"),
+    model: openai("gpt-5.4-mini"),
     messages: await convertToModelMessages(messages),
   });
 
@@ -162,5 +160,5 @@ See the complete [with-chain-of-thought example](https://github.com/assistant-ui
 ## Related Guides
 
 - [Reasoning](/docs/ui/reasoning) — reasoning UI primitives for grouped parts
-- [Generative UI](/docs/guides/tool-ui) — custom UI for tool calls
-- [Tools](/docs/guides/tools) — defining and using tools
+- [Generative UI](/docs/tools/tool-ui) — custom UI for tool calls
+- [Tools](/docs/tools/defining-tools) — defining and using tools

package/.docs/raw/docs/guides/context-api.mdx

@@ -1,6 +1,6 @@
 ---
-title: Context API
-description: Read and update assistant state to build custom components.
+title: Assistant Context API
+description: Read and update assistant state to build custom React components in your chat UI — composable context API for thread, message, and runtime data via assistant-ui.
 platforms: ["react"]
 ---
 
@@ -219,6 +219,7 @@ aui.threads().getState();
 // ThreadListItem actions
 aui.threadListItem().switchTo();
 aui.threadListItem().rename(title);
+aui.threadListItem().updateCustom(custom);
 aui.threadListItem().archive();
 aui.threadListItem().unarchive();
 aui.threadListItem().delete();
@@ -258,8 +259,8 @@ useAuiEvent("composer.send", (event) => {
 });
 
 // Listen to thread events
-useAuiEvent("thread.runStart", (event) => {
-  console.log("Run started in thread:", event.threadId);
+useAuiEvent("thread.modelContextUpdate", (event) => {
+  console.log("Model context updated in thread:", event.threadId);
 });
 
 // Listen to all events of a type across all scopes
@@ -517,7 +518,7 @@ The table below covers the most commonly used actions. For the full catalog, see
 | Scope          | Actions                                                                                                           | Use Cases                                  |
 | -------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
 | ThreadList     | `switchToNewThread()`, `switchToThread(id)`, `reload()`, `getLoadThreadsPromise()`, `item(selector)`, `thread("main")`, `getState()` | Thread navigation, creation, and sync |
-| ThreadListItem | `switchTo()`, `rename(title)`, `archive()`, `unarchive()`, `delete()`, `getState()`                              | Thread management operations               |
+| ThreadListItem | `switchTo()`, `rename(title)`, `updateCustom(custom)`, `archive()`, `unarchive()`, `delete()`, `getState()`      | Thread management operations               |
 | Thread         | `append(message)`, `startRun(config)`, `resumeRun(config)`, `cancelRun()`, `reset()`, `export()`, `import(repository)`, `message(selector)`, `composer()`, `getState()` | Message handling and conversation control |
 | Message        | `reload()`, `speak()`, `stopSpeaking()`, `submitFeedback(feedback)`, `switchToBranch(options)`, `getCopyText()`, `part(selector)`, `attachment(selector)`, `composer()`, `setIsCopied(value)`, `setIsHovering(value)`, `getState()` | Message interactions and regeneration |
 | Part           | `addToolResult(result)`, `resumeToolCall(result)`, `getState()`                                                   | Tool call result handling                  |

package/.docs/raw/docs/guides/dictation.mdx

@@ -1,6 +1,6 @@
 ---
-title: Speech-to-Text (Dictation)
-description: Let users speak into the composer using Web Speech API or a custom dictation adapter.
+title: Speech-to-Text Dictation
+description: Add voice dictation to your AI chat composer with the Web Speech API or a custom adapter. Speech-to-text in React, integrated through assistant-ui.
 platforms: ["react"]
 ---
 

package/.docs/raw/docs/guides/editing.mdx

@@ -1,6 +1,6 @@
 ---
 title: Message Editing
-description: Allow users to edit their messages with custom editor interfaces.
+description: Let users edit their messages and regenerate AI responses with custom editor interfaces. Edit-and-resubmit patterns for React chat via assistant-ui.
 platforms: ["react"]
 ---
 

package/.docs/raw/docs/guides/image-generation.mdx

@@ -0,0 +1,74 @@
+---
+title: Image Generation
+description: Generate images in your backend and render them inline in an assistant-ui thread.
+---
+
+Image generation needs no dedicated primitive. Generate the image wherever you already run model calls (a route handler or a tool), store the result as an `ImageMessagePart`, and render it with the `@assistant-ui/ui` `Image` component.
+
+<Callout type="info">
+  This covers non-streaming generation, rendering, and actions. Streaming partial images and multi-image galleries are out of scope.
+</Callout>
+
+## Generate in your backend
+
+Call your provider from a server route. With the AI SDK that is `generateImage`; return the image as a data URI (or an object-store URL) plus any provider metadata you want to keep.
+
+```ts
+// app/api/image/route.ts
+import { generateImage } from "ai";
+import { openai } from "@ai-sdk/openai";
+
+export async function POST(req: Request) {
+  const { prompt } = await req.json();
+  const result = await generateImage({
+    model: openai.image("gpt-image-1"),
+    prompt,
+  });
+  const revisedPrompt = (
+    result.providerMetadata as
+      | Record<string, Record<string, unknown>>
+      | undefined
+  )?.openai?.revisedPrompt;
+  return Response.json({
+    image: `data:${result.image.mediaType};base64,${result.image.base64}`,
+    mimeType: result.image.mediaType,
+    ...(typeof revisedPrompt === "string" && { revisedPrompt }),
+  });
+}
+```
+
+The model provider is irrelevant to rendering; swap `openai.image(...)` for any AI SDK image model.
+
+## Store it as an `ImageMessagePart`
+
+An `ImageMessagePart` only needs `image` (a `data:` URI, an `https://` URL, or a `blob:` URL) plus an optional `filename`. Keep any provenance you want to display, the prompt, a revised prompt, a model id, in your own component state or in message metadata; the part itself stays minimal.
+
+```ts
+const part: ImageMessagePart = {
+  type: "image",
+  image: result.image, // data:, https://, or blob: URL
+};
+```
+
+## Render with the `Image` component
+
+The `Image` component in `@assistant-ui/ui` handles the render states for you:
+
+1. **Running** (`status.type === "running"`) renders a spinner.
+2. **Content filter** (`status.type === "incomplete"` with `reason: "content-filter"`) renders an error card with no `<img src>`.
+3. **Complete** renders a zoomable `<img>` with optional `Image.Actions`.
+
+`Image.Actions` provides download and copy buttons, plus a regenerate button when you pass an `onRegenerate` callback. Wire it to the same generation flow you used above; debounce, rate limiting, and confirmation are your call.
+
+```tsx
+import { Image } from "@assistant-ui/ui";
+
+<>
+  <Image {...imagePart} />
+  <Image.Actions part={imagePart} onRegenerate={() => regenerate(prompt)} />
+</>;
+```
+
+## Example
+
+A complete Next.js example (with a mock fallback when `OPENAI_API_KEY` is unset) lives in [`examples/with-image-generation`](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-image-generation).

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

@@ -1,6 +1,6 @@
 ---
-title: Overview
-description: Practical patterns for building features with assistant-ui.
+title: Guides
+description: Practical recipes for building AI chat features in React with assistant-ui — attachments, branching, multi-agent, voice, slash commands, generative UI, and more.
 platforms: ["react"]
 ---
 
@@ -49,20 +49,11 @@ Customize how messages render, are edited, branched, and suggested.
 
 ## Tools & Generative UI
 
-Connect tools to the LLM and render their outputs as interactive UI.
+Tool calling and generative UI have their own [Tools](/docs/tools) section — defining toolkits, rendering tool calls, interactables, MCP, and multi-agent UIs.
 
 <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 title="Tools" href="/docs/tools">
+    Define toolkits, render tool calls, connect MCP servers, and build generative UI.
   </Card>
 </Cards>
 

package/.docs/raw/docs/guides/latex.mdx

@@ -1,6 +1,6 @@
 ---
-title: LaTeX
-description: Render mathematical expressions in chat messages using KaTeX.
+title: LaTeX in Chat Messages
+description: Render LaTeX math expressions in AI chat messages with KaTeX — drop-in equation support for React chat UIs built on assistant-ui.
 platforms: ["react"]
 ---
 

package/.docs/raw/docs/guides/mentions.mdx

@@ -1,6 +1,6 @@
 ---
-title: Mentions
-description: Let users @-mention tools or custom items in the composer to guide the LLM.
+title: Mentions in Chat
+description: Let users @-mention tools or custom items in the AI chat composer to guide the LLM. Mention picker built into assistant-ui's React composer.
 platforms: ["react"]
 ---
 
@@ -144,7 +144,7 @@ Pass the adapter to `TriggerPopover` and declare a `Directive` sub-primitive to
 
 ```tsx
 import { ComposerPrimitive } from "@assistant-ui/react";
-import { unstable_defaultDirectiveFormatter } from "@assistant-ui/core";
+import { unstable_defaultDirectiveFormatter } from "@assistant-ui/react";
 
 <ComposerPrimitive.Unstable_TriggerPopoverRoot>
   <ComposerPrimitive.Root>
@@ -198,7 +198,7 @@ import { unstable_useMentionAdapter } from "@assistant-ui/react";
 
 const mention = unstable_useMentionAdapter();
 // → { adapter, directive } — spread into <ComposerTriggerPopover {...mention} />
-// Default: single "Tools" category reading from useAssistantTool registrations
+// Default: single "Tools" category reading from toolkit registrations
 ```
 
 **Custom items only (no tools):**
@@ -302,7 +302,7 @@ When `id` equals `label`, the `{name=…}` attribute is omitted for brevity:
 Implement `Unstable_DirectiveFormatter` to use a different format:
 
 ```ts
-import type { Unstable_DirectiveFormatter } from "@assistant-ui/core";
+import type { Unstable_DirectiveFormatter } from "@assistant-ui/react";
 
 const slashFormatter: Unstable_DirectiveFormatter = {
   serialize(item) {
@@ -516,5 +516,5 @@ Mentions and slash commands coexist on the same composer. See [Combining Slash C
 - [ComposerTriggerPopover UI Component](/docs/ui/composer-trigger-popover) — pre-built shadcn component
 - [DirectiveText UI Component](/docs/ui/directive-text) — renders mention chips in user messages
 - [Slash Commands Guide](/docs/guides/slash-commands) — `/` command system built on the same architecture
-- [Tools Guide](/docs/guides/tools) — register tools that appear in the mention picker
+- [Tools Guide](/docs/tools/defining-tools) — register tools that appear in the mention picker
 - [Composer Primitives](/docs/primitives/composer) — underlying composer primitives

package/.docs/raw/docs/guides/message-timing.mdx

@@ -1,6 +1,6 @@
 ---
-title: Message Timing
-description: Display stream timing metadata like duration, tokens per second, and time to first token.
+title: Message Timing & Token Stats
+description: Display stream metadata in AI chat — generation duration, tokens per second, and time to first token, rendered via assistant-ui's React components.
 platforms: ["react"]
 ---
 
@@ -76,9 +76,9 @@ const AssistantMessage: FC = () => {
 | AI SDK (`useChatRuntime`) | Yes | Automatic via client-side tracking |
 | Local (`useLocalRuntime`) | Yes | Pass timing in `ChatModelRunResult.metadata` |
 | ExternalStore | Yes | Pass timing in `ThreadMessageLike.metadata` |
-| LangGraph | No | Not yet implemented |
-| AG-UI | No | Not yet implemented |
-| OpenCode | No | Not yet implemented |
+| LangGraph | Yes | Automatic via client-side tracking |
+| AG-UI | Yes | Automatic via client-side tracking |
+| OpenCode | Yes | Automatic via client-side tracking |
 
 ### Data Stream
 
@@ -163,6 +163,39 @@ const message: ThreadMessageLike = {
 };
 ```
 
+### LangGraph (`useLangGraphRuntime`)
+
+Timing is tracked automatically on the client side by observing streaming state transitions and `LangChainMessage` content changes. No setup required.
+
+```tsx
+import { useLangGraphRuntime } from "@assistant-ui/react-langgraph";
+
+const runtime = useLangGraphRuntime({ stream: myStream });
+// useMessageTiming() works out of the box
+```
+
+### AG-UI (`useAgUiThreadRuntime`)
+
+Timing is tracked automatically on the client side by the AG-UI run aggregator. Each emitted message includes timing metadata computed from stream chunk observations.
+
+```tsx
+import { useAgUiThreadRuntime } from "@assistant-ui/react-ag-ui";
+
+const runtime = useAgUiThreadRuntime({ runtimeUrl: "..." });
+// useMessageTiming() works out of the box
+```
+
+### OpenCode (`useOpenCodeRuntime`)
+
+Timing is tracked automatically on the client side by observing `OpenCodeThreadState` transitions and assistant message content deltas. No setup required.
+
+```tsx
+import { useOpenCodeRuntime } from "@assistant-ui/react-opencode";
+
+const runtime = useOpenCodeRuntime();
+// useMessageTiming() works out of the box
+```
+
 ## API Reference
 
 ### `useMessageTiming()`

package/.docs/raw/docs/guides/quoting.mdx

@@ -1,6 +1,6 @@
 ---
 title: Quote Selected Text
-description: Let users select and quote text from messages. Full guide including backend handling and programmatic API.
+description: Let users select text from AI messages and quote it back into the composer. Full quoting flow with backend handling and programmatic API in assistant-ui.
 platforms: ["react"]
 ---