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

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

@@ -1,41 +1,28 @@
 ---
 title: Runtime Hooks
-description: Hooks for creating assistant runtimes.
+description: Runtime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences.
 ---
 
-Runtime hooks create the `AssistantRuntime` passed to `AssistantRuntimeProvider`.
+import { useCloudThreadListRuntime, useLocalRuntime, useRemoteThreadListRuntime } from "@/generated/typeDocs";
 
-```tsx
-import {
-  AssistantRuntimeProvider,
-  useLocalRuntime,
-} from "@assistant-ui/react";
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-function App() {
-  const runtime = useLocalRuntime(chatModelAdapter);
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
+## API Reference
 
-## Core Runtime Hooks
+### useCloudThreadListRuntime
 
-- [`useLocalRuntime`](/docs/runtimes/custom/local-runtime) creates a runtime from a `ChatModelAdapter`.
-- [`useRemoteThreadListRuntime`](/docs/runtimes/concepts/threads) adds backend-backed thread list management.
-- [`useExternalStoreRuntime`](/docs/runtimes/custom/external-store) adapts an external message store.
-- [`useAssistantTransportRuntime`](/docs/runtimes/custom/assistant-transport) consumes assistant-stream transport events.
+<ParametersTable {...useCloudThreadListRuntime} />
 
-## Integration Runtime Hooks
+### useLocalRuntime
 
-- [`useChatRuntime`](/docs/runtimes/ai-sdk/overview) adapts AI SDK chat helpers.
-- [`useDataStreamRuntime`](/docs/runtimes/custom/data-stream) adapts assistant-stream data streams.
-- [`useLangGraphRuntime`](/docs/runtimes/langgraph/overview) adapts LangGraph.
-- [`useCloudThreadListRuntime`](/docs/cloud) uses Assistant Cloud for thread persistence.
+<ParametersTable {...useLocalRuntime} />
 
-## Runtime Options
+### useRemoteThreadListRuntime
 
-Most runtime hooks accept adapters for persistence, attachments, speech, dictation, feedback, and suggestions. See [Adapters](/docs/api-reference/adapters) for the adapter map.
+<ParametersTable {...useRemoteThreadListRuntime} />
+{/* api-reference:end */}

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

@@ -1,26 +1,35 @@
 ---
 title: State Hooks
-description: Read assistant state and call runtime actions.
+description: State selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and attachments.
 ---
 
-## useAuiState
+import { useAuiEvent, useAuiState } from "@/generated/typeDocs";
 
-`useAuiState` is the primary hook for reactive state. Pass a selector and the component re-renders when the selected value changes.
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-```tsx
-import { useAuiState } from "@assistant-ui/react";
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-const messages = useAuiState((s) => s.thread.messages);
-const isRunning = useAuiState((s) => s.thread.isRunning);
-const composerText = useAuiState((s) => s.composer.text);
-```
+## API Reference
 
-Selectors are scoped by context. Inside a message primitive, `s.message` refers to that message; inside an attachment primitive, `s.attachment` refers to that attachment.
+### useAui
 
-## useAui
+Returns the current `AssistantClient` from context.
 
-`useAui` returns the runtime action API. Use it for imperative operations such as sending composer text, cancelling a run, switching threads, or submitting feedback.
+Read the client supplied by the nearest [AuiProvider](/docs/api-reference/context-providers/assistant-runtime-provider#auiprovider) or
+[AssistantRuntimeProvider](/docs/api-reference/context-providers/assistant-runtime-provider#assistantruntimeprovider), then access a scope on it —
+`aui.thread()`, `aui.composer()`, `aui.message()`, and so on. Pair
+with [useAuiState](/docs/api-reference/hooks/state#useauistate) to read reactive state and [useAuiEvent](/docs/api-reference/hooks/state#useauievent)
+to subscribe to events. The returned client also exposes lower-level
+methods such as `aui.on(...)` and `aui.subscribe(...)`; prefer
+`useAuiEvent` for React event subscriptions.
 
+Rendered outside a provider, the returned client's scope accessors
+throw a descriptive error whenever they are called.
+
+{/* api-example:useAui:start */}
 ```tsx
 import { useAui } from "@assistant-ui/react";
 
@@ -30,19 +39,56 @@ aui.composer().setText("Hello");
 aui.composer().send();
 aui.thread().cancelRun();
 ```
+{/* api-example:useAui:end */}
+
+```ts
+function useAui(): AssistantClient;
+```
 
-Runtime action and state shapes are documented in the [Runtime State](/docs/api-reference/runtimes/assistant-runtime) section.
+### useAuiEvent
 
-## useAuiEvent
+Subscribes to an assistant event for the lifetime of the component.
 
-`useAuiEvent` subscribes to runtime events without using the event as render state.
+The subscription is established on mount and re-established whenever the
+scope or event name changes. The `callback` is wrapped in an effect-event
+shim, so the latest closure is invoked on each emission — you do not
+need to memoize it.
 
+{/* api-example:useAuiEvent:start */}
 ```tsx
 import { useAuiEvent } from "@assistant-ui/react";
 
-useAuiEvent("thread.runStart", (payload) => {
-  console.log("Run started", payload);
+useAuiEvent("thread.modelContextUpdate", ({ threadId }) => {
+  console.log("Model context updated", threadId);
 });
 ```
+{/* api-example:useAuiEvent:end */}
+
+<ParametersTable {...useAuiEvent} />
+
+### useAuiState
+
+Subscribes to a slice of [AssistantState](/docs/api-reference/primitives/assistant-if#assistantstate) and re-renders the
+component whenever that slice changes.
+
+The `selector` is called on every store update; its return value is
+compared by `Object.is`, and the component re-renders only when the
+selected slice changes. Returning the entire state object is not
+supported and throws at runtime — select a specific field instead, or
+compose multiple `useAuiState` calls. Returning a new object or array
+literal, including spreading `s.thread` into a new object, causes a
+re-render on every store update; either select primitives or return a
+memoized reference.
+
+{/* api-example:useAuiState:start */}
+```tsx
+import { useAuiState } from "@assistant-ui/react";
+
+const messages = useAuiState((s) => s.thread.messages);
+const isRunning = useAuiState((s) => s.thread.isRunning);
+const composerText = useAuiState((s) => s.composer.text);
+```
+{/* api-example:useAuiState:end */}
 
-Use `useAuiEvent` for analytics, logging, or side effects that should not cause UI re-renders.
+<ParametersTable {...useAuiState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx

@@ -28,3 +28,437 @@ These hooks are intended for custom message part renderers. They read the neares
 - `useScrollLock` helps reasoning and grouped-part UIs preserve scroll behavior while content changes.
 
 For primitive-specific prop APIs, see [Primitives](/docs/api-reference/primitives).
+
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
+
+## API Reference
+
+Generated reference for Utilities.
+
+### unstable_useCloudThreadListAdapter
+
+Deprecated: Use `useCloudThreadListAdapter` instead.
+
+```tsx
+import { unstable_useCloudThreadListAdapter } from "@assistant-ui/react";
+```
+
+Source: `packages/core/src/react/runtimes/cloud/useCloudThreadListAdapter.tsx`
+
+### unstable_useMentionAdapter
+
+Deprecated: Under active development and might change without notice.
+
+Creates a spreadable `\{ adapter, directive \}` bundle for `@` mentions.
+Supports tools registered via `useAssistantTool`, explicit items, or both —
+flat or categorized.
+
+```tsx
+import { unstable_useMentionAdapter } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/unstable/useMentionAdapter.ts`
+
+### unstable_useSlashCommandAdapter
+
+Deprecated: Under active development and may change without notice.
+
+Bundles slash command definitions (with inline `execute` callbacks) into
+`\{adapter, action\}` that plug directly into `ComposerTriggerPopover`.
+`execute` stays in the hook closure and is never attached to the returned
+`TriggerItem`, keeping items serializable.
+
+```tsx
+import { unstable_useSlashCommandAdapter } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/unstable/useSlashCommandAdapter.ts`
+
+### unstable_useTriggerPopoverRootContext
+
+```tsx
+import { unstable_useTriggerPopoverRootContext } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopoverRootContext.tsx`
+
+### unstable_useTriggerPopoverRootContextOptional
+
+```tsx
+import { unstable_useTriggerPopoverRootContextOptional } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopoverRootContext.tsx`
+
+### unstable_useTriggerPopoverScopeContext
+
+```tsx
+import { unstable_useTriggerPopoverScopeContext } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopover.tsx`
+
+### unstable_useTriggerPopoverScopeContextOptional
+
+```tsx
+import { unstable_useTriggerPopoverScopeContextOptional } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopover.tsx`
+
+### unstable_useTriggerPopoverTriggers
+
+Live map of registered triggers, re-rendering on change. Prefer
+`subscribeLifecycle` for incremental add/remove handling.
+
+```tsx
+import { unstable_useTriggerPopoverTriggers } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopoverRootContext.tsx`
+
+### unstable_useTriggerPopoverTriggersOptional
+
+Like `useTriggerPopoverTriggers` but returns an empty map outside a root.
+
+```tsx
+import { unstable_useTriggerPopoverTriggersOptional } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/composer/trigger/TriggerPopoverRootContext.tsx`
+
+### useAssistantApi
+
+Deprecated: Use `useAui` instead. This alias will be removed in v0.13.
+
+```tsx
+import { useAssistantApi } from "@assistant-ui/react";
+```
+
+Source: `packages/store/src/useAui.ts`
+
+### useAssistantEvent
+
+Deprecated: Use `useAuiEvent` instead. This alias will be removed in v0.13.
+
+```tsx
+import { useAssistantEvent } from "@assistant-ui/react";
+```
+
+Source: `packages/store/src/useAuiEvent.ts`
+
+### useAssistantFrameHost
+
+React hook that manages the lifecycle of an AssistantFrameHost and its binding to the current AssistantRuntime.
+
+Usage example:
+```typescript
+function MyComponent() {
+  const iframeRef = useRef<HTMLIFrameElement>(null);
+
+  useAssistantFrameHost({
+    iframeRef,
+    targetOrigin: "https://trusted-domain.com", // optional
+  });
+
+  return <iframe ref={iframeRef} src="..." />;
+}
+```
+
+```tsx
+import { useAssistantFrameHost } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/model-context/frame/useAssistantFrameHost.ts`
+
+### useAssistantState
+
+Deprecated: Use `useAuiState` instead. This alias will be removed in v0.13.
+
+Hook to access a slice of the assistant state with automatic subscription
+
+```tsx
+import { useAssistantState } from "@assistant-ui/react";
+```
+
+Source: `packages/store/src/useAuiState.ts`
+
+### useAttachment
+
+Deprecated: Use `useAuiState((s) =&gt; s.attachment)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useAttachment } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/AttachmentContext.ts`
+
+### useCloudThreadListAdapter
+
+```tsx
+import { useCloudThreadListAdapter } from "@assistant-ui/react";
+```
+
+Source: `packages/core/src/react/runtimes/cloud/useCloudThreadListAdapter.tsx`
+
+### useComposer
+
+Deprecated: Use `useAuiState((s) =&gt; s.composer)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+Hook to access the current composer state.
+
+This hook provides reactive access to the composer's state, including text content,
+attachments, editing status, and send/cancel capabilities.
+
+```tsx
+import { useComposer } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/ComposerContext.ts`
+
+### useEditComposer
+
+Deprecated: Use `useAuiState((s) =&gt; s.message.composer)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useEditComposer } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/MessageContext.ts`
+
+### useEditComposerAttachment
+
+```tsx
+import { useEditComposerAttachment } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/AttachmentContext.ts`
+
+### useExternalMessageConverter
+
+```tsx
+import { useExternalMessageConverter } from "@assistant-ui/react";
+```
+
+Source: `packages/core/src/react/runtimes/external-message-converter.ts`
+
+### useMessage
+
+Deprecated: Use `useAuiState((s) =&gt; s.message)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+Hook to access the current message state.
+
+This hook provides reactive access to the message's state, including content,
+role, status, and other message-level properties.
+
+```tsx
+import { useMessage } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/MessageContext.ts`
+
+### useMessageAttachment
+
+```tsx
+import { useMessageAttachment } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/AttachmentContext.ts`
+
+### useMessagePart
+
+Deprecated: Use `useAuiState((s) =&gt; s.part)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useMessagePart } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/MessagePartContext.ts`
+
+### useMessagePartData
+
+```tsx
+import { useMessagePartData } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartData.ts`
+
+### useMessagePartFile
+
+```tsx
+import { useMessagePartFile } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartFile.ts`
+
+### useMessagePartImage
+
+```tsx
+import { useMessagePartImage } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartImage.ts`
+
+### useMessagePartReasoning
+
+```tsx
+import { useMessagePartReasoning } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartReasoning.ts`
+
+### useMessagePartSource
+
+```tsx
+import { useMessagePartSource } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartSource.ts`
+
+### useMessagePartText
+
+```tsx
+import { useMessagePartText } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/messagePart/useMessagePartText.ts`
+
+### useMessageQuote
+
+Hook that returns the quote info for the current message, if any.
+
+Reads from `message.metadata.custom.quote`.
+
+```tsx
+import { useMessageQuote } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/hooks/useMessageQuote.ts`
+
+### useMessageTiming
+
+Hook that returns timing information for the current assistant message.
+
+Reads from `message.metadata.timing`.
+
+```tsx
+import { useMessageTiming } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/hooks/useMessageTiming.ts`
+
+### useRuntimeAdapters
+
+```tsx
+import { useRuntimeAdapters } from "@assistant-ui/react";
+```
+
+Source: `packages/core/src/react/runtimes/RuntimeAdapterProvider.tsx`
+
+### useScrollLock
+
+Locks scroll position during collapsible/height animations and hides scrollbar.
+
+This utility prevents page jumps when content height changes during animations,
+providing a smooth user experience. It finds the nearest scrollable ancestor and
+temporarily locks its scroll position while the animation completes.
+
+- Prevents forced reflows: no layout reads, mutations scoped to scrollable parent only
+- Reactive: only intercepts scroll events when browser actually adjusts
+- Cleans up automatically after animation duration
+
+```tsx
+import { useScrollLock } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/reasoning/useScrollLock.ts`
+
+### useThread
+
+Deprecated: Use `useAuiState((s) =&gt; s.thread)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+Hook to access the current thread state.
+
+This hook provides reactive access to the thread's state, including messages,
+running status, capabilities, and other thread-level properties.
+
+```tsx
+import { useThread } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/ThreadContext.ts`
+
+### useThreadComposer
+
+Deprecated: Use `useAuiState((s) =&gt; s.thread.composer)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useThreadComposer } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/ThreadContext.ts`
+
+### useThreadComposerAttachment
+
+```tsx
+import { useThreadComposerAttachment } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/AttachmentContext.ts`
+
+### useThreadList
+
+Deprecated: Use `useAuiState((s) =&gt; s.threads)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useThreadList } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/AssistantContext.ts`
+
+### useThreadListItem
+
+Deprecated: Use `useAuiState((s) =&gt; s.threadListItem)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useThreadListItem } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/ThreadListItemContext.ts`
+
+### useThreadModelContext
+
+Deprecated: Use `useAuiState((s) =&gt; s.thread.modelContext)` instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12
+
+```tsx
+import { useThreadModelContext } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/legacy-runtime/hooks/ThreadContext.ts`
+
+### useThreadViewport
+
+```tsx
+import { useThreadViewport } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/context/react/ThreadViewportContext.ts`
+
+### useThreadViewportAutoScroll
+
+```tsx
+import { useThreadViewportAutoScroll } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/primitives/thread/useThreadViewportAutoScroll.ts`
+
+### useThreadViewportStore
+
+```tsx
+import { useThreadViewportStore } from "@assistant-ui/react";
+```
+
+Source: `packages/react/src/context/react/ThreadViewportContext.ts`
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx

@@ -0,0 +1,24 @@
+---
+title: "@assistant-ui/cloud-ai-sdk"
+description: Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes.
+---
+
+import { cloudAiSdk_useCloudChat, cloudAiSdk_useThreads } from "@/generated/integrationTypeDocs";
+
+{/* 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
+
+### useCloudChat
+
+<ParametersTable {...cloudAiSdk_useCloudChat} />
+
+### useThreads
+
+<ParametersTable {...cloudAiSdk_useThreads} />
+{/* api-reference:end */}

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

@@ -1,23 +1,22 @@
 ---
-title: Overview
-description: Package-level API reference for assistant-ui React integrations.
+title: Integrations API Reference
+description: Package-level APIs for connecting assistant-ui React to the Vercel AI SDK, Assistant Cloud, and adjacent chat ecosystem hooks and 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. */}
 
-Integration packages adapt assistant-ui to framework libraries and adjacent React ecosystems. Use these pages when you need package-specific hook names, options, and helper exports.
+{/* api-manual:start */}
+Integration packages connect assistant-ui to adjacent React and AI SDK ecosystems. Use this section when you need the exact hooks, options, and helper exports for a package such as `@assistant-ui/react-ai-sdk` or `@assistant-ui/cloud-ai-sdk`.
+{/* api-manual:end */}
 
 ## Pages
 
 <Cards>
-  <Card title={"@assistant-ui/react-ai-sdk"} href={"/docs/api-reference/integrations/vercel-ai-sdk"}>
-    {"Vercel AI SDK integration with chat runtime hooks and transport utilities."}
+  <Card title={"@assistant-ui/react-ai-sdk"} href={"/docs/api-reference/integrations/react-ai-sdk"}>
+    {"Vercel AI SDK runtime hooks, chat transports, and message conversion utilities for assistant-ui React applications."}
   </Card>
-  <Card title={"@assistant-ui/react-data-stream"} href={"/docs/api-reference/integrations/react-data-stream"}>
-    {"Hooks for connecting to data stream protocol endpoints and Assistant Cloud."}
-  </Card>
-  <Card title={"@assistant-ui/react-hook-form"} href={"/docs/api-reference/integrations/react-hook-form"}>
-    {"React Hook Form integration for AI-assisted form filling."}
+  <Card title={"@assistant-ui/cloud-ai-sdk"} href={"/docs/api-reference/integrations/cloud-ai-sdk"}>
+    {"Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes."}
   </Card>
 </Cards>