@assistant-ui/mcp-docs-server 0.1.31 → 0.1.33

package/.docs/raw/docs/(docs)/installation.mdx

@@ -137,7 +137,7 @@ export const maxDuration = 30;
 export async function POST(req: Request) {
   const { messages, system, tools } = await req.json();
   const result = streamText({
-    model: openai("gpt-4o-mini"),
+    model: openai("gpt-5.4-nano"),
     system,
     messages: await convertToModelMessages(messages),
     tools: frontendTools(tools),
@@ -465,7 +465,7 @@ export default function MyApp() {
   <Card
     title="Generative UI"
     description="Create rich UI components for tool executions"
-    href="/docs/guides/tool-ui"
+    href="/docs/tools/tool-ui"
   />
   <Card
     title="Add Persistence"

package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx

@@ -1,34 +1,36 @@
 ---
 title: Attachment Adapters
-description: Upload and compose file attachment handlers.
+description: Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages.
 ---
 
-Attachment adapters control how files become assistant-ui attachments.
+import { AttachmentAdapter, CloudFileAttachmentAdapter, CompositeAttachmentAdapter, SimpleImageAttachmentAdapter, SimpleTextAttachmentAdapter } from "@/generated/typeDocs";
 
-```tsx
-import {
-  CompositeAttachmentAdapter,
-  SimpleImageAttachmentAdapter,
-  SimpleTextAttachmentAdapter,
-  useLocalRuntime,
-} from "@assistant-ui/react";
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-const attachments = new CompositeAttachmentAdapter([
-  new SimpleImageAttachmentAdapter(),
-  new SimpleTextAttachmentAdapter(),
-]);
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-const runtime = useLocalRuntime(chatModelAdapter, {
-  adapters: { attachments },
-});
-```
+## API Reference
 
-## Common Exports
+### AttachmentAdapter
 
-- `AttachmentAdapter` is the interface for custom attachment handling.
-- `SimpleImageAttachmentAdapter` converts supported image files.
-- `SimpleTextAttachmentAdapter` converts supported text files.
-- `CompositeAttachmentAdapter` tries multiple attachment adapters in order.
-- `CloudFileAttachmentAdapter` uploads files through Assistant Cloud.
+<ParametersTable {...AttachmentAdapter} />
 
-For a custom implementation guide, see [Custom Attachment Adapter](/docs/integrations/attachments/custom-adapter).
+### CloudFileAttachmentAdapter
+
+<ParametersTable {...CloudFileAttachmentAdapter} />
+
+### CompositeAttachmentAdapter
+
+<ParametersTable {...CompositeAttachmentAdapter} />
+
+### SimpleImageAttachmentAdapter
+
+<ParametersTable {...SimpleImageAttachmentAdapter} />
+
+### SimpleTextAttachmentAdapter
+
+<ParametersTable {...SimpleTextAttachmentAdapter} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx

@@ -0,0 +1,20 @@
+---
+title: Feedback Adapter
+description: Capture and respond to message feedback submitted through action primitives or runtime actions.
+---
+
+import { FeedbackAdapter } 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
+
+### FeedbackAdapter
+
+<ParametersTable {...FeedbackAdapter} />
+{/* api-reference:end */}

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

@@ -1,26 +1,34 @@
 ---
-title: Overview
-description: Interfaces for persistence, files, speech, dictation, feedback, suggestions, and runtime composition.
+title: Adapters API Reference
+description: Adapter interfaces for connecting chat models, persistence, file attachments, feedback, and suggestions to assistant-ui React runtimes.
 ---
 
-{/* AUTO-GENERATED by scripts/generate-api-reference-overviews.mts */}
-{/* Do not edit manually. */}
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
 
-Adapters let you replace runtime behavior without replacing the UI. They are usually passed through runtime options or provided by integration packages.
+{/* api-manual:start */}
+Adapters define the boundaries between assistant-ui and the systems around it. Use them when you need custom model execution, attachment handling, persistence, feedback collection, or prompt suggestions.
+{/* api-manual:end */}
 
 ## Pages
 
 <Cards>
-  <Card title={"Runtime Adapter Context"} href={"/docs/api-reference/adapters/runtime"}>
-    {"Provide runtime adapters through React context."}
-  </Card>
   <Card title={"Attachment Adapters"} href={"/docs/api-reference/adapters/attachments"}>
-    {"Upload and compose file attachment handlers."}
+    {"Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages."}
+  </Card>
+  <Card title={"Feedback Adapter"} href={"/docs/api-reference/adapters/feedback"}>
+    {"Capture and respond to message feedback submitted through action primitives or runtime actions."}
+  </Card>
+  <Card title={"Model Adapters"} href={"/docs/api-reference/adapters/model"}>
+    {"Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes."}
   </Card>
   <Card title={"Persistence Adapters"} href={"/docs/api-reference/adapters/persistence"}>
-    {"Persist message history and thread lists."}
+    {"Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads."}
+  </Card>
+  <Card title={"Runtime Adapter Context"} href={"/docs/api-reference/adapters/runtime"}>
+    {"Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior."}
   </Card>
-  <Card title={"Feedback and Speech Adapters"} href={"/docs/api-reference/adapters/feedback-speech"}>
-    {"Capture message feedback and connect speech or dictation."}
+  <Card title={"Suggestion Adapters"} href={"/docs/api-reference/adapters/suggestions"}>
+    {"Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes."}
   </Card>
 </Cards>

package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx

@@ -0,0 +1,44 @@
+---
+title: Model Adapters
+description: Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes.
+---
+
+import { ChatModelAdapter, ChatModelRunOptions, ChatModelRunResult, ChatModelRunUpdate, CreateResumeRunConfig, CreateStartRunConfig, LanguageModelConfig } 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
+
+### ChatModelAdapter
+
+<ParametersTable {...ChatModelAdapter} />
+
+### ChatModelRunOptions
+
+<ParametersTable {...ChatModelRunOptions} />
+
+### ChatModelRunResult
+
+<ParametersTable {...ChatModelRunResult} />
+
+### ChatModelRunUpdate
+
+<ParametersTable {...ChatModelRunUpdate} />
+
+### CreateResumeRunConfig
+
+<ParametersTable {...CreateResumeRunConfig} />
+
+### CreateStartRunConfig
+
+<ParametersTable {...CreateStartRunConfig} />
+
+### LanguageModelConfig
+
+<ParametersTable {...LanguageModelConfig} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx

@@ -1,34 +1,59 @@
 ---
 title: Persistence Adapters
-description: Persist message history and thread lists.
+description: Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads.
 ---
 
-assistant-ui has two persistence layers:
+import { ExportedMessageRepository, GenericThreadHistoryAdapter, InMemoryThreadListAdapter, MessageFormatAdapter, RemoteThreadListAdapter, ThreadHistoryAdapter } from "@/generated/typeDocs";
 
-- `ThreadHistoryAdapter` persists messages for a single runtime thread.
-- `RemoteThreadListAdapter` manages a backend-backed list of threads, including creating, loading, archiving, deleting, and title generation.
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-## Thread History
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-```tsx
-const runtime = useLocalRuntime(chatModelAdapter, {
-  adapters: {
-    history: myHistoryAdapter,
-  },
-});
-```
+## API Reference
+
+### ExportedMessageRepository
+
+<ParametersTable {...ExportedMessageRepository} />
+
+### GenericThreadHistoryAdapter
+
+<ParametersTable {...GenericThreadHistoryAdapter} />
+
+### InMemoryThreadListAdapter
 
-Use a history adapter when the app has one active thread or when thread list management lives somewhere else.
+<ParametersTable {...InMemoryThreadListAdapter} />
 
-## Remote Thread Lists
+### MessageFormatAdapter
 
+<ParametersTable {...MessageFormatAdapter} />
+
+### RemoteThreadListAdapter
+
+{/* api-example:RemoteThreadListAdapter:start */}
 ```tsx
 const runtime = useRemoteThreadListRuntime({
   adapter: myRemoteThreadListAdapter,
   runtimeHook: () => useLocalRuntime(chatModelAdapter),
 });
 ```
+{/* api-example:RemoteThreadListAdapter:end */}
+
+<ParametersTable {...RemoteThreadListAdapter} />
 
-Use a remote thread list adapter when your backend owns conversation metadata and users can switch between many threads.
+### ThreadHistoryAdapter
+
+{/* api-example:ThreadHistoryAdapter:start */}
+```tsx
+const runtime = useLocalRuntime(chatModelAdapter, {
+  adapters: {
+    history: myHistoryAdapter,
+  },
+});
+```
+{/* api-example:ThreadHistoryAdapter:end */}
 
-Assistant Cloud provides managed persistence through `AssistantCloud` and cloud runtime helpers. See [Threads](/docs/runtimes/concepts/threads) for the full threading model.
+<ParametersTable {...ThreadHistoryAdapter} />
+{/* api-reference:end */}

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

@@ -1,31 +1,20 @@
 ---
 title: Runtime Adapter Context
-description: Provide runtime adapters through React context.
+description: Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior.
 ---
 
-`RuntimeAdapterProvider` lets framework integrations provide adapters around a runtime hook instead of threading them through every hook call.
+import { RuntimeAdapters } from "@/generated/typeDocs";
 
-```tsx
-import {
-  RuntimeAdapterProvider,
-  useLocalRuntime,
-} from "@assistant-ui/react";
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-function RuntimeRoot({ children }) {
-  return (
-    <RuntimeAdapterProvider
-      adapters={{
-        history,
-        attachments,
-        feedback,
-      }}
-    >
-      {children}
-    </RuntimeAdapterProvider>
-  );
-}
-```
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-Runtime hooks merge context adapters with hook-specific options. Hook options are the right place for per-runtime configuration; the provider is useful when an integration or backend wrapper owns the adapter setup.
+## API Reference
 
-Use `useRuntimeAdapters` only when building a runtime integration that needs to read the adapter context directly.
+### RuntimeAdapters
+
+<ParametersTable {...RuntimeAdapters} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx

@@ -0,0 +1,20 @@
+---
+title: Suggestion Adapters
+description: Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes.
+---
+
+import { SuggestionAdapter } 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
+
+### SuggestionAdapter
+
+<ParametersTable {...SuggestionAdapter} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx

@@ -1,16 +1,22 @@
 ---
-title: <AssistantRuntimeProvider />
-description: Root provider that connects your runtime to assistant-ui components.
+title: AssistantRuntimeProvider
+description: Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state.
 ---
 
-import { AssistantRuntimeProvider } from "@/generated/typeDocs";
+import { AssistantRuntimeProvider, AuiProvider } from "@/generated/typeDocs";
 
-The `AssistantRuntimeProvider` provides data and APIs used by assistant-ui components.
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-Almost all components in assistant-ui require an `AssistantRuntimeProvider` around them to function properly.
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-You must either wrap your app in an `AssistantRuntimeProvider` or pass a `runtime` to the `<Thread />` component instead.
+## API Reference
 
+### AssistantRuntimeProvider
+
+{/* api-example:AssistantRuntimeProvider:start */}
 ```tsx {1, 8, 10}
 import { AssistantRuntimeProvider } from "@assistant-ui/react";
 import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
@@ -29,7 +35,30 @@ const MyApp = () => {
   );
 };
 ```
-
-#### Properties
+{/* api-example:AssistantRuntimeProvider:end */}
 
 <ParametersTable {...AssistantRuntimeProvider} />
+
+### AuiProvider
+
+Supplies an `AssistantClient` to the React tree.
+
+Place near the root of any subtree that uses [useAui](/docs/api-reference/hooks/state#useaui) or the
+primitives built on it. Components rendered outside an `AuiProvider`
+receive a default client whose scope accessors throw on use, so
+missing-provider mistakes surface at the point of use.
+
+When mounting a runtime built with one of the runtime hooks, use
+[AssistantRuntimeProvider](/docs/api-reference/context-providers/assistant-runtime-provider#assistantruntimeprovider) — it installs an `AuiProvider`
+internally — rather than wiring `AuiProvider` yourself.
+
+```tsx
+function ScopedAssistant({ children, scopes }) {
+  const aui = useAui(scopes);
+
+  return <AuiProvider value={aui}>{children}</AuiProvider>;
+}
+```
+
+<ParametersTable {...AuiProvider} />
+{/* api-reference:end */}

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

@@ -1,20 +1,22 @@
 ---
-title: Overview
-description: Context providers that establish assistant-ui runtime and message-part scopes.
+title: Context Providers API Reference
+description: React context providers including AssistantRuntimeProvider that scope assistant-ui runtime, thread, message part, and attachment state for primitives, hooks, and custom chat components.
 ---
 
-{/* AUTO-GENERATED by scripts/generate-api-reference-overviews.mts */}
-{/* Do not edit manually. */}
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
 
-Context providers establish the scopes that primitives and hooks read from. Most apps only use `AssistantRuntimeProvider` directly; lower-level providers are for custom renderers and advanced composition.
+{/* api-manual:start */}
+Context providers define where assistant-ui primitives and hooks read their state. Most apps only need `AssistantRuntimeProvider`, while scoped providers support custom renderers, isolated message parts, and advanced composition.
+{/* api-manual:end */}
 
 ## Pages
 
 <Cards>
-  <Card title={"<AssistantRuntimeProvider />"} href={"/docs/api-reference/context-providers/assistant-runtime-provider"}>
-    {"Root provider that connects your runtime to assistant-ui components."}
+  <Card title={"AssistantRuntimeProvider"} href={"/docs/api-reference/context-providers/assistant-runtime-provider"}>
+    {"Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state."}
   </Card>
-  <Card title={"<TextMessagePartProvider />"} href={"/docs/api-reference/context-providers/text-message-part-provider"}>
-    {"Context provider for reusing text components outside of message content."}
+  <Card title={"Scoped Providers"} href={"/docs/api-reference/context-providers/scoped-providers"}>
+    {"Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition."}
   </Card>
 </Cards>

package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx

@@ -0,0 +1,64 @@
+---
+title: Scoped Providers
+description: Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition.
+---
+
+import { ChainOfThoughtByIndicesProvider, ComposerAttachmentByIndexProvider, MessageAttachmentByIndexProvider, MessageByIndexProvider, MessageProvider, PartByIndexProvider, ReadonlyThreadProvider, RuntimeAdapterProvider, SuggestionByIndexProvider, TextMessagePartProvider, ThreadListItemByIndexProvider, ThreadListItemRuntimeProvider } 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
+
+### ChainOfThoughtByIndicesProvider
+
+<ParametersTable {...ChainOfThoughtByIndicesProvider} />
+
+### ComposerAttachmentByIndexProvider
+
+<ParametersTable {...ComposerAttachmentByIndexProvider} />
+
+### MessageAttachmentByIndexProvider
+
+<ParametersTable {...MessageAttachmentByIndexProvider} />
+
+### MessageByIndexProvider
+
+<ParametersTable {...MessageByIndexProvider} />
+
+### MessageProvider
+
+<ParametersTable {...MessageProvider} />
+
+### PartByIndexProvider
+
+<ParametersTable {...PartByIndexProvider} />
+
+### ReadonlyThreadProvider
+
+<ParametersTable {...ReadonlyThreadProvider} />
+
+### RuntimeAdapterProvider
+
+<ParametersTable {...RuntimeAdapterProvider} />
+
+### SuggestionByIndexProvider
+
+<ParametersTable {...SuggestionByIndexProvider} />
+
+### TextMessagePartProvider
+
+<ParametersTable {...TextMessagePartProvider} />
+
+### ThreadListItemByIndexProvider
+
+<ParametersTable {...ThreadListItemByIndexProvider} />
+
+### ThreadListItemRuntimeProvider
+
+<ParametersTable {...ThreadListItemRuntimeProvider} />
+{/* api-reference:end */}

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

@@ -0,0 +1,22 @@
+---
+title: External Store API Reference
+description: External store runtime, message conversion helpers, and adapters for assistant-ui React apps that own their chat state outside the runtime.
+---
+
+{/* 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 */}
+External store APIs are for applications that already have their own message, thread, or persistence model. They let assistant-ui render and control that state without forcing the app to adopt the built-in runtime storage shape.
+{/* api-manual:end */}
+
+## Pages
+
+<Cards>
+  <Card title={"Message Conversion"} href={"/docs/api-reference/external-store/message-conversion"}>
+    {"Convert external message formats into assistant-ui's message and thread state for the external store runtime."}
+  </Card>
+  <Card title={"External Store Runtime"} href={"/docs/api-reference/external-store/runtime"}>
+    {"Runtime components, options, and adapters for using assistant-ui with externally owned chat state."}
+  </Card>
+</Cards>

package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx

@@ -0,0 +1,52 @@
+---
+title: Message Conversion
+description: Convert external message formats into assistant-ui's message and thread state for the external store runtime.
+---
+
+import { useExternalMessageConverter } 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
+
+### bindExternalStoreMessage
+
+<Callout type="warn">
+<strong>Deprecated.</strong> This API is experimental and may change without notice.
+</Callout>
+
+Attach the original external store message(s) to a ThreadMessage or message part.
+This is a no-op if the target already has a bound message.
+Use `getExternalStoreMessages` to retrieve the bound messages later.
+
+```ts
+const bindExternalStoreMessage: <T>(target: object, message: T | T[]) => void;
+```
+
+### getExternalStoreMessages
+
+```ts
+const getExternalStoreMessages: <T>(input: { messages: readonly ThreadMessage[]; } | ThreadMessage | ThreadMessage["content"][number]) => T[];
+```
+
+### useExternalMessageConverter
+
+<ParametersTable {...useExternalMessageConverter} />
+
+### unstable_convertExternalMessages
+
+```ts
+const unstable_convertExternalMessages: <T extends WeakKey>(messages: T[], callback: useExternalMessageConverter.Callback<T>, isRunning: boolean, metadata: useExternalMessageConverter.Metadata) => ThreadMessage[];
+```
+
+### unstable_createMessageConverter
+
+```ts
+const unstable_createMessageConverter: <T extends object>(callback: useExternalMessageConverter.Callback<T>) => { useThreadMessages: ({ messages, isRunning, joinStrategy, metadata, }: { messages: T[]; isRunning: boolean; joinStrategy?: "concat-content" | "none" | undefined; metadata?: useExternalMessageConverter.Metadata; }) => ThreadMessage[]; toThreadMessages: (messages: T[], isRunning?: boolean, metadata?: useExternalMessageConverter.Metadata) => ThreadMessage[]; toOriginalMessages: (input: ThreadState | ThreadMessage | ThreadMessage["content"][number]) => unknown[]; toOriginalMessage: (input: ThreadState | ThreadMessage | ThreadMessage["content"][number]) => {}; useOriginalMessage: () => {}; useOriginalMessages: () => unknown[]; };
+```
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx

@@ -0,0 +1,46 @@
+---
+title: External Store Runtime
+description: Runtime components, options, and adapters for using assistant-ui with externally owned chat state.
+---
+
+import { ExternalStoreAdapter, ExternalThread, ExternalThreadProps, ExternalThreadQueueAdapter, useExternalStoreRuntime, useExternalStoreSharedOptions } 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
+
+### ExternalStoreAdapter
+
+<ParametersTable {...ExternalStoreAdapter} />
+
+### ExternalThread
+
+<ParametersTable {...ExternalThread} />
+
+### ExternalThreadProps
+
+<ParametersTable {...ExternalThreadProps} />
+
+### ExternalThreadQueueAdapter
+
+<ParametersTable {...ExternalThreadQueueAdapter} />
+
+### pickExternalStoreSharedOptions
+
+```ts
+const pickExternalStoreSharedOptions: (options: ExternalStoreSharedOptions) => ExternalStoreSharedOptions;
+```
+
+### useExternalStoreRuntime
+
+<ParametersTable {...useExternalStoreRuntime} />
+
+### useExternalStoreSharedOptions
+
+<ParametersTable {...useExternalStoreSharedOptions} />
+{/* api-reference:end */}

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

@@ -0,0 +1,18 @@
+---
+title: Generative UI API Reference
+description: Spec-driven generative UI for assistant-ui. The data format an assistant streams, the component registry that resolves it, and the renderer that turns it into React elements.
+---
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
+
+## Pages
+
+<Cards>
+  <Card title={"Generative UI Spec"} href={"/docs/api-reference/generative-ui/spec"}>
+    {"The serializable node tree an assistant emits to describe generative UI. Covers the GenerativeUISpec format, its nodes, and the message part that carries the spec."}
+  </Card>
+  <Card title={"Generative UI Rendering"} href={"/docs/api-reference/generative-ui/rendering"}>
+    {"Render a generative UI spec into React. The renderer resolves spec nodes against your component registry, and the error thrown when a component cannot be resolved."}
+  </Card>
+</Cards>