@assistant-ui/mcp-docs-server 0.1.30 → 0.1.32

package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx

@@ -1,87 +1,32 @@
 ---
 title: ComposerRuntime
-description: Runtime for programmatically controlling the message composer.
+description: ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and pending input.
 ---
 
-The composer runtime allows you to view or edit anything related to how new information is added and sent. For instance you can use the composer runtime to read the state, add attachments, update text, send a message, etc.
+import { ComposerRuntime, ComposerState, EditComposerRuntime, EditComposerState } from "@/generated/typeDocs";
 
-import { ComposerRuntime, ThreadComposerRuntime, EditComposerRuntime, ThreadComposerState } from "@/generated/typeDocs";
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-### `useAui` (Composer Actions)
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-Grabs the nearest composer (whether it’s the edit composer or the thread’s composer) via `useAui`:
+## API Reference
 
-```tsx
-// Example
-import { useAui } from "@assistant-ui/react";
-
-const aui = useAui();
-
-// set the text
-aui.composer().setText("Hello from the composer");
-
-// send whatever is in the composer
-aui.composer().send();
-
-// get the current text in the composer state
-const composerState = aui.composer().getState();
-const currentText = composerState.text;
-
-```
+### ComposerRuntime
 
 <ParametersTable {...ComposerRuntime} />
 
+### ComposerState
 
-### `useAuiState` (Thread Composer State)
-
-Access the thread’s new message composer state:
-
-```tsx
-import { useAuiState, useAui } from "@assistant-ui/react";
-
-const text = useAuiState((s) => s.composer.text);
-const isEmpty = useAuiState((s) => s.composer.isEmpty);
-
-// For actions, use useAui
-const aui = useAui();
-
-// set the text
-aui.composer().setText("Hello from the thread composer");
-
-// send whatever is in the thread composer
-aui.composer().send();
-
-```
+<ParametersTable {...ComposerState} />
 
-<ParametersTable {...ThreadComposerRuntime} />
-
-
-### `useAui` (Edit Composer Actions)
-
-Access edit composer actions via `useAui` from within a message component:
-
-```tsx
-import { useAui } from "@assistant-ui/react";
-
-const aui = useAui();
-
-// Begin editing the current message (populates the composer with its content)
-aui.message().composer().beginEdit();
-
-// Update the text and send the edit
-aui.message().composer().setText("Updated message text");
-aui.message().composer().send();
-
-// Cancel editing without saving
-aui.message().composer().cancel();
-```
+### EditComposerRuntime
 
 <ParametersTable {...EditComposerRuntime} />
 
-### `ThreadComposerState`
-
-The state of the thread composer which is the composer the user can interact with at the bottom.
-
-<ParametersTable {...ThreadComposerState} />
-
+### EditComposerState
 
+<ParametersTable {...EditComposerState} />
+{/* api-reference:end */}

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

@@ -0,0 +1,43 @@
+---
+title: Runtime State API Reference
+description: Runtime state and actions exposed through useAui and useAuiState, covering AssistantRuntime, ThreadRuntime, ThreadListRuntime, ComposerRuntime, MessageRuntime, and attachment APIs for controlling assistant-ui chat.
+---
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
+
+{/* api-manual:start */}
+Runtime state is the typed control surface behind assistant-ui. These pages document the actions and state objects available through `useAui`, `useAuiState`, and scoped runtimes.
+{/* api-manual:end */}
+
+## Pages
+
+<Cards>
+  <Card title={"AssistantRuntime"} href={"/docs/api-reference/runtimes/assistant-runtime"}>
+    {"Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior."}
+  </Card>
+  <Card title={"AttachmentRuntime"} href={"/docs/api-reference/runtimes/attachment-runtime"}>
+    {"AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers."}
+  </Card>
+  <Card title={"ComposerRuntime"} href={"/docs/api-reference/runtimes/composer-runtime"}>
+    {"ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and pending input."}
+  </Card>
+  <Card title={"MessagePartRuntime"} href={"/docs/api-reference/runtimes/message-part-runtime"}>
+    {"MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom message content."}
+  </Card>
+  <Card title={"MessageRuntime"} href={"/docs/api-reference/runtimes/message-runtime"}>
+    {"MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages."}
+  </Card>
+  <Card title={"QueueItemState"} href={"/docs/api-reference/runtimes/queue-state"}>
+    {"State shape for queued assistant-ui thread operations and pending runtime work."}
+  </Card>
+  <Card title={"ThreadListItemRuntime"} href={"/docs/api-reference/runtimes/thread-list-item-runtime"}>
+    {"ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conversations."}
+  </Card>
+  <Card title={"ThreadListRuntime"} href={"/docs/api-reference/runtimes/thread-list-runtime"}>
+    {"ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation."}
+  </Card>
+  <Card title={"ThreadRuntime"} href={"/docs/api-reference/runtimes/thread-runtime"}>
+    {"ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the full thread lifecycle."}
+  </Card>
+</Cards>

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

@@ -1,46 +1,43 @@
 ---
 title: MessagePartRuntime
-description: Hook for accessing message part state within parts.
+description: MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom message content.
 ---
 
-import { MessagePartRuntime, TextMessagePartState } from "@/generated/typeDocs";
+import { EnrichedPartState, MessagePartRuntime, MessagePartState, PartState } from "@/generated/typeDocs";
 
-### `useAui` (Message Part Actions)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access message part actions via `useAui`:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+## API Reference
 
-const aui = useAui();
+### EnrichedPartState
 
-// Add a tool result to a tool-call message part
-aui.part().addToolResult({ result: "Tool output" });
+Enriched part state passed to children render functions.
 
-// Resume an interrupted tool call
-aui.part().resumeToolCall({ approved: true });
-```
+For tool-call parts, adds `toolUI`, `addResult`, and `resume`.
+For data parts, adds `dataRendererUI`.
 
-<ParametersTable {...MessagePartRuntime} />
-
-### `useAuiState` (Message Part State)
+The render function is also invoked once with a synthetic empty text part
+(`{ type: "text", text: "", status: { type: "running" } }`) when the
+assistant message has no parts yet but is in the running state, so a
+loading indicator can render. Differentiate this from a real empty text
+via `part.status?.type === "running" && part.text === ""`.
 
-Access the message part state reactively:
+<ParametersTable {...EnrichedPartState} />
 
-```tsx
-import { useAuiState } from "@assistant-ui/react";
+### MessagePartRuntime
 
-const status = useAuiState((s) => s.part.status);
-const type = useAuiState((s) => s.part.type);
-```
+<ParametersTable {...MessagePartRuntime} />
 
-For imperative access, use `useAui`:
+### MessagePartState
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+<ParametersTable {...MessagePartState} />
 
-const aui = useAui();
-const partState = aui.part().getState();
-```
+### PartState
 
-<ParametersTable {...TextMessagePartState} />
+<ParametersTable {...PartState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx

@@ -1,76 +1,24 @@
 ---
 title: MessageRuntime
-description: Hooks for accessing message state and edit composer.
+description: MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages.
 ---
 
-import {
-  MessageRuntime,
-  MessageState,
-  ComposerState,
-} from "@/generated/typeDocs";
+import { MessageRuntime, MessageState } from "@/generated/typeDocs";
 
-### `useAui` (Message Actions)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access message actions via `useAui`:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+## API Reference
 
-const aui = useAui();
-
-// Reload an assistant message (regenerate the response)
-aui.message().reload();
-
-// Switch to the previous or next branch
-aui.message().switchToBranch({ position: "previous" });
-aui.message().switchToBranch({ position: "next" });
-
-// Submit feedback on a message
-aui.message().submitFeedback({ type: "positive" });
-aui.message().submitFeedback({ type: "negative" });
-
-// Get the plain-text content of the message
-const text = aui.message().getCopyText();
-
-// Access a message part by index or tool call ID
-aui.message().part({ index: 0 });
-aui.message().part({ toolCallId: "call_123" });
-
-// Access an attachment by index
-aui.message().attachment({ index: 0 });
-
-// Access the edit composer for this message
-aui.message().composer();
-
-// Get a snapshot of the full message state
-const state = aui.message().getState();
-```
+### MessageRuntime
 
 <ParametersTable {...MessageRuntime} />
 
-### `useAuiState` (Message State)
-
-Access message state reactively:
-
-```tsx
-import { useAuiState } from "@assistant-ui/react";
-
-const role = useAuiState((s) => s.message.role);
-const content = useAuiState((s) => s.message.content);
-const isLast = useAuiState((s) => s.message.isLast);
-```
+### MessageState
 
 <ParametersTable {...MessageState} />
-
-### `useAuiState` (Edit Composer)
-
-Access the edit composer state (used when editing a message):
-
-```tsx
-import { useAuiState } from "@assistant-ui/react";
-
-const editText = useAuiState((s) => s.message.composer.text);
-const isEditing = useAuiState((s) => s.message.composer.isEditing);
-```
-
-<ParametersTable {...ComposerState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx

@@ -0,0 +1,20 @@
+---
+title: QueueItemState
+description: State shape for queued assistant-ui thread operations and pending runtime work.
+---
+
+import { QueueItemState } 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
+
+### QueueItemState
+
+<ParametersTable {...QueueItemState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx

@@ -1,61 +1,24 @@
 ---
 title: ThreadListItemRuntime
-description: Runtime for managing individual thread list items.
+description: ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conversations.
 ---
 
-import {
-  ThreadListItemRuntime,
-  ThreadListItemState,
-} from "@/generated/typeDocs";
+import { ThreadListItemRuntime, ThreadListItemState } from "@/generated/typeDocs";
 
-### `useAui` (Thread List Item Actions)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access thread list item actions via `useAui`:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+## API Reference
 
-const aui = useAui();
-
-// Navigation
-await aui.threadListItem().switchTo();
-
-// Rename
-await aui.threadListItem().rename("New Title");
-
-// Archive / unarchive
-await aui.threadListItem().archive();
-await aui.threadListItem().unarchive();
-
-// Delete
-await aui.threadListItem().delete();
-
-// Initialize a new thread (returns remoteId and externalId)
-const { remoteId, externalId } = await aui.threadListItem().initialize();
-
-// Auto-generate a title from thread content
-await aui.threadListItem().generateTitle();
-
-// Detach the thread list item from its thread
-aui.threadListItem().detach();
-
-// Get current state
-const state = aui.threadListItem().getState();
-const { id, title, status } = state;
-```
+### ThreadListItemRuntime
 
 <ParametersTable {...ThreadListItemRuntime} />
 
-### `useAuiState` (Thread List Item State)
-
-Access the state for a specific thread list item:
-
-```tsx
-import { useAuiState } from "@assistant-ui/react";
-
-const title = useAuiState((s) => s.threadListItem.title);
-const status = useAuiState((s) => s.threadListItem.status);
-const id = useAuiState((s) => s.threadListItem.id);
-```
+### ThreadListItemState
 
 <ParametersTable {...ThreadListItemState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx

@@ -1,56 +1,24 @@
 ---
 title: ThreadListRuntime
-description: Runtime for accessing and managing the list of threads.
+description: ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation.
 ---
 
 import { ThreadListRuntime, ThreadListState } from "@/generated/typeDocs";
 
-### `useAui` (Thread List Actions)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access thread list actions via `useAui`:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+## API Reference
 
-const aui = useAui();
-
-// Switch threads
-await aui.threads().switchToNewThread();
-await aui.threads().switchToThread(threadId);
-
-// Re-fetch the thread list from the remote adapter
-// (e.g. after async auth completes)
-await aui.threads().reload();
-
-// Access the main thread runtime
-const mainThread = aui.threads().main;
-
-// Access a thread by ID
-const thread = aui.threads().getById(threadId);
-
-// Access thread list items
-const mainItem = aui.threads().mainItem;
-const itemByIndex = aui.threads().getItemByIndex(0);
-const itemById = aui.threads().getItemById(threadId);
-const archivedItem = aui.threads().getArchivedItemByIndex(0);
-
-// Get current state
-const state = aui.threads().getState();
-const threadIds = state.threadIds;
-const archivedThreadIds = state.archivedThreadIds;
-```
+### ThreadListRuntime
 
 <ParametersTable {...ThreadListRuntime} />
 
-### `useAuiState` (Thread List State)
-
-Access thread list state reactively:
-
-```tsx
-import { useAuiState } from "@assistant-ui/react";
-
-const threads = useAuiState((s) => s.threads.threadIds);
-const isLoading = useAuiState((s) => s.threads.isLoading);
-```
+### ThreadListState
 
 <ParametersTable {...ThreadListState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx

@@ -1,48 +1,36 @@
 ---
 title: ThreadRuntime
-description: Runtime for thread state, messages, and viewport management.
+description: ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the full thread lifecycle.
 ---
 
-import { ThreadRuntime, ThreadState } from "@/generated/typeDocs";
-import { ThreadViewportState } from "@/components/docs/parameters-table.context";
+import { ThreadComposerRuntime, ThreadComposerState, ThreadRuntime, ThreadState, ThreadViewportState } from "@/generated/typeDocs";
 
-### `useAui` (Thread Actions)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access thread actions via `useAui`:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAui } from "@assistant-ui/react";
+## API Reference
 
-const aui = useAui();
-aui.thread().cancelRun();
-aui.thread().append({ role: "user", content: [{ type: "text", text: "Hello" }] });
-```
+### ThreadComposerRuntime
 
-<ParametersTable {...ThreadRuntime} />
-
-### `useAuiState` (Thread State)
-
-Access the thread state reactively:
+<ParametersTable {...ThreadComposerRuntime} />
 
-```tsx
-import { useAuiState } from "@assistant-ui/react";
+### ThreadComposerState
 
-const isRunning = useAuiState((s) => s.thread.isRunning);
-const isLoading = useAuiState((s) => s.thread.isLoading);
-const messages = useAuiState((s) => s.thread.messages);
-```
+<ParametersTable {...ThreadComposerState} />
 
-<ParametersTable {...ThreadState} />
+### ThreadRuntime
 
-### `useThreadViewport`
+<ParametersTable {...ThreadRuntime} />
 
-Manage thread viewport state (e.g., scrolling):
+### ThreadState
 
-```tsx
-import { useThreadViewport } from "@assistant-ui/react";
+<ParametersTable {...ThreadState} />
 
-const threadViewport = useThreadViewport();
-const isAtBottom = useThreadViewport((m) => m.isAtBottom);
-```
+### ThreadViewportState
 
 <ParametersTable {...ThreadViewportState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx

@@ -0,0 +1,68 @@
+---
+title: Component Tools
+description: Register assistant tools from mounted React components, scoped to the lifetime of part of the UI tree.
+---
+
+import { useAssistantTool } from "@/generated/typeDocs";
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
+
+{/* api-manual:start */}
+`useAssistantTool` and `makeAssistantTool` register a single tool while a React component is mounted, and remove it on unmount.
+
+Use these APIs when a tool's availability should follow a specific UI surface — for example, a tool that operates on whatever is currently selected in a panel that may or may not be present. For tools that should be available throughout an assistant subtree regardless of which UI is mounted, see [Toolkits](/docs/api-reference/tools/toolkits).
+{/* api-manual:end */}
+
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
+
+## API Reference
+
+### makeAssistantTool
+
+Creates a React component that registers an assistant tool when rendered.
+
+Use this when exporting reusable tool modules that can be included in JSX
+rather than calling [useAssistantTool](/docs/api-reference/tools/component-tools#useassistanttool) directly.
+
+```ts
+type AssistantToolProps = CoreAssistantToolProps<TArgs, TResult> & {
+  /** Component used to render calls to this tool in assistant messages. */
+  render?: ToolCallMessagePartComponent<TArgs, TResult> | undefined;
+};
+
+const makeAssistantTool: <TArgs extends Record<string, unknown>, TResult>(tool: AssistantToolProps<TArgs, TResult>) => AssistantTool;
+```
+
+### useAssistantTool
+
+Registers a tool with the assistant model context while the component is
+mounted.
+
+If `render` is provided, it is also installed as the renderer for matching
+tool-call message parts. The registration is removed automatically when the
+component unmounts or the tool definition changes.
+
+Pass a referentially stable tool object, such as one declared at module
+scope or memoized with `useMemo`, to avoid re-registering on every render.
+
+```tsx
+const weatherTool = {
+  toolName: "get_weather",
+  type: "frontend",
+  description: "Get the weather for a city.",
+  parameters: weatherSchema,
+  execute: async ({ city }: { city: string }) => fetchWeather(city),
+  render: WeatherToolUI,
+} satisfies AssistantToolProps<{ city: string }, Weather>;
+
+function WeatherToolRegistration() {
+  useAssistantTool(weatherTool);
+  return null;
+}
+```
+
+<ParametersTable {...useAssistantTool} />
+{/* api-reference:end */}

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

@@ -0,0 +1,39 @@
+---
+title: Tools API Reference
+description: Tool definitions, React renderers, status helpers, and toolkits for exposing callable app capabilities to assistant-ui chat models.
+---
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
+
+{/* api-manual:start */}
+Use these APIs when your assistant needs to call application code, render a custom tool result, or expose tool state inside a React UI.
+
+Tool **registration** has two scopes. Pick the one that matches the lifecycle you want for the tool. Tool **rendering** and **status** are independent of either choice and apply to both.
+
+| | `Tools({ toolkit })` | `useAssistantTool` / `makeAssistantTool` |
+| --- | --- | --- |
+| Scope | Entire assistant subtree below the mount point | Only while the registering React component is mounted |
+| Lifecycle | Tied to the runtime / provider tree | Tied to a specific UI surface |
+| Typical use | App-wide tools, MCP merging, tools defined alongside the runtime | Tools whose availability depends on a UI being visible |
+| Stable reference | Pass a stable `toolkit` (module scope or `useMemo`) | Pass a stable tool object (module scope or `useMemo`) |
+
+Both styles can coexist in the same app, and tools registered through either path participate in rendering and status APIs the same way.
+{/* api-manual:end */}
+
+## Pages
+
+<Cards>
+  <Card title={"Toolkits"} href={"/docs/api-reference/tools/toolkits"}>
+    {"Define model-facing tools and compose them into named toolkits registered with an assistant-ui runtime scope."}
+  </Card>
+  <Card title={"Component Tools"} href={"/docs/api-reference/tools/component-tools"}>
+    {"Register assistant tools from mounted React components, scoped to the lifetime of part of the UI tree."}
+  </Card>
+  <Card title={"Tool Rendering"} href={"/docs/api-reference/tools/rendering"}>
+    {"Register React renderers for assistant-ui tool calls, tool results, and model data parts."}
+  </Card>
+  <Card title={"Tool Status"} href={"/docs/api-reference/tools/status"}>
+    {"Read tool arguments, execution status, and result state inside assistant-ui tool UI components."}
+  </Card>
+</Cards>