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

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

@@ -1,289 +0,0 @@
----
-title: ThreadPrimitive
-description: Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui.
----
-
-import { ThreadPrimitiveIfProps, ThreadPrimitiveMessageByIndexProps, ThreadPrimitiveMessagesProps, ThreadPrimitiveRootProps, ThreadPrimitiveScrollToBottomProps, ThreadPrimitiveSuggestionByIndexProps, ThreadPrimitiveSuggestionProps, ThreadPrimitiveSuggestionsProps, ThreadPrimitiveUnstable_MessageByIdProps, 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
-import { ThreadPrimitive } from "@assistant-ui/react";
-
-const Thread = () => (
-  <ThreadPrimitive.Root>
-    <ThreadPrimitive.Viewport>
-      <AuiIf condition={(s) => s.thread.isEmpty}>...</AuiIf>
-      <ThreadPrimitive.Messages>{...}</ThreadPrimitive.Messages>
-      <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
-        <Composer />
-      </ThreadPrimitive.ViewportFooter>
-    </ThreadPrimitive.Viewport>
-  </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
-
-{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>
-)}
-
-```tsx
-<ThreadPrimitive.Root>
-  <ThreadPrimitive.Viewport>
-    <ThreadPrimitive.Messages>
-      {() => <MyMessage />}
-    </ThreadPrimitive.Messages>
-  </ThreadPrimitive.Viewport>
-</ThreadPrimitive.Root>
-```
-
-<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
-
-{ThreadPrimitiveDocs.If?.deprecated && (
-  <Callout type="warn">
-    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.If.deprecated}
-  </Callout>
-)}
-
-{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
-
-{ThreadPrimitiveDocs.Viewport?.deprecated && (
-  <Callout type="warn">
-    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Viewport.deprecated}
-  </Callout>
-)}
-
-{ThreadPrimitiveDocs.Viewport?.description}
-
-{ThreadPrimitiveDocs.Viewport?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Viewport?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-```tsx
-<ThreadPrimitive.Viewport turnAnchor="top">
-  <ThreadPrimitive.Messages>
-    {() => <MyMessage />}
-  </ThreadPrimitive.Messages>
-</ThreadPrimitive.Viewport>
-```
-
-<ParametersTable {...ThreadPrimitiveViewportProps} />
-
-### ViewportProvider
-
-{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}
-
-{ThreadPrimitiveDocs.ViewportFooter?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportFooter?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-```tsx
-<ThreadPrimitive.Viewport>
-  <ThreadPrimitive.Messages>
-    {() => <MyMessage />}
-  </ThreadPrimitive.Messages>
-  <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
-    <Composer />
-  </ThreadPrimitive.ViewportFooter>
-</ThreadPrimitive.Viewport>
-```
-
-<ParametersTable {...ThreadPrimitiveViewportFooterProps} />
-
-### Messages
-
-{ThreadPrimitiveDocs.Messages?.deprecated && (
-  <Callout type="warn">
-    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Messages.deprecated}
-  </Callout>
-)}
-
-{ThreadPrimitiveDocs.Messages?.description}
-
-{ThreadPrimitiveDocs.Messages?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Messages?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-<ParametersTable {...ThreadPrimitiveMessagesProps} />
-
-### MessageByIndex
-
-{ThreadPrimitiveDocs.MessageByIndex?.deprecated && (
-  <Callout type="warn">
-    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.MessageByIndex.deprecated}
-  </Callout>
-)}
-
-{ThreadPrimitiveDocs.MessageByIndex?.description}
-
-{ThreadPrimitiveDocs.MessageByIndex?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.MessageByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-<ParametersTable {...ThreadPrimitiveMessageByIndexProps} />
-
-### Unstable_MessageById
-
-{ThreadPrimitiveDocs.Unstable_MessageById?.deprecated && (
-  <Callout type="tip">
-    <strong>Experimental.</strong> {ThreadPrimitiveDocs.Unstable_MessageById.deprecated}
-  </Callout>
-)}
-
-{ThreadPrimitiveDocs.Unstable_MessageById?.description}
-
-{ThreadPrimitiveDocs.Unstable_MessageById?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Unstable_MessageById?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-```tsx
-const messageIds = unstable_useThreadMessageIds();
-return messageIds.map((messageId) => (
-  <ThreadPrimitive.Unstable_MessageById
-    key={messageId}
-    messageId={messageId}
-    components={MESSAGE_COMPONENTS}
-  />
-));
-```
-
-<ParametersTable {...ThreadPrimitiveUnstable_MessageByIdProps} />
-
-### ScrollToBottom
-
-{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
-
-{ThreadPrimitiveDocs.Suggestion?.deprecated && (
-  <Callout type="warn">
-    <strong>Deprecated.</strong> {ThreadPrimitiveDocs.Suggestion.deprecated}
-  </Callout>
-)}
-
-{ThreadPrimitiveDocs.Suggestion?.description}
-
-{ThreadPrimitiveDocs.Suggestion?.element && (
-  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Suggestion?.element}>`}</code> element unless <code>asChild</code> is set.</p>
-)}
-
-<ParametersTable {...ThreadPrimitiveSuggestionProps} />
-
-### 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 {...ThreadPrimitiveSuggestionByIndexProps} />
-{/* api-reference:end */}

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

@@ -1,20 +0,0 @@
----
-title: AssistantRuntime
-description: Top-level assistant-ui runtime actions and state for tools, threads, composers, messages, and assistant behavior.
----
-
-import { AssistantRuntime } 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
-
-### AssistantRuntime
-
-<ParametersTable {...AssistantRuntime} />
-{/* api-reference:end */}

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

@@ -1,24 +0,0 @@
----
-title: AttachmentRuntime
-description: AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers.
----
-
-import { AttachmentRuntime, AttachmentState } 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
-
-### AttachmentRuntime
-
-<ParametersTable {...AttachmentRuntime} />
-
-### AttachmentState
-
-<ParametersTable {...AttachmentState} />
-{/* api-reference:end */}

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

@@ -1,32 +0,0 @@
----
-title: ComposerRuntime
-description: ComposerRuntime state and actions for controlling assistant-ui composer text, attachments, submission, cancellation, and pending input.
----
-
-import { ComposerRuntime, ComposerState, EditComposerRuntime, EditComposerState } 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
-
-### ComposerRuntime
-
-<ParametersTable {...ComposerRuntime} />
-
-### ComposerState
-
-<ParametersTable {...ComposerState} />
-
-### EditComposerRuntime
-
-<ParametersTable {...EditComposerRuntime} />
-
-### EditComposerState
-
-<ParametersTable {...EditComposerState} />
-{/* api-reference:end */}

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

@@ -1,43 +0,0 @@
----
-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,43 +0,0 @@
----
-title: MessagePartRuntime
-description: MessagePartRuntime state and helpers for inspecting assistant-ui text, tool calls, data parts, reasoning, and custom message content.
----
-
-import { EnrichedPartState, MessagePartRuntime, MessagePartState, PartState } 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
-
-### EnrichedPartState
-
-Enriched part state passed to children render functions.
-
-For tool-call parts, adds `toolUI`, `addResult`, and `resume`.
-For data parts, adds `dataRendererUI`.
-
-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 === ""`.
-
-<ParametersTable {...EnrichedPartState} />
-
-### MessagePartRuntime
-
-<ParametersTable {...MessagePartRuntime} />
-
-### MessagePartState
-
-<ParametersTable {...MessagePartState} />
-
-### PartState
-
-<ParametersTable {...PartState} />
-{/* api-reference:end */}

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

@@ -1,24 +0,0 @@
----
-title: MessageRuntime
-description: MessageRuntime state and actions for editing, reloading, copying, rating, speaking, and branching assistant-ui messages.
----
-
-import { MessageRuntime, MessageState } 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
-
-### MessageRuntime
-
-<ParametersTable {...MessageRuntime} />
-
-### MessageState
-
-<ParametersTable {...MessageState} />
-{/* api-reference:end */}

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

@@ -1,20 +0,0 @@
----
-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,24 +0,0 @@
----
-title: ThreadListItemRuntime
-description: ThreadListItemRuntime state and actions for selecting, archiving, unarchiving, deleting, and renaming assistant-ui conversations.
----
-
-import { ThreadListItemRuntime, ThreadListItemState } 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
-
-### ThreadListItemRuntime
-
-<ParametersTable {...ThreadListItemRuntime} />
-
-### ThreadListItemState
-
-<ParametersTable {...ThreadListItemState} />
-{/* api-reference:end */}

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

@@ -1,24 +0,0 @@
----
-title: ThreadListRuntime
-description: ThreadListRuntime state and actions for managing remote assistant-ui conversations, active thread selection, and new thread creation.
----
-
-import { ThreadListRuntime, ThreadListState } 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
-
-### ThreadListRuntime
-
-<ParametersTable {...ThreadListRuntime} />
-
-### ThreadListState
-
-<ParametersTable {...ThreadListState} />
-{/* api-reference:end */}

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

@@ -1,36 +0,0 @@
----
-title: ThreadRuntime
-description: ThreadRuntime state and actions for controlling assistant-ui messages, composers, suggestions, model context, and the full thread lifecycle.
----
-
-import { ThreadComposerRuntime, ThreadComposerState, ThreadRuntime, ThreadState, ThreadViewportState } 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
-
-### ThreadComposerRuntime
-
-<ParametersTable {...ThreadComposerRuntime} />
-
-### ThreadComposerState
-
-<ParametersTable {...ThreadComposerState} />
-
-### ThreadRuntime
-
-<ParametersTable {...ThreadRuntime} />
-
-### ThreadState
-
-<ParametersTable {...ThreadState} />
-
-### ThreadViewportState
-
-<ParametersTable {...ThreadViewportState} />
-{/* api-reference:end */}

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

@@ -1,85 +0,0 @@
----
-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 */}
-<Callout type="warn">
-  `makeAssistantTool` and `useAssistantTool` are **deprecated** compatibility
-  APIs, documented here for reference only. New code should define a toolkit —
-  see [Defining Tools](/docs/tools/defining-tools) and [Migrating Tools to
-  Toolkits](/docs/migrations/toolkit-tools).
-</Callout>
-{/* api-manual:end */}
-
-{/* api-reference:start */}
-{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
-{/* Do not edit this block manually. */}
-
-## API Reference
-
-### makeAssistantTool
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use a toolkit with `Tools({ toolkit })` and register it via
-`useAui({ tools: Tools({ toolkit }) })` instead. See
-https://assistant-ui.com/docs/migrations/toolkit-tools.
-</Callout>
-
-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;
-  /** Lightweight text rendered while a tool call is running or complete. */
-  renderText?: ToolCallText<TArgs, TResult> | undefined;
-};
-
-const makeAssistantTool: <TArgs extends Record<string, unknown>, TResult>(tool: AssistantToolProps<TArgs, TResult>) => AssistantTool;
-```
-
-### useAssistantTool
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use a toolkit with `Tools({ toolkit })` and register it via
-`useAui({ tools: Tools({ toolkit }) })` instead. See
-https://assistant-ui.com/docs/migrations/toolkit-tools.
-</Callout>
-
-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 */}