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

package/.docs/raw/docs/(reference)/api-reference/overview.mdx

@@ -1,566 +0,0 @@
----
-title: API Reference
-description: Complete assistant-ui React API reference for building AI chat UIs with primitives, hooks, runtimes, adapters, tools, transport, voice, and integrations.
----
-
-{/* api-reference:skip-auto-generation */}
-
-import { Component, ContextLevel } from "./context";
-
-export const contextColors = {
-  "Assistant Context": "#4a86e8",
-  "Thread Context": "#45a049",
-  "Composer Context": "#ff9933",
-  "Message Context": "#bb2244",
-  "MessagePart Context": "#268bd2",
-  "Attachment Context": "#FFB6C1",
-  "ThreadListItem Context": "#c678dd",
-};
-
-## Start Here
-
-The React API reference is organized by how you build with assistant-ui:
-
-<Cards>
-  <Card title="Tools" href="/docs/api-reference/tools">
-    Define toolkits, install tool resources, and render tool or data parts.
-  </Card>
-  <Card title="Model Context" href="/docs/api-reference/model-context/context">
-    Provide instructions, merge model context, and register inline renderers for model-facing state.
-  </Card>
-  <Card title="Transport" href="/docs/api-reference/transport/assistant-transport">
-    Assistant transport, frame provider, and serialized frame protocol APIs for cross-boundary runtimes.
-  </Card>
-  <Card title="External Store" href="/docs/api-reference/external-store/runtime">
-    Runtime and message conversion APIs for apps that own their message store.
-  </Card>
-  <Card title="Voice" href="/docs/api-reference/voice/session">
-    Realtime voice sessions, speech synthesis adapters, and dictation adapters.
-  </Card>
-  <Card title="Primitives" href="/docs/api-reference/primitives/thread">
-    Composable React components such as `ThreadPrimitive`, `MessagePrimitive`, and `ComposerPrimitive`.
-  </Card>
-  <Card title="Hooks" href="/docs/api-reference/hooks/state">
-    Reactive state hooks, runtime hooks, model context hooks, and utility hooks.
-  </Card>
-  <Card title="Adapters" href="/docs/api-reference/adapters/model">
-    Runtime extension points for attachments, persistence, feedback, speech, dictation, and suggestions.
-  </Card>
-  <Card title="Integrations" href="/docs/api-reference/integrations/ai-sdk">
-    Package-level APIs for integrations such as `@assistant-ui/ai-sdk` and `@assistant-ui/cloud-ai-sdk`.
-  </Card>
-  <Card title="Runtime State" href="/docs/api-reference/runtimes/assistant-runtime">
-    Runtime action and state shapes used by `useAui` and `useAuiState`.
-  </Card>
-</Cards>
-
-The lower sections on this page show how the core React contexts nest and where the primary primitives, hooks, and runtime objects are available. Feature-first APIs such as tools, model context, transport, external store, and voice now live in their own generated sections.
-
-## Highest Level Context Providers
-
-<Component
-  name="AssistantRuntimeProvider"
-  isContextProvider={true}
-  providedContexts={[
-    { name: "Assistant Context", color: contextColors["Assistant Context"] },
-    { name: "Thread Context", color: contextColors["Thread Context"] },
-    {
-      name: "Thread Composer Context",
-      color: contextColors["Composer Context"],
-      link: "#composer-context",
-    },
-  ]}
-  docsLink="/docs/api-reference/context-providers/assistant-runtime-provider"
-  tooltip="Provides the highest level context for the assistant-ui"
-  props="runtime={runtime}"
->
-  <Component
-    name="ThreadPrimitive"
-    docsLink="/docs/api-reference/primitives/thread"
-    tooltip="Thread primitive components"
-  />
-  <Component
-    name="ThreadListPrimitive"
-    docsLink="/docs/api-reference/primitives/thread-list"
-    tooltip="Thread list primitive components"
-  />
-</Component>
-
-<Component
-  name="TextMessagePartProvider"
-  isContextProvider={true}
-  providedContexts={[
-    {
-      name: "Text MessagePart Context",
-      color: contextColors["MessagePart Context"],
-      link: "#messagepart-context",
-    },
-  ]}
-  docsLink="/docs/api-reference/context-providers/scoped-providers"
-  tooltip="Provides context for text message parts"
-  props="text={text}"
->
-  <Component
-    name="MessagePartPrimitive"
-    docsLink="/docs/api-reference/primitives/message-part"
-    tooltip="Message part primitive components"
-  />
-</Component>
-
-<ContextLevel color={contextColors["Assistant Context"]}>
-
-## Assistant Context
-
-The context available to components inside `<AssistantRuntimeProvider />`. You usually wrap your entire application in this context.
-
-### AssistantRuntime
-
-Programmatically access the assistant's state and actions via `useAui()`.
-
-### Instructions
-
-Add system prompt instructions
-
-- [`useAssistantInstructions`](/docs/api-reference/model-context/context)
-
-### Tool UI
-
-Register toolkits and tool UIs
-
-- [`Toolkit`](/docs/api-reference/tools/toolkits#toolkit)
-- [`Tools`](/docs/api-reference/tools/toolkits#tools)
-
-Programmatically access the list of registered tool UIs via `useAuiState((s) => s.tools)` and `useAui().tools()`.
-
-### ThreadListPrimitive
-
-Shows a list of threads and allows the user to switch between them.
-
-<Component
-  name="ThreadListPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/thread-list"
-  tooltip="Root component for the thread list"
->
-  <Component
-    name="ThreadListPrimitive.New"
-    docsLink="/docs/api-reference/primitives/thread-list"
-    tooltip="Component for creating a new thread"
-  />
-  <Component
-    name="ThreadListPrimitive.Items"
-    isContextProvider={true}
-    providedContexts={[
-      {
-        name: "ThreadListItem Context",
-        color: contextColors["ThreadListItem Context"],
-      },
-    ]}
-    docsLink="/docs/api-reference/primitives/thread-list"
-    tooltip="Container for thread list items, provides context for individual items"
-    props="components={...}"
-  />
-</Component>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["Thread Context"]}>
-
-## Thread Context
-
-The context for a single thread. Currently always corresponds to the runtime's main thread.
-
-### ThreadRuntime
-
-Programmatically access the thread's state and actions.
-
-- State: `useAuiState((s) => s.thread)`
-- Actions: `useAui().thread()`
-- Composer: `useAuiState((s) => s.composer)`
-
-### ModelContext
-
-- `useAui().thread().getModelContext()`
-
-### ThreadViewportStore
-
-- [`useThreadViewport`](/docs/api-reference/hooks/primitives)
-- [`useThreadViewportStore`](/docs/api-reference/hooks/primitives)
-
-### ThreadPrimitive
-
-A conversation thread.
-
-<Component
-  name="ThreadPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/thread"
-  tooltip="Root component for a thread"
->
-  <Component
-    name="ThreadPrimitive.Viewport"
-    docsLink="/docs/api-reference/primitives/thread"
-    tooltip="Viewport for the thread content"
-  >
-    <Component
-      name="ThreadPrimitive.Messages"
-      isContextProvider={true}
-      providedContexts={[
-        { name: "Message Context", color: contextColors["Message Context"] },
-        {
-          name: "Edit Composer Context",
-          color: contextColors["Composer Context"],
-          link: "#composer-context",
-        },
-      ]}
-      docsLink="/docs/api-reference/primitives/thread"
-      tooltip="Container for thread messages, provides context for messages and edit composer"
-    >
-      <Component
-        name="MessagePrimitive"
-        docsLink="/docs/api-reference/primitives/message"
-        tooltip="Message primitive components"
-      />
-    </Component>
-    <Component
-      name="ThreadPrimitive.ScrollToBottom"
-      docsLink="/docs/api-reference/primitives/thread"
-      tooltip="Scrolls to the bottom of the thread"
-    />
-    <Component
-      name="AuiIf"
-      docsLink="/docs/api-reference/primitives/assistant-if"
-      tooltip="Conditional rendering based on assistant state"
-    />
-    <Component
-      name="ThreadPrimitive.Suggestion"
-      docsLink="/docs/api-reference/primitives/thread"
-      tooltip="Displays suggestions in the thread"
-    />
-    <Component
-      name="ComposerPrimitive"
-      docsLink="/docs/api-reference/primitives/composer"
-      tooltip="Composer primitive components"
-    />
-  </Component>
-</Component>
-
-### AssistantModalPrimitive
-
-A floating modal that usually appears in the lower right corner of the screen. Common for support use cases.
-
-<Component
-  name="AssistantModalPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/assistant-modal"
-  tooltip="Root component for the assistant modal"
->
-  <Component
-    name="AssistantModalPrimitive.Trigger"
-    docsLink="/docs/api-reference/primitives/assistant-modal"
-    tooltip="Trigger to open the assistant modal"
-  />
-  <Component
-    name="AssistantModalPrimitive.Anchor"
-    docsLink="/docs/api-reference/primitives/assistant-modal"
-    tooltip="Anchor point for the assistant modal"
-  />
-  <Component
-    name="AssistantModalPrimitive.Content"
-    docsLink="/docs/api-reference/primitives/assistant-modal"
-    tooltip="Content of the assistant modal"
-  />
-</Component>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["Composer Context"]}>
-
-## Composer Context
-
-Manages the state and actions for the message composer
-
-### ComposerRuntime
-
-- State: `useAuiState((s) => s.composer)`
-- Actions: `useAui().composer()`
-
-### ComposerPrimitive
-
-<Component
-  name="ComposerPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/composer"
-  tooltip="Root component for the composer"
->
-  <Component
-    name="ComposerPrimitive.Input"
-    docsLink="/docs/api-reference/primitives/composer"
-    tooltip="Input field for composing messages"
-  />
-  <Component
-    name="ComposerPrimitive.Send"
-    docsLink="/docs/api-reference/primitives/composer"
-    tooltip="Button to send the composed message"
-  />
-  <Component
-    name="ComposerPrimitive.Cancel"
-    docsLink="/docs/api-reference/primitives/composer"
-    tooltip="Button to cancel composing"
-  />
-  <Component
-    name="ComposerPrimitive.Attachments"
-    isContextProvider={true}
-    providedContexts={[
-      {
-        name: "Attachment Context",
-        color: contextColors["Attachment Context"],
-      },
-    ]}
-    docsLink="/docs/api-reference/primitives/composer"
-    tooltip="Manages attachments in the composer"
-  />
-  <Component
-    name="ComposerPrimitive.AddAttachment"
-    docsLink="/docs/api-reference/primitives/composer"
-    tooltip="Button to add an attachment"
-  />
-</Component>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["Message Context"]}>
-
-## Message Context
-
-Manages the state and actions for individual messages
-
-### MessageRuntime
-
-- State: `useAuiState((s) => s.message)`
-- Edit Composer: `useAuiState((s) => s.message.composer)`
-- Actions: `useAui().message()`
-- Utilities: `useAuiState((s) => s.message.isCopied)` / `useAuiState((s) => s.message.isHovering)`
-
-### MessagePrimitive
-
-<Component
-  name="MessagePrimitive.Root"
-  docsLink="/docs/api-reference/primitives/message"
-  tooltip="Root component for a message"
->
-  <Component
-    name="MessagePrimitive.Parts"
-    isContextProvider={true}
-    providedContexts={[
-      {
-        name: "MessagePart Context",
-        color: contextColors["MessagePart Context"],
-      },
-    ]}
-    docsLink="/docs/api-reference/primitives/message"
-    tooltip="Displays the parts of the message"
-  />
-  <Component
-    name="MessagePrimitive.Attachments"
-    isContextProvider={true}
-    providedContexts={[
-      {
-        name: "Attachment Context",
-        color: contextColors["Attachment Context"],
-      },
-    ]}
-    docsLink="/docs/api-reference/primitives/message"
-    tooltip="Displays attachments in the message"
-  />
-  <Component
-    name="AuiIf"
-    docsLink="/docs/api-reference/primitives/assistant-if"
-    tooltip="Conditional rendering based on assistant state"
-  />
-</Component>
-
-### ActionBarPrimitive
-
-<Component
-  name="ActionBarPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/action-bar"
-  tooltip="Root component for the action bar"
->
-  <Component
-    name="ActionBarPrimitive.Copy"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Copies the message content"
-  />
-  <Component
-    name="ActionBarPrimitive.Edit"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Edits the message"
-  />
-  <Component
-    name="ActionBarPrimitive.Reload"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Reloads the message"
-  />
-  <Component
-    name="ActionBarPrimitive.Speak"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Speaks the message content"
-  />
-  <Component
-    name="ActionBarPrimitive.StopSpeaking"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Stops speaking the message"
-  />
-  <Component
-    name="ActionBarPrimitive.FeedbackPositive"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Provides positive feedback"
-  />
-  <Component
-    name="ActionBarPrimitive.FeedbackNegative"
-    docsLink="/docs/api-reference/primitives/action-bar"
-    tooltip="Provides negative feedback"
-  />
-</Component>
-
-### BranchPickerPrimitive
-
-<Component
-  name="BranchPickerPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/branch-picker"
-  tooltip="Root component for the branch picker"
->
-  <Component
-    name="BranchPickerPrimitive.Previous"
-    docsLink="/docs/api-reference/primitives/branch-picker"
-    tooltip="Navigates to the previous branch"
-  />
-  <Component
-    name="BranchPickerPrimitive.Number"
-    docsLink="/docs/api-reference/primitives/branch-picker"
-    tooltip="Displays the current branch number"
-  />
-  <Component
-    name="BranchPickerPrimitive.Next"
-    docsLink="/docs/api-reference/primitives/branch-picker"
-    tooltip="Navigates to the next branch"
-  />
-</Component>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["MessagePart Context"]}>
-
-## MessagePart Context
-
-Manages the state and actions for message parts within messages
-
-### MessagePartRuntime
-
-- State: `useAuiState((s) => s.part)`
-- Actions: `useAui().part()`
-
-### MessagePartPrimitive
-
-<Component
-  name="MessagePartPrimitive.Text"
-  docsLink="/docs/api-reference/primitives/message-part"
-  tooltip="Represents a text part of the message content"
-/>
-
-### MarkdownText
-
-<Component
-  name="MarkdownText"
-  docsLink="/docs/api-reference/primitives/message-part"
-  tooltip="Renders markdown text in the message"
-/>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["Attachment Context"]}>
-
-## Attachment Context
-
-Manages the state and actions for attachments in messages and composer
-
-### AttachmentRuntime
-
-- State: `useAuiState((s) => s.attachment)`
-- Actions: `useAui().attachment()`
-
-### AttachmentPrimitive
-
-<Component
-  name="AttachmentPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/attachment"
-  tooltip="Root component for an attachment"
->
-  <Component
-    name="AttachmentPrimitive.Name"
-    docsLink="/docs/api-reference/primitives/attachment"
-    tooltip="Displays the name of the attachment"
-  />
-  <Component
-    name="AttachmentPrimitive.Remove"
-    docsLink="/docs/api-reference/primitives/attachment"
-    tooltip="Removes the attachment"
-  />
-  <Component
-    name="AttachmentPrimitive.unstable_Thumb"
-    docsLink="/docs/api-reference/primitives/attachment"
-    tooltip="Displays a thumbnail of the attachment"
-  />
-</Component>
-
-</ContextLevel>
-
-<ContextLevel color={contextColors["ThreadListItem Context"]}>
-
-## ThreadListItem Context
-
-Manages the state and actions for individual thread list items
-
-### ThreadListItemRuntime
-
-- State: `useAuiState((s) => s.threadListItem)`
-- Actions: `useAui().threadListItem()`
-
-### ThreadListItem
-
-<Component
-  name="ThreadListItemPrimitive.Root"
-  docsLink="/docs/api-reference/primitives/thread-list-item"
-  tooltip="Root component for a thread list item"
->
-  <Component
-    name="ThreadListItemPrimitive.Trigger"
-    docsLink="/docs/api-reference/primitives/thread-list-item"
-    tooltip="Trigger for thread list item actions"
-  >
-    <Component
-      name="ThreadListItemPrimitive.Title"
-      docsLink="/docs/api-reference/primitives/thread-list-item"
-      tooltip="Displays the title of the thread"
-    />
-  </Component>
-  <Component
-    name="ThreadListItemPrimitive.Archive"
-    docsLink="/docs/api-reference/primitives/thread-list-item"
-    tooltip="Archives the thread"
-  />
-  <Component
-    name="ThreadListItemPrimitive.Unarchive"
-    docsLink="/docs/api-reference/primitives/thread-list-item"
-    tooltip="Unarchives the thread"
-  />
-  <Component
-    name="ThreadListItemPrimitive.Delete"
-    docsLink="/docs/api-reference/primitives/thread-list-item"
-    tooltip="Deletes the thread"
-  />
-</Component>
-
-</ContextLevel>
-
-## Utilities
-
-- [`useThreadViewportAutoScroll`](/docs/api-reference/hooks/primitives)
-- [`useInlineRender`](/docs/api-reference/model-context/context)