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

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

@@ -1,11 +1,17 @@
 ---
 title: ThreadPrimitive
-description: Primitives for the message list, viewport, and welcome screen.
+description: Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui.
 ---
 
-A conversation between a user and an assistant.
+import { ThreadPrimitiveIfProps, ThreadPrimitiveMessageByIndexProps, ThreadPrimitiveMessagesProps, ThreadPrimitiveRootProps, ThreadPrimitiveScrollToBottomProps, ThreadPrimitiveSuggestionByIndexProps, ThreadPrimitiveSuggestionProps, ThreadPrimitiveSuggestionsProps, ThreadPrimitiveViewportFooterProps, ThreadPrimitiveViewportProps, ThreadPrimitiveViewportProviderProps } from "@/generated/typeDocs";
+import { ThreadPrimitive as ThreadPrimitiveDocs } from "@/generated/primitiveDocs";
 
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
+For examples and usage patterns, see [Thread](/docs/primitives/thread).
+
+{/* api-manual:start */}
 ## Anatomy
 
 ```tsx
@@ -23,352 +29,205 @@ const Thread = () => (
   </ThreadPrimitive.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 thread.
+{ThreadPrimitiveDocs.Root?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Root.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.Root?.description}
+
+{ThreadPrimitiveDocs.Root?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveRootProps} />
+
+### Empty
+
+{ThreadPrimitiveDocs.Empty?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Empty.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.Empty?.description}
+
+{ThreadPrimitiveDocs.Empty?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Empty?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+{ThreadPrimitiveDocs.Empty?.props && (
+  <ParametersTable type={ThreadPrimitiveDocs.Empty?.element} parameters={ThreadPrimitiveDocs.Empty.props} />
+)}
+
+### If
 
-This primitive renders a `<div>` element unless `asChild` is set.
+{ThreadPrimitiveDocs.If?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.If.deprecated}
+  </Callout>
+)}
 
-<ParametersTable
-  type="ThreadPrimitiveRootProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+{ThreadPrimitiveDocs.If?.description}
+
+{ThreadPrimitiveDocs.If?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.If?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveIfProps} />
 
 ### Viewport
 
-The scrollable area containing all messages. Anchors scroll to the bottom as new messages are added.
-
-This primitive renders a `<div>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ThreadPrimitiveViewportProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "autoScroll",
-      type: "boolean",
-      default: 'true (false when turnAnchor is "top")',
-      description:
-        "Whether to automatically scroll to the bottom of the viewport when new messages are added while the viewport was previously scrolled to the bottom.",
-    },
-    {
-      name: "turnAnchor",
-      type: '"top" | "bottom"',
-      default: '"bottom"',
-      description:
-        'Controls scroll anchoring behavior for new messages. "bottom" is the classic chat behavior where messages anchor at the bottom. "top" anchors new user messages at the top of the viewport for a focused reading experience.',
-    },
-    {
-      name: "scrollToBottomOnRunStart",
-      type: "boolean",
-      default: "true",
-      description: "Whether to scroll to bottom when a new run starts.",
-    },
-    {
-      name: "scrollToBottomOnInitialize",
-      type: "boolean",
-      default: "true",
-      description:
-        "Whether to scroll to bottom when thread history is first loaded.",
-    },
-    {
-      name: "scrollToBottomOnThreadSwitch",
-      type: "boolean",
-      default: "true",
-      description:
-        "Whether to scroll to bottom when switching to a different thread.",
-    },
-  ]}
-/>
+{ThreadPrimitiveDocs.Viewport?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Viewport.deprecated}
+  </Callout>
+)}
 
-### ViewportFooter
+{ThreadPrimitiveDocs.Viewport?.description}
 
-A footer container placed inside `ThreadPrimitive.Viewport` that measures its own height (including top margin) and reports it to the viewport context. The viewport uses this measurement in scroll calculations — for example, as the minimum height for `ViewportSlack` — so that the scroll-to-bottom behaviour accounts for any sticky footer overlapping the message list.
+{ThreadPrimitiveDocs.Viewport?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Viewport?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-Multiple `ViewportFooter` components may be used; their heights are summed.
+<ParametersTable {...ThreadPrimitiveViewportProps} />
 
-This primitive renders a `<div>` element unless `asChild` is set.
+### ViewportProvider
 
-```tsx
-<ThreadPrimitive.Viewport>
-  <ThreadPrimitive.Messages>{...}</ThreadPrimitive.Messages>
-  <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
-    <Composer />
-  </ThreadPrimitive.ViewportFooter>
-</ThreadPrimitive.Viewport>
-```
+{ThreadPrimitiveDocs.ViewportProvider?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ViewportProvider.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.ViewportProvider?.description}
+
+{ThreadPrimitiveDocs.ViewportProvider?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportProvider?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveViewportProviderProps} />
+
+### ViewportFooter
+
+{ThreadPrimitiveDocs.ViewportFooter?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ViewportFooter.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.ViewportFooter?.description}
 
-<ParametersTable
-  type="ThreadPrimitiveViewportFooterProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+{ThreadPrimitiveDocs.ViewportFooter?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportFooter?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveViewportFooterProps} />
 
 ### Messages
 
-Renders all messages. This primitive renders a separate component for each message.
-
-<ParametersTable
-  type="ThreadPrimitiveMessagesProps"
-  parameters={[
-    {
-      name: "components",
-      type: "MessageComponents",
-      description: "The component to render for each message.",
-      children: [
-        {
-          type: "MessageComponents",
-          parameters: [
-            {
-              name: "Message",
-              type: "ComponentType",
-              description: "The component to render for each message.",
-            },
-            {
-              name: "UserMessage",
-              type: "ComponentType",
-              description: "The component to render for user messages.",
-            },
-            {
-              name: "AssistantMessage",
-              type: "ComponentType",
-              description: "The component to render for assistant messages.",
-            },
-            {
-              name: "SystemMessage",
-              type: "ComponentType",
-              description: "The component to render for system messages.",
-            },
-            {
-              name: "EditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when any message type is being edited. Used as a fallback when a role-specific edit composer is not provided.",
-            },
-            {
-              name: "UserEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when a user message is being edited. Takes precedence over EditComposer for user messages.",
-            },
-            {
-              name: "AssistantEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when an assistant message is being edited. Takes precedence over EditComposer for assistant messages.",
-            },
-            {
-              name: "SystemEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when a system message is being edited. Takes precedence over EditComposer for system messages.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
+{ThreadPrimitiveDocs.Messages?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Messages.deprecated}
+  </Callout>
+)}
 
-### MessageByIndex
+{ThreadPrimitiveDocs.Messages?.description}
 
-Renders a single message at the specified index in the current thread.
+{ThreadPrimitiveDocs.Messages?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Messages?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-```tsx
-<ThreadPrimitive.MessageByIndex index={0}>
-  {({ message }) => message.role === "user" ? <MyUserMessage /> : <MyAssistantMessage />}
-</ThreadPrimitive.MessageByIndex>
-```
+<ParametersTable {...ThreadPrimitiveMessagesProps} />
 
-<ParametersTable
-  type="ThreadPrimitive.MessageByIndex.Props"
-  parameters={[
-    {
-      name: "index",
-      type: "number",
-      required: true,
-      description: "The index of the message to render.",
-    },
-    {
-      name: "components",
-      type: "MessageComponents",
-      description: "The component configuration for rendering the message.",
-      children: [
-        {
-          type: "MessageComponents",
-          parameters: [
-            {
-              name: "Message",
-              type: "ComponentType",
-              description: "The component to render for each message.",
-            },
-            {
-              name: "UserMessage",
-              type: "ComponentType",
-              description: "The component to render for user messages.",
-            },
-            {
-              name: "AssistantMessage",
-              type: "ComponentType",
-              description: "The component to render for assistant messages.",
-            },
-            {
-              name: "SystemMessage",
-              type: "ComponentType",
-              description: "The component to render for system messages.",
-            },
-            {
-              name: "EditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when any message type is being edited. Used as a fallback when a role-specific edit composer is not provided.",
-            },
-            {
-              name: "UserEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when a user message is being edited. Takes precedence over EditComposer for user messages.",
-            },
-            {
-              name: "AssistantEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when an assistant message is being edited. Takes precedence over EditComposer for assistant messages.",
-            },
-            {
-              name: "SystemEditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render when a system message is being edited. Takes precedence over EditComposer for system messages.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
+### MessageByIndex
 
-### Empty
+{ThreadPrimitiveDocs.MessageByIndex?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.MessageByIndex.deprecated}
+  </Callout>
+)}
 
-<Callout type="warn">
-**Deprecated.** Use `<AuiIf condition={(s) => s.thread.isEmpty}>` instead.
-</Callout>
+{ThreadPrimitiveDocs.MessageByIndex?.description}
 
-Renders children only when there are no messages.
+{ThreadPrimitiveDocs.MessageByIndex?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.MessageByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveMessageByIndexProps} />
 
 ### ScrollToBottom
 
-A button to scroll the viewport to the bottom. Disabled when the viewport is already at bottom.
-
-This primitive renders a `<button>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ThreadPrimitiveScrollToBottomProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "behavior",
-      type: '"auto" | "instant" | "smooth"',
-      description:
-        "The scroll behavior to use when scrolling to the bottom. Passed to the browser's scrollIntoView API.",
-    },
-  ]}
-/>
+{ThreadPrimitiveDocs.ScrollToBottom?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.ScrollToBottom.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.ScrollToBottom?.description}
+
+{ThreadPrimitiveDocs.ScrollToBottom?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ScrollToBottom?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveScrollToBottomProps} />
 
 ### Suggestion
 
-A button that applies a suggestion prompt to the composer. When clicked, it sets the composer text to the given prompt and optionally sends the message immediately.
+{ThreadPrimitiveDocs.Suggestion?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Suggestion.deprecated}
+  </Callout>
+)}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+{ThreadPrimitiveDocs.Suggestion?.description}
 
-```tsx
-<ThreadPrimitive.Suggestion prompt="Tell me a joke" send>
-  Tell me a joke
-</ThreadPrimitive.Suggestion>
-```
+{ThreadPrimitiveDocs.Suggestion?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Suggestion?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-<ParametersTable
-  type="ThreadPrimitiveSuggestionProps"
-  parameters={[
-    {
-      name: "prompt",
-      type: "string",
-      required: true,
-      description:
-        "The text to place in the composer when this suggestion is activated.",
-    },
-    {
-      name: "send",
-      type: "boolean",
-      default: "false",
-      description:
-        "When true, immediately sends the message instead of only populating the composer.",
-    },
-    {
-      name: "clearComposer",
-      type: "boolean",
-      default: "true",
-      description:
-        "When send is false, determines whether the composer text is replaced by the prompt (true) or appended to it (false).",
-    },
-    {
-      name: "asChild",
-    },
-  ]}
-/>
-
-### `ThreadPrimitive.Suggestions`
-
-Renders all configured suggestions from the Suggestions API. Each suggestion is rendered using the provided Suggestion component.
+<ParametersTable {...ThreadPrimitiveSuggestionProps} />
 
-```tsx
-import { ThreadPrimitive, SuggestionPrimitive } from "@assistant-ui/react";
-
-const SuggestionsList = () => {
-  return (
-    <div className="grid grid-cols-2 gap-2">
-      <ThreadPrimitive.Suggestions>
-        {() => <SuggestionItem />}
-      </ThreadPrimitive.Suggestions>
-    </div>
-  );
-};
-
-const SuggestionItem = () => (
-  <SuggestionPrimitive.Trigger send asChild>
-    <button className="p-3 border rounded">
-      <SuggestionPrimitive.Title />
-      <SuggestionPrimitive.Description />
-    </button>
-  </SuggestionPrimitive.Trigger>
-);
-```
+### Suggestions
+
+{ThreadPrimitiveDocs.Suggestions?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Suggestions.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.Suggestions?.description}
+
+{ThreadPrimitiveDocs.Suggestions?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Suggestions?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ThreadPrimitiveSuggestionsProps} />
+
+### SuggestionByIndex
+
+{ThreadPrimitiveDocs.SuggestionByIndex?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.SuggestionByIndex.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.SuggestionByIndex?.description}
+
+{ThreadPrimitiveDocs.SuggestionByIndex?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.SuggestionByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-<ParametersTable
-  type="ThreadPrimitiveSuggestionsProps"
-  parameters={[
-    {
-      name: "components",
-      type: "{ Suggestion: ComponentType }",
-      description: "Custom component to render each suggestion.",
-    },
-  ]}
-/>
-
-<Callout type="info">
-Configure suggestions using the `Suggestions()` API in your runtime provider. See the [Suggestions guide](/docs/guides/suggestions) for details.
-</Callout>
+<ParametersTable {...ThreadPrimitiveSuggestionByIndexProps} />
+{/* api-reference:end */}

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

@@ -1,32 +1,20 @@
 ---
 title: AssistantRuntime
-description: Root runtime for managing threads, tool UIs, and assistant state.
+description: Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior.
 ---
 
 import { AssistantRuntime } from "@/generated/typeDocs";
 
-The `AssistantRuntime` is the root runtime of the application.
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-### `useAui`
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-Access the assistant runtime via `useAui`:
+## API Reference
 
-```tsx
-import { useAui } from "@assistant-ui/react";
-
-const aui = useAui();
-
-// Thread management
-aui.threads().switchToNewThread();
-aui.threads().switchToThread(threadId);
-
-// Thread actions
-aui.thread().cancelRun();
-aui.thread().append(message);
-```
+### AssistantRuntime
 
 <ParametersTable {...AssistantRuntime} />
-
-### Tool UI Registry
-
-The tool UI registry is part of the assistant runtime. It allows you to display custom UI for tool calls, enabling generative UI.
+{/* api-reference:end */}

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

@@ -1,35 +1,24 @@
 ---
 title: AttachmentRuntime
-description: Hooks for accessing attachment state in composer and messages.
+description: AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers.
 ---
 
 import { AttachmentRuntime, AttachmentState } from "@/generated/typeDocs";
 
-### `useAuiState` (Attachment State)
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Access the current attachment state reactively:
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-import { useAuiState } from "@assistant-ui/react";
+## API Reference
 
-const name = useAuiState((s) => s.attachment.name);
-const type = useAuiState((s) => s.attachment.type);
-```
-
-For imperative access and actions, use `useAui`:
-
-```tsx
-import { useAui } from "@assistant-ui/react";
-
-const aui = useAui();
-aui.attachment().remove();
-const state = aui.attachment().getState();
-```
-
-### Attachment Runtime
+### AttachmentRuntime
 
 <ParametersTable {...AttachmentRuntime} />
 
-### Attachment State
+### AttachmentState
 
 <ParametersTable {...AttachmentState} />
+{/* api-reference:end */}