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

package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx

@@ -1,11 +1,17 @@
 ---
 title: ErrorPrimitive
-description: Components for displaying error messages in the chat interface.
+description: Error primitives for rendering assistant-ui runtime, thread, and message failures inside custom chat interfaces.
 ---
 
-A component for displaying error messages in the UI.
+import { ErrorPrimitiveMessageProps, ErrorPrimitiveRootProps } from "@/generated/typeDocs";
+import { ErrorPrimitive as ErrorPrimitiveDocs } from "@/generated/primitiveDocs";
 
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
+For examples and usage patterns, see [Error](/docs/primitives/error).
+
+{/* api-manual:start */}
 ## Anatomy
 
 ```tsx
@@ -17,56 +23,43 @@ const ErrorDisplay = () => (
   </ErrorPrimitive.Root>
 );
 ```
+{/* api-manual:end */}
+
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
 ## API Reference
 
 ### Root
 
-Contains all parts of the error display. Renders a `<div>` element with `role="alert"`.
+{ErrorPrimitiveDocs.Root?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ErrorPrimitiveDocs.Root.deprecated}
+  </Callout>
+)}
 
-<ParametersTable
-  type="ErrorPrimitiveRootProps"
-  parameters={[
-    {
-      name: "asChild",
-      type: "boolean",
-      description:
-        "Change the component to the HTML tag or custom component of the only child.",
-    },
-  ]}
-/>
+{ErrorPrimitiveDocs.Root?.description}
 
-### Message
+{ErrorPrimitiveDocs.Root?.element && (
+  <p>This primitive renders a <code>{`<${ErrorPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ErrorPrimitiveRootProps} />
 
-Displays the error message. By default, it shows the error from the message context if available, or you can provide custom content.
+### Message
 
-<ParametersTable
-  type="ErrorPrimitiveMessageProps"
-  parameters={[
-    {
-      name: "children",
-      type: "ReactNode",
-      description:
-        "Optional custom content to display instead of the default error message.",
-    },
-  ]}
-/>
+{ErrorPrimitiveDocs.Message?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ErrorPrimitiveDocs.Message.deprecated}
+  </Callout>
+)}
 
-## Usage
+{ErrorPrimitiveDocs.Message?.description}
 
-The ErrorPrimitive is typically used within a MessagePrimitive.Error component to display error states in messages:
+{ErrorPrimitiveDocs.Message?.element && (
+  <p>This primitive renders a <code>{`<${ErrorPrimitiveDocs.Message?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-```tsx
-import { MessagePrimitive, ErrorPrimitive } from "@assistant-ui/react";
-
-const MessageWithError = () => (
-  <MessagePrimitive.Root>
-    <MessagePrimitive.Parts />
-    <MessagePrimitive.Error>
-      <ErrorPrimitive.Root>
-        <ErrorPrimitive.Message />
-      </ErrorPrimitive.Root>
-    </MessagePrimitive.Error>
-  </MessagePrimitive.Root>
-);
-```
+<ParametersTable {...ErrorPrimitiveMessageProps} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx

@@ -1,65 +1,70 @@
 ---
-title: Overview
-description: Generated API reference for assistant-ui React primitive namespaces and parts.
+title: Primitives API Reference
+description: "Composable React primitives for assistant-ui chat UIs: Thread, Composer, Message, BranchPicker, ActionBar, and the parts that build threads, message lists, attachments, and editing flows."
 ---
 
-{/* AUTO-GENERATED by scripts/generate-api-reference-overviews.mts */}
-{/* Do not edit manually. */}
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
 
-Primitives are the composable React components exported from `@assistant-ui/react`. These pages focus on parts, props, rendered elements, and composition behavior.
+{/* api-manual:start */}
+Primitives are the low-level React components behind assistant-ui interfaces. They provide accessible behavior, state wiring, and composition points while leaving layout and styling under your control.
+{/* api-manual:end */}
 
 ## Pages
 
 <Cards>
   <Card title={"ActionBarPrimitive"} href={"/docs/api-reference/primitives/action-bar"}>
-    {"Buttons for message actions like copy, edit, reload, speak, and feedback."}
+    {"Composable message action controls for copy, edit, reload, speech, and feedback in assistant-ui chat interfaces."}
   </Card>
   <Card title={"ActionBarMorePrimitive"} href={"/docs/api-reference/primitives/action-bar-more"}>
-    {"API reference for ActionBarMorePrimitive."}
+    {"Overflow menu primitives for grouping secondary assistant message actions in a custom React UI."}
   </Card>
   <Card title={"AuiIf"} href={"/docs/api-reference/primitives/assistant-if"}>
-    {"Conditional rendering component based on thread, message, or composer state."}
+    {"Conditional rendering primitive for showing React UI from assistant-ui thread, message, composer, and runtime state."}
   </Card>
   <Card title={"AssistantModalPrimitive"} href={"/docs/api-reference/primitives/assistant-modal"}>
-    {"A popover chat interface for floating assistant UI in the corner of the screen."}
+    {"Floating assistant modal primitives for building support chat, copilot, and embedded assistant experiences."}
   </Card>
   <Card title={"AttachmentPrimitive"} href={"/docs/api-reference/primitives/attachment"}>
-    {"Components for displaying and managing file attachments in messages and composer."}
+    {"Attachment primitives for rendering file previews, names, thumbnails, and remove controls in assistant-ui messages and composers."}
   </Card>
   <Card title={"BranchPickerPrimitive"} href={"/docs/api-reference/primitives/branch-picker"}>
-    {"Navigate between conversation branches with previous/next controls."}
+    {"Branch picker primitives for navigating regenerated assistant responses and alternate message paths inside a chat thread."}
+  </Card>
+  <Card title={"ChainOfThoughtPrimitive"} href={"/docs/api-reference/primitives/chain-of-thought"}>
+    {"Chain of thought primitives for rendering assistant reasoning, step lists, and collapsible disclosure UI in message content."}
   </Card>
   <Card title={"ComposerPrimitive"} href={"/docs/api-reference/primitives/composer"}>
-    {"Primitives for the text input, send button, and attachments."}
+    {"Composable input primitives for assistant-ui prompts, send controls, cancellation, attachments, and composer state."}
   </Card>
   <Card title={"ErrorPrimitive"} href={"/docs/api-reference/primitives/error"}>
-    {"Components for displaying error messages in the chat interface."}
+    {"Error primitives for rendering assistant-ui runtime, thread, and message failures inside custom chat interfaces."}
   </Card>
   <Card title={"MessagePrimitive"} href={"/docs/api-reference/primitives/message"}>
-    {"Components for rendering message content, parts, and attachments."}
+    {"Message primitives for rendering assistant and user turns, message parts, attachments, actions, editing, and branch controls."}
   </Card>
   <Card title={"MessagePartPrimitive"} href={"/docs/api-reference/primitives/message-part"}>
-    {"Primitives for text, images, tool calls, and other message content."}
+    {"Message part primitives for rendering text, tool calls, data parts, reasoning, source content, and custom assistant output."}
+  </Card>
+  <Card title={"QueueItemPrimitive"} href={"/docs/api-reference/primitives/queue-item"}>
+    {"Queue item primitives for rendering pending assistant-ui thread operations, optimistic work, and runtime queue state."}
   </Card>
   <Card title={"SelectionToolbarPrimitive"} href={"/docs/api-reference/primitives/selection-toolbar"}>
-    {"A floating toolbar that appears when text is selected within a message."}
+    {"Selection toolbar primitives for quote, copy, and contextual actions on selected chat text."}
   </Card>
   <Card title={"SuggestionPrimitive"} href={"/docs/api-reference/primitives/suggestion"}>
-    {"API reference for SuggestionPrimitive."}
+    {"Suggestion primitives for rendering starter prompts, follow-up actions, and composer suggestions in assistant-ui threads."}
   </Card>
   <Card title={"ThreadPrimitive"} href={"/docs/api-reference/primitives/thread"}>
-    {"Primitives for the message list, viewport, and welcome screen."}
+    {"Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui."}
   </Card>
   <Card title={"ThreadListPrimitive"} href={"/docs/api-reference/primitives/thread-list"}>
-    {"Display and manage multiple conversation threads with create and archive actions."}
+    {"Thread list primitives for rendering conversation navigation, new thread actions, and custom assistant sidebars."}
   </Card>
   <Card title={"ThreadListItemPrimitive"} href={"/docs/api-reference/primitives/thread-list-item"}>
-    {"Individual thread item with title, archive, and delete controls."}
+    {"Thread list item primitives for rendering selectable conversation rows with titles, archive controls, delete actions, and menus."}
   </Card>
   <Card title={"ThreadListItemMorePrimitive"} href={"/docs/api-reference/primitives/thread-list-item-more"}>
-    {"Dropdown menu for additional thread actions like archive and delete."}
-  </Card>
-  <Card title={"Composition"} href={"/docs/api-reference/primitives/composition"}>
-    {"How to compose primitives with custom components using asChild."}
+    {"Overflow menu primitives for secondary thread list item actions in custom assistant-ui sidebars."}
   </Card>
 </Cards>

package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx

@@ -1,65 +1,15 @@
 ---
 title: MessagePartPrimitive
-description: Primitives for text, images, tool calls, and other message content.
+description: Message part primitives for rendering text, tool calls, data parts, reasoning, source content, and custom assistant output.
 ---
 
-import {
-  MessagePartRuntime,
-  TextMessagePartState,
-  AudioMessagePartState,
-  ToolCallMessagePartState,
-} from "@/generated/typeDocs";
+import { MessagePartPrimitiveImageProps, MessagePartPrimitiveMessagesProps, MessagePartPrimitiveTextProps } from "@/generated/typeDocs";
+import { MessagePartPrimitive as MessagePartPrimitiveDocs } from "@/generated/primitiveDocs";
 
-Each message can have any number of message parts.
-Message parts are usually one of text, reasoning, audio, tool-call, or data.
-
-## Message part Types
-
-### Text
-
-Standard text content, used for both user and assistant messages.
-
-### Reasoning
-
-Exposes the assistant's reasoning process, showing how it arrived at its responses. This is typically used only in assistant messages.
-
-### Audio
-
-Audio content that can be played back.
-
-### Tool Call
-
-Interactive elements that represent tool operations.
-
-### Data
-
-Custom data events that can be rendered as UI at their position in the message stream. Each data part has a `name` and a `data` payload.
-
-You can use either the explicit format `{ type: "data", name: "workflow", data: {...} }` or the shorthand `data-*` prefixed format `{ type: "data-workflow", data: {...} }`. The prefixed format is automatically converted to a `DataMessagePart` (stripping the `data-` prefix as the `name`). Unknown message part types that don't match any built-in type are silently skipped with a console warning.
-
-#### Streaming Data Parts
-
-Data parts can be sent from the server using `appendData()` on the stream controller:
-
-```ts
-controller.appendData({
-  type: "data",
-  name: "chart",
-  data: { labels: ["Q1", "Q2"], values: [10, 20] },
-});
-```
-
-Register a renderer with `makeAssistantDataUI` to display data parts:
-
-```tsx
-import { makeAssistantDataUI } from "@assistant-ui/react";
-
-const ChartUI = makeAssistantDataUI({
-  name: "chart",
-  render: ({ data }) => <MyChart data={data} />,
-});
-```
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
+{/* api-manual:start */}
 ## Anatomy
 
 ```tsx
@@ -69,215 +19,83 @@ const TextMessagePart = () => {
   return <MessagePartPrimitive.Text />;
 };
 ```
+{/* api-manual:end */}
 
-## Primitives
-
-### Plain Text
-
-```tsx
-import { MessagePartPrimitive } from "@assistant-ui/react";
-
-<MessagePartPrimitive.Text />;
-```
-
-### Markdown Text
-
-Renders the message's text as Markdown.
-
-```tsx
-import { MarkdownTextPrimitive } from "@assistant-ui/react-markdown";
-
-<MarkdownTextPrimitive />;
-```
-
-### Audio
-
-Coming soon.
-
-### InProgress
-
-Renders children only if the message part is in progress.
-
-```tsx
-import { MessagePartPrimitive } from "@assistant-ui/react";
-
-<MessagePartPrimitive.InProgress>
-  <LoadingIndicator />
-</MessagePartPrimitive.InProgress>;
-```
-
-### Tool UI
-
-You can map tool calls to UI components. We provide a few utility functions to make this easier, such as `makeAssistantToolUI`.
-
-```tsx
-const MyWeatherToolUI = makeAssistantToolUI({
-  toolName: "get_weather",
-  render: function MyWeatherToolUI({ args, result }) {
-    return (
-      <div className="mb-4 flex flex-col items-center">
-        <pre className="whitespace-pre-wrap break-all text-center">
-          get_weather({JSON.stringify(args)})
-        </pre>
-        {result !== undefined && (
-          <pre className="whitespace-pre-wrap break-all text-center">
-            {JSON.stringify(result)}
-          </pre>
-        )}
-      </div>
-    );
-  },
-});
-```
-
-### Data UI
-
-You can map data events to UI components, similar to tool UIs. There are two approaches:
-
-#### Inline configuration
-
-Pass a `data` config to `MessagePrimitive.Parts`:
-
-```tsx
-<MessagePrimitive.Parts>
-  {({ part }) => {
-    if (part.type === "data" && part.name === "my_chart") return <ChartComponent data={part.data} />;
-    if (part.type === "data") return <pre>{JSON.stringify(part.data, null, 2)}</pre>;
-    return null;
-  }}
-</MessagePrimitive.Parts>
-```
-
-#### Global registration
-
-Use `makeAssistantDataUI` or `useAssistantDataUI` to register data UIs globally. Global registrations take priority over inline configuration.
-
-```tsx
-import { makeAssistantDataUI } from "@assistant-ui/react";
-
-const MyChartUI = makeAssistantDataUI({
-  name: "my_chart",
-  render: ({ name, data }) => <ChartComponent data={data} />,
-});
-
-// Place inside AssistantRuntimeProvider
-function App() {
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      <Thread />
-      <MyChartUI />
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-The hook variant allows access to component state:
-
-```tsx
-import { useAssistantDataUI } from "@assistant-ui/react";
-
-function MyComponent() {
-  useAssistantDataUI({
-    name: "my_chart",
-    render: ({ name, data }) => <ChartComponent data={data} />,
-  });
-  return null;
-}
-```
-
-Each data component receives the full data part as props: `{ type: "data", name: string, data: T, status: MessagePartStatus }`.
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-For a catch-all renderer (e.g. LangSmith's [`LoadExternalComponent`](/docs/runtimes/langgraph#dynamic-loading-with-fallback) loaded at runtime), pass `Fallback` via the inline `data` config on `MessagePrimitive.Parts`, or use the LangGraph adapter's [`uiComponents.fallback`](/docs/runtimes/langgraph#dynamic-loading-with-fallback) option.
+## API Reference
 
-### Messages (Sub-Agent)
-
-Renders nested messages from a tool call part's `messages` field. This is used in multi-agent setups where a sub-agent's conversation is embedded inside a tool call.
-
-```tsx
-import { MessagePartPrimitive } from "@assistant-ui/react";
-
-<MessagePartPrimitive.Messages>
-  {({ message }) => {
-    if (message.role === "user") return <MyUserMessage />;
-    return <MyAssistantMessage />;
-  }}
-</MessagePartPrimitive.Messages>;
-```
-
-This primitive must be used inside a tool call part context (e.g. inside a `makeAssistantToolUI` render function). It reads the `messages` field from the current `ToolCallMessagePart` and renders them in a readonly thread context.
+### Text
 
-Parent tool UI registrations are inherited — tools registered via `makeAssistantToolUI` at the parent level are available inside sub-agent messages.
+{MessagePartPrimitiveDocs.Text?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Text.deprecated}
+  </Callout>
+)}
 
-See the [Multi-Agent Guide](/docs/guides/multi-agent) for detailed usage.
+{MessagePartPrimitiveDocs.Text?.description}
 
-## Context Provider
+{MessagePartPrimitiveDocs.Text?.element && (
+  <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Text?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-Message part context is provided by `MessagePrimitive.Parts` or `TextMessagePartProvider`
+<ParametersTable {...MessagePartPrimitiveTextProps} />
 
-### MessagePrimitive.Parts
+{/* api-manual:MessagePartPrimitive.Text:start */}
+| Data attribute | Values |
+| --- | --- |
+| `[data-status]` | `"running"`, `"complete"`, or `"incomplete"` |
+{/* api-manual:MessagePartPrimitive.Text:end */}
 
-```tsx
-import { MessagePrimitive } from "@assistant-ui/react";
+### Image
 
-<MessagePrimitive.Parts>
-  {({ part }) => {
-    if (part.type === "text") return <MyText />;
-    if (part.type === "reasoning") return <MyReasoning {...part} />;
-    if (part.type === "audio") return <MyAudio {...part} />;
-    if (part.type === "tool-call" && part.toolName === "get_weather") return <MyWeatherToolUI {...part} />;
-    if (part.type === "tool-call") return <MyFallbackToolUI {...part} />;
-    if (part.type === "data" && part.name === "my_chart") return <MyChartComponent {...part} />;
-    if (part.type === "data") return <GenericDataComponent {...part} />;
-    return null;
-  }}
-</MessagePrimitive.Parts>;
-```
+{MessagePartPrimitiveDocs.Image?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Image.deprecated}
+  </Callout>
+)}
 
-### TextMessagePartProvider
+{MessagePartPrimitiveDocs.Image?.description}
 
-This is a helper context provider to allow you to reuse the message part components outside a message part.
+{MessagePartPrimitiveDocs.Image?.element && (
+  <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Image?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-```tsx
-import { TextMessagePartProvider } from "@assistant-ui/react";
+<ParametersTable {...MessagePartPrimitiveImageProps} />
 
-<TextMessagePartProvider text="Hello world" isRunning={false}>
-  <MessagePartPrimitive.Text />
-</TextMessagePartProvider>;
-```
-
-## Runtime API
-
-### `useAui` (Message Part Actions)
-
-```tsx
-import { useAui } from "@assistant-ui/react";
-
-const aui = useAui();
-aui.part().addToolResult(result);
-const partState = aui.part().getState();
-```
+### InProgress
 
-<ParametersTable {...MessagePartRuntime} />
+{MessagePartPrimitiveDocs.InProgress?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.InProgress.deprecated}
+  </Callout>
+)}
 
-### `useAuiState` (Message Part State)
+{MessagePartPrimitiveDocs.InProgress?.description}
 
-```tsx
-import { useAuiState } from "@assistant-ui/react";
+{MessagePartPrimitiveDocs.InProgress?.element && (
+  <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.InProgress?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-const type = useAuiState((s) => s.part.type);
-const status = useAuiState((s) => s.part.status);
-```
+{MessagePartPrimitiveDocs.InProgress?.props && (
+  <ParametersTable type={MessagePartPrimitiveDocs.InProgress?.element} parameters={MessagePartPrimitiveDocs.InProgress.props} />
+)}
 
-<ParametersTable {...TextMessagePartState} />
-<ParametersTable {...AudioMessagePartState} />
-<ParametersTable {...ToolCallMessagePartState} />
+### Messages
 
-### `useMessagePartText`
+{MessagePartPrimitiveDocs.Messages?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {MessagePartPrimitiveDocs.Messages.deprecated}
+  </Callout>
+)}
 
-```tsx
-import { useMessagePartText } from "@assistant-ui/react";
+{MessagePartPrimitiveDocs.Messages?.description}
 
-const { text, status } = useMessagePartText();
-```
+{MessagePartPrimitiveDocs.Messages?.element && (
+  <p>This primitive renders a <code>{`<${MessagePartPrimitiveDocs.Messages?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-<ParametersTable {...TextMessagePartState} />
+<ParametersTable {...MessagePartPrimitiveMessagesProps} />
+{/* api-reference:end */}