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

package/.docs/raw/docs/runtimes/custom/local-runtime.mdx

@@ -1,902 +0,0 @@
----
-title: LocalRuntime
-description: Quickest path to a working chat. Handles state while you handle the API.
----
-
-`LocalRuntime` is the simplest way to connect a custom backend. You implement a single `ChatModelAdapter` (one `run` function) and the runtime handles everything else: messages, threads, branching, editing, regeneration, cancellation.
-
-State lives inside the runtime by default. Multi-thread persistence and shared adapters are added via the standard interfaces, see [adapters](/docs/runtimes/concepts/adapters) and [threads](/docs/runtimes/concepts/threads).
-
-## When to use it
-
-Pick `LocalRuntime` when:
-
-- You want assistant-ui to manage chat state for you.
-- Your backend exposes a function-call shaped API (REST, OpenAI SDK, your own model client).
-- Branching, editing, and regeneration should work without you writing extra code.
-- You want to compose adapters (attachments, speech, feedback, history, suggestions).
-
-If you already keep messages in redux, zustand, tanstack-query, or another store, use [`ExternalStoreRuntime`](/docs/runtimes/custom/external-store) instead.
-
-## Quickstart
-
-<Steps>
-<Step>
-
-### Create a project
-
-<PlatformTabs>
-<Tab value="React">
-
-```sh
-npx create-next-app@latest my-app
-cd my-app
-```
-
-</Tab>
-<Tab value="React Native">
-
-```sh
-npx create-expo-app@latest my-app
-cd my-app
-```
-
-</Tab>
-<Tab value="React Ink">
-
-```sh
-mkdir my-app
-cd my-app
-npm init -y
-```
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-<Step>
-
-### Install dependencies
-
-<PlatformTabs>
-<Tab value="React">
-
-<InstallCommand npm={["@assistant-ui/react"]} />
-
-</Tab>
-<Tab value="React Native">
-
-<InstallCommand expo={["@assistant-ui/react-native"]} />
-
-</Tab>
-<Tab value="React Ink">
-
-<InstallCommand npm={["@assistant-ui/react-ink", "ink", "react"]} />
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-<Step>
-
-### Add the Thread component
-
-<PlatformTabs>
-<Tab value="React">
-
-```sh
-npx assistant-ui@latest add thread
-```
-
-</Tab>
-<Tab value="React Native">
-
-Use your React Native thread component from the [React Native setup](/docs/react-native).
-
-</Tab>
-<Tab value="React Ink">
-
-Use your terminal thread component from the [Ink setup](/docs/ink).
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-<Step>
-
-### Define a `MyRuntimeProvider`
-
-Replace the `MyModelAdapter` body with your backend call.
-
-<PlatformTabs>
-<Tab value="React">
-
-```tsx title="app/MyRuntimeProvider.tsx"
-"use client";
-
-import type { ReactNode } from "react";
-import {
-  AssistantRuntimeProvider,
-  useLocalRuntime,
-  type ChatModelAdapter,
-} from "@assistant-ui/react";
-
-const MyModelAdapter: ChatModelAdapter = {
-  async run({ messages, abortSignal }) {
-    const result = await fetch("<YOUR_API_ENDPOINT>", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ messages }),
-      signal: abortSignal,
-    });
-    const data = await result.json();
-    return {
-      content: [{ type: "text", text: data.text }],
-    };
-  },
-};
-
-export function MyRuntimeProvider({
-  children,
-}: Readonly<{ children: ReactNode }>) {
-  const runtime = useLocalRuntime(MyModelAdapter);
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-<Tab value="React Native">
-
-```tsx title="runtime/MyRuntimeProvider.tsx"
-import type { ReactNode } from "react";
-import {
-  AssistantRuntimeProvider,
-  useLocalRuntime,
-  type ChatModelAdapter,
-} from "@assistant-ui/react-native";
-
-const MyModelAdapter: ChatModelAdapter = {
-  async run({ messages, abortSignal }) {
-    const result = await fetch("<YOUR_API_ENDPOINT>", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ messages }),
-      signal: abortSignal,
-    });
-    const data = await result.json();
-    return {
-      content: [{ type: "text", text: data.text }],
-    };
-  },
-};
-
-export function MyRuntimeProvider({
-  children,
-}: Readonly<{ children: ReactNode }>) {
-  const runtime = useLocalRuntime(MyModelAdapter);
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-<Tab value="React Ink">
-
-```tsx title="runtime/MyRuntimeProvider.tsx"
-import type { ReactNode } from "react";
-import {
-  AssistantRuntimeProvider,
-  useLocalRuntime,
-  type ChatModelAdapter,
-} from "@assistant-ui/react-ink";
-
-const MyModelAdapter: ChatModelAdapter = {
-  async run({ messages, abortSignal }) {
-    const result = await fetch("<YOUR_API_ENDPOINT>", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ messages }),
-      signal: abortSignal,
-    });
-    const data = await result.json();
-    return {
-      content: [{ type: "text", text: data.text }],
-    };
-  },
-};
-
-export function MyRuntimeProvider({
-  children,
-}: Readonly<{ children: ReactNode }>) {
-  const runtime = useLocalRuntime(MyModelAdapter);
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-<Step>
-
-### Wrap your app
-
-<PlatformTabs>
-<Tab value="React">
-
-```tsx title="app/layout.tsx"
-import type { ReactNode } from "react";
-import { MyRuntimeProvider } from "@/app/MyRuntimeProvider";
-
-export default function RootLayout({ children }: { children: ReactNode }) {
-  return (
-    <MyRuntimeProvider>
-      <html lang="en">
-        <body>{children}</body>
-      </html>
-    </MyRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-<Tab value="React Native">
-
-```tsx title="app/_layout.tsx"
-import { Stack } from "expo-router";
-import { MyRuntimeProvider } from "@/runtime/MyRuntimeProvider";
-
-export default function RootLayout() {
-  return (
-    <MyRuntimeProvider>
-      <Stack />
-    </MyRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-<Tab value="React Ink">
-
-```tsx title="app.tsx"
-import { Box } from "ink";
-import { Thread } from "./components/thread.js";
-import { MyRuntimeProvider } from "./runtime/MyRuntimeProvider.js";
-
-export function App() {
-  return (
-    <MyRuntimeProvider>
-      <Box flexDirection="column">
-        <Thread />
-      </Box>
-    </MyRuntimeProvider>
-  );
-}
-```
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-<Step>
-
-### Render the Thread
-
-<PlatformTabs>
-<Tab value="React">
-
-```tsx title="app/page.tsx"
-import { Thread } from "@/components/assistant-ui/thread";
-
-export default function Page() {
-  return <Thread />;
-}
-```
-
-</Tab>
-<Tab value="React Native">
-
-```tsx title="app/index.tsx"
-import { View } from "react-native";
-import { Thread } from "@/components/assistant-ui/thread";
-
-export default function Page() {
-  return (
-    <View style={{ flex: 1 }}>
-      <Thread />
-    </View>
-  );
-}
-```
-
-</Tab>
-<Tab value="React Ink">
-
-```tsx title="index.tsx"
-import { render } from "ink";
-import { App } from "./app.js";
-
-render(<App />);
-```
-
-</Tab>
-</PlatformTabs>
-
-</Step>
-</Steps>
-
-## Streaming responses
-
-Declare `run` as an `async *` generator and yield the full cumulative content on each iteration:
-
-```tsx
-import {
-  ChatModelAdapter,
-  ThreadMessage,
-  type ModelContext,
-} from "@assistant-ui/react";
-import { OpenAI } from "openai";
-
-const openai = new OpenAI();
-
-const MyModelAdapter: ChatModelAdapter = {
-  async *run({ messages, abortSignal, context }) {
-    const stream = await openai.chat.completions.create({
-      model: "gpt-5.6-luna",
-      messages: convertToOpenAIMessages(messages),
-      stream: true,
-      signal: abortSignal,
-    });
-
-    let text = "";
-    for await (const part of stream) {
-      text += part.choices[0]?.delta?.content || "";
-      yield {
-        content: [{ type: "text", text }],
-      };
-    }
-  },
-};
-```
-
-Each yield replaces the previous content. Yield the full state every time, not deltas.
-
-### Only the last part streams
-
-A text or reasoning part reports `status.type === "running"` only while it is the last part of the message. Every earlier one reads as complete, and the components that react to streaming follow that status: the reasoning disclosure auto-opens and pins its live preview while its part is running, and part status indicators resolve the same way. Tool-call parts are exempt, since their status comes from whether they have a result.
-
-That makes an empty trailing part destructive. Yielding `[reasoning, text("")]` to reserve the text slot marks the reasoning part complete the moment the empty text part appears, even though reasoning is still streaming, and nothing in the UI signals why. Add a part on its first token instead of reserving it:
-
-```tsx
-let reasoning = "";
-let text = "";
-
-for await (const chunk of stream) {
-  const delta = chunk.choices[0]?.delta;
-  text += delta?.content ?? "";
-  // Reasoning deltas are provider-specific; read whichever field yours sends
-  reasoning += (delta as { reasoning?: string })?.reasoning ?? "";
-
-  // Include each part only once it has content
-  yield {
-    content: [
-      ...(reasoning ? [{ type: "reasoning" as const, text: reasoning }] : []),
-      ...(text ? [{ type: "text" as const, text }] : []),
-    ],
-  };
-}
-```
-
-Guard every text or reasoning part this way, not just the trailing one. An empty part that is never filled also renders as an empty block, and whichever part ends up last is the only one that can report `running`.
-
-### Streaming with tool calls
-
-Accumulate tool calls in a `Map` outside the streaming loop so they persist across chunks:
-
-```tsx
-async *run({ messages, abortSignal, context }) {
-  const stream = await openai.chat.completions.create({
-    model: "gpt-5.6-luna",
-    messages: convertToOpenAIMessages(messages),
-    tools: context.tools,
-    stream: true,
-    signal: abortSignal,
-  });
-
-  let text = "";
-  const toolCallsMap = new Map();
-
-  for await (const chunk of stream) {
-    text += chunk.choices[0]?.delta?.content ?? "";
-
-    for (const toolCall of chunk.choices[0]?.delta?.tool_calls ?? []) {
-      toolCallsMap.set(toolCall.id, {
-        type: "tool-call",
-        toolName: toolCall.function?.name,
-        toolCallId: toolCall.id,
-        args: JSON.parse(toolCall.function?.arguments ?? "{}"),
-      });
-    }
-
-    yield {
-      content: [
-        ...(text ? [{ type: "text" as const, text }] : []),
-        ...Array.from(toolCallsMap.values()),
-      ],
-    };
-  }
-}
-```
-
-If you build the `content` array fresh from the current chunk each iteration, tool calls from earlier chunks will disappear when a later chunk carries only text. The Map outside the loop is the fix.
-
-## Tool calling
-
-`LocalRuntime` supports OpenAI-compatible function calling. Register tools through the provider's `config` so the runtime exposes them to your adapter via `context.tools`:
-
-```tsx title="app/toolkit.tsx"
-"use generative";
-
-import { defineToolkit } from "@assistant-ui/react";
-import { z } from "zod";
-
-export default defineToolkit({
-  getWeather: {
-    description: "Get the current weather in a location",
-    parameters: z.object({
-      location: z.string(),
-      unit: z.enum(["celsius", "fahrenheit"]).default("celsius"),
-    }),
-    execute: async ({ location, unit }) => {
-      "use client";
-      return fetchWeather(location, unit);
-    },
-    renderText: { running: "Checking the weather…", complete: "Weather ready" },
-  },
-});
-```
-
-```tsx title="app/MyRuntimeProvider.tsx"
-import { AuiConfig, Tools } from "@assistant-ui/react";
-import toolkit from "./toolkit";
-
-function MyRuntimeProvider({ children }: { children: React.ReactNode }) {
-  const runtime = useLocalRuntime(MyModelAdapter);
-  const config = AuiConfig({ tools: Tools({ toolkit }) });
-  return (
-    <AssistantRuntimeProvider runtime={runtime} config={config}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-See the [tools guide](/docs/tools/defining-tools) for advanced patterns.
-
-### Human-in-the-loop tools
-
-Tools listed in `unstable_humanToolNames` are not executed by code. The run pauses on the tool call and the user supplies the result through the tool UI:
-
-```ts
-const runtime = useLocalRuntime(MyModelAdapter, {
-  unstable_humanToolNames: ["send_email"],
-});
-```
-
-The pause is driven by the message status your adapter returns; `LocalRuntime` never sets it for you. When the model requests a human tool call, end the run with `status: { type: "requires-action", reason: "tool-calls" }`. Without that status, the runtime marks the message complete and nothing waits. Only return it while a listed tool call is missing its result: unresolved tool calls that are not listed do not hold the run, so the runtime would invoke your adapter again immediately.
-
-```tsx
-const MyModelAdapter: ChatModelAdapter = {
-  async run({ messages, abortSignal, unstable_getMessage }) {
-    const toolResults = unstable_getMessage().content.flatMap((part) =>
-      part.type === "tool-call" && part.result !== undefined
-        ? [{ toolCallId: part.toolCallId, result: part.result }]
-        : [],
-    );
-
-    const result = await fetch("<YOUR_API_ENDPOINT>", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ messages, toolResults }),
-      signal: abortSignal,
-    });
-    const data = await result.json();
-
-    if (data.toolCall) {
-      return {
-        content: [
-          {
-            type: "tool-call",
-            toolCallId: data.toolCall.id,
-            toolName: data.toolCall.name,
-            args: data.toolCall.args,
-            argsText: JSON.stringify(data.toolCall.args),
-          },
-        ],
-        status: { type: "requires-action", reason: "tool-calls" },
-      };
-    }
-
-    return { content: [{ type: "text", text: data.text }] };
-  },
-};
-```
-
-The full loop:
-
-1. **The run pauses.** While a listed tool call has no result, the runtime stops invoking your adapter. The unresolved tool call part reports `status.type === "requires-action"` to its renderer.
-2. **The user responds.** The tool UI completes the call with `addResult(...)`. The stock [`ToolFallback`](/docs/ui/tool-fallback) component handles this out of the box: in the requires-action state it shows Allow and Deny buttons that record the decision as the tool result.
-3. **The run resumes.** Once every listed tool call has a result, the runtime invokes your adapter again. The resumed call receives the same `messages` array as before (it ends at the user message; the in-progress assistant message is not part of it), so read the recorded results from `unstable_getMessage().content` as shown above. Content returned by the resumed call is appended to the same assistant message.
-
-For a custom confirmation UI, register a human tool whose `render` completes the call with `addResult`. The shape of the result payload is yours to define; the adapter receives it verbatim and translates it for your backend:
-
-```tsx
-const toolkit = defineToolkit({
-  send_email: {
-    type: "human",
-    description: "Send an email after the user confirms",
-    parameters: z.object({ to: z.string(), subject: z.string() }),
-    render: ({ args, result, addResult }) => {
-      if (result) {
-        return <p>{result.approved ? "Sent" : `Cancelled: ${result.reason}`}</p>;
-      }
-      return (
-        <div>
-          <p>
-            Send "{args.subject}" to {args.to}?
-          </p>
-          <button onClick={() => addResult({ approved: true })}>Allow</button>
-          <button
-            onClick={() =>
-              addResult({ approved: false, reason: "User declined" })
-            }
-          >
-            Deny
-          </button>
-        </div>
-      );
-    },
-  },
-});
-```
-
-`unstable_humanToolNames` is unstable; see [stability](/docs/runtimes/concepts/stability).
-
-### Approval gates
-
-The [server-side approval gate](/docs/tools/tool-ui#server-side-approval-gates) is also supported on `LocalRuntime`, for actions your backend executes after the user authorizes them. Where a human tool asks the user to supply the tool result, an approval gate asks the user to allow or block an action the adapter performs. Emit `approval: { id }` on the tool call part and end the run with the same `requires-action` status:
-
-```tsx
-return {
-  content: [
-    {
-      type: "tool-call",
-      toolCallId: data.toolCall.id,
-      toolName: data.toolCall.name,
-      args: data.toolCall.args,
-      argsText: JSON.stringify(data.toolCall.args),
-      approval: { id: data.toolCall.id },
-    },
-  ],
-  status: { type: "requires-action", reason: "tool-calls" },
-};
-```
-
-A tool call with a pending approval pauses the run, whether or not the tool is listed in `unstable_humanToolNames`. Always emit gates in the pending state (`approval: { id }` with no `approved` field); a part that arrives already decided is treated as resolved and the runtime invokes the adapter again immediately. The stock [`ToolFallback`](/docs/ui/tool-fallback) Allow and Deny buttons, or a custom renderer calling `respondToApproval({ approved, reason? })`, record the decision:
-
-- **Deny** sets `approval.approved: false` and synthesizes an error result (`{ error: reason || "Tool approval denied" }` with `isError: true`), so the model sees the denial.
-- **Allow** sets `approval.approved: true` and leaves the result empty; performing the action is your adapter's job.
-
-Once every pending approval on the message is decided and every listed human tool has a result, the runtime invokes your adapter again. Read the decisions from `unstable_getMessage().content`, perform the approved actions, and return the follow-up response. A tool call that carries an approval is owned by the gate: it does not additionally require a result, even when its name is listed in `unstable_humanToolNames`.
-
-## Resuming a run
-
-`resumeRun` reconnects to an in-progress assistant run. Useful for page refresh, network reconnect, tab backgrounding, or thread switching when the backend is still generating.
-
-Unlike `startRun` (which uses the `ChatModelAdapter`), `resumeRun` requires a `stream` parameter; you provide the async generator that produces the response.
-
-```tsx
-import { useAui } from "@assistant-ui/react";
-import type { ChatModelRunResult } from "@assistant-ui/core";
-
-const aui = useAui();
-
-async function* createCustomStream(): AsyncGenerator<ChatModelRunResult> {
-  yield { content: [{ type: "text", text: "Initial response" }] };
-  await new Promise((r) => setTimeout(r, 500));
-  yield {
-    content: [
-      { type: "text", text: "Initial response. And here's more content..." },
-    ],
-  };
-}
-
-aui.thread.resumeRun({
-  parentId: "message-id",
-  stream: createCustomStream,
-});
-```
-
-A common pattern is to check whether the backend is still running on mount, then reconnect:
-
-```tsx
-function useStreamReconnect(threadId: string) {
-  const aui = useAui();
-  const checkedRef = useRef(false);
-
-  useEffect(() => {
-    if (checkedRef.current) return;
-    checkedRef.current = true;
-
-    (async () => {
-      const status = await fetch(`/api/status/${threadId}`).then((r) =>
-        r.json(),
-      );
-      if (status.isRunning) {
-        const parentId = aui.thread.getState().messages.at(-1)?.id ?? null;
-        aui.thread.resumeRun({ parentId });
-      }
-    })();
-  }, [aui, threadId]);
-}
-```
-
-## Queueing messages during a run
-
-Set `unstable_enableMessageQueue` to keep the composer usable while a run is in progress. A message sent during a queued run steers by default — it lands in the steer lane, ahead of previously queued items; `send({ steer: false })` queues a follow-up behind them instead. Pending items are held in `composer.queue` and drain once the run settles.
-
-```tsx
-const runtime = useLocalRuntime(MyModelAdapter, {
-  unstable_enableMessageQueue: true,
-});
-```
-
-Render the pending messages with [`ComposerPrimitive.Queue`](/docs/api-reference/primitives/composer) and [`QueueItemPrimitive`](/docs/api-reference/primitives/queue-item).
-
-## Adapters
-
-Attachments, speech, feedback, history, and suggestions are wired through the standard adapter contracts, see [adapters](/docs/runtimes/concepts/adapters):
-
-```tsx
-const runtime = useLocalRuntime(MyModelAdapter, {
-  adapters: {
-    attachments: myAttachmentAdapter,
-    speech: mySpeechAdapter,
-    feedback: myFeedbackAdapter,
-    history: myHistoryAdapter,
-    suggestion: mySuggestionAdapter,
-  },
-});
-```
-
-## Multi-thread
-
-`LocalRuntime` supports multi-thread either via [AssistantCloud](/docs/cloud) or via a custom `RemoteThreadListAdapter`. See [threads](/docs/runtimes/concepts/threads) for the contract and full examples.
-
-```tsx
-// managed (see "AssistantCloud" in /docs/runtimes/concepts/threads for cloud setup)
-const runtime = useLocalRuntime(MyModelAdapter, { cloud });
-```
-
-## Integration examples
-
-### OpenAI
-
-```tsx
-import { OpenAI } from "openai";
-
-const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });
-
-const OpenAIAdapter: ChatModelAdapter = {
-  async *run({ messages, abortSignal, context }) {
-    const stream = await openai.chat.completions.create({
-      model: "gpt-5.6-luna",
-      messages: messages.map((m) => ({
-        role: m.role,
-        content: m.content
-          .filter((c) => c.type === "text")
-          .map((c) => c.text)
-          .join("\n"),
-      })),
-      stream: true,
-      signal: abortSignal,
-    });
-
-    let fullText = "";
-    for await (const chunk of stream) {
-      const content = chunk.choices[0]?.delta?.content;
-      if (content) {
-        fullText += content;
-        yield { content: [{ type: "text", text: fullText }] };
-      }
-    }
-  },
-};
-```
-
-For local development on a ChatGPT Plus or Pro plan, the same client can run without a real API key by pointing `baseURL` at a local OAuth proxy and passing a placeholder `apiKey`; see [ChatGPT Subscription](/docs/guides/chatgpt-subscription#openai-compatible-proxy).
-
-### Custom REST API
-
-```tsx
-const CustomAPIAdapter: ChatModelAdapter = {
-  async run({ messages, abortSignal, unstable_threadId }) {
-    const response = await fetch("/api/chat", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({
-        messages: messages.map((m) => ({
-          role: m.role,
-          content: m.content,
-        })),
-        threadId: unstable_threadId,
-      }),
-      signal: abortSignal,
-    });
-    if (!response.ok) throw new Error(`API error: ${response.statusText}`);
-    const data = await response.json();
-    return { content: [{ type: "text", text: data.message }] };
-  },
-};
-```
-
-## Best practices
-
-1. **Always pass `abortSignal`** to `fetch` and SDK calls so cancel works:
-   ```tsx
-   fetch(url, { signal: abortSignal });
-   ```
-2. **Handle errors gracefully.** Swallow `AbortError` (it is the user cancelling); rethrow others to surface in the UI.
-3. **Yield cumulative state, not deltas.** Each yield replaces the previous content; if you yield deltas the UI flickers.
-4. **Accumulate tool calls outside the streaming loop**, otherwise they vanish on the first text-only chunk.
-
-## Troubleshooting
-
-**Messages not appearing.** Ensure your adapter returns the correct shape: `{ content: [{ type: "text", text: "..." }] }`.
-
-**Streaming not working.** Use `async *run` (with the asterisk). A plain `async run` cannot yield.
-
-**Tool UI flickers and disappears.** state is being reset between chunks. Accumulate tool calls in a `Map` declared outside the `for await` loop.
-
-## API reference
-
-### `ChatModelAdapter`
-
-<ParametersTable
-  type="ChatModelAdapter"
-  parameters={[
-    {
-      name: "run",
-      type: "ChatModelRunOptions => ChatModelRunResult | AsyncGenerator<ChatModelRunResult>",
-      description:
-        "Function that sends messages to your API and returns the response.",
-      required: true,
-    },
-  ]}
-/>
-
-### `ChatModelRunOptions`
-
-<ParametersTable
-  type="ChatModelRunOptions"
-  parameters={[
-    {
-      name: "messages",
-      type: "readonly ThreadMessage[]",
-      description: "The conversation history to send to your API.",
-      required: true,
-    },
-    {
-      name: "runConfig",
-      type: "RunConfig",
-      description:
-        "Run configuration with optional custom metadata. RunConfig is { readonly custom?: Record<string, unknown> }.",
-      required: true,
-    },
-    {
-      name: "abortSignal",
-      type: "AbortSignal",
-      description: "Signal to cancel the request if user interrupts.",
-      required: true,
-    },
-    {
-      name: "context",
-      type: "ModelContext",
-      description: "Additional context including configuration and tools.",
-      required: true,
-    },
-    {
-      name: "unstable_assistantMessageId",
-      type: "string | Undefined",
-      description:
-        "ID of the assistant message being generated. Useful for tracking or updating specific messages.",
-    },
-    {
-      name: "unstable_threadId",
-      type: "string | Undefined",
-      description:
-        "Current thread/conversation identifier. Useful for passing to your backend API.",
-    },
-    {
-      name: "unstable_parentId",
-      type: "string | Null | Undefined",
-      description:
-        "ID of the parent message this response is replying to. null if this is the first message.",
-    },
-    {
-      name: "unstable_getMessage",
-      type: "() => ThreadMessage",
-      description:
-        "Returns the current assistant message being generated. Useful during streaming.",
-    },
-  ]}
-/>
-
-### `LocalRuntimeOptions`
-
-<ParametersTable
-  type="LocalRuntimeOptions"
-  parameters={[
-    {
-      name: "initialMessages",
-      type: "readonly ThreadMessageLike[]",
-      description: "Pre-populate the thread with messages.",
-    },
-    {
-      name: "maxSteps",
-      type: "number",
-      description:
-        "Maximum number of sequential tool calls before requiring user input.",
-      default: "2",
-    },
-    {
-      name: "cloud",
-      type: "AssistantCloud",
-      description:
-        "Enable Assistant Cloud integration for multi-thread support and persistence.",
-    },
-    {
-      name: "adapters",
-      type: "LocalRuntimeAdapters",
-      description:
-        "Capability adapters. UI features automatically enable based on which adapters are provided. See /docs/runtimes/concepts/adapters.",
-    },
-    {
-      name: "unstable_humanToolNames",
-      type: "string[]",
-      description:
-        "Tool names that pause the run until the user supplies a result via addResult (unstable).",
-    },
-  ]}
-/>
-
-## Related
-
-<Cards>
-  <Card
-    title="ExternalStoreRuntime"
-    description="Bring your own state store."
-    href="/docs/runtimes/custom/external-store"
-  />
-  <Card
-    title="Adapters"
-    description="Attachments, speech, feedback, history, suggestions."
-    href="/docs/runtimes/concepts/adapters"
-  />
-  <Card
-    title="Threads"
-    description="Cloud, custom database, ExternalStore-based."
-    href="/docs/runtimes/concepts/threads"
-  />
-</Cards>