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

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

@@ -0,0 +1,38 @@
+---
+title: Overview
+description: Runtime action and state references used by useAui and useAuiState.
+---
+
+{/* AUTO-GENERATED by scripts/generate-api-reference-overviews.mts */}
+{/* Do not edit manually. */}
+
+Runtime state pages document the objects exposed through `useAui` and `useAuiState`. Use this section when you need to control assistant-ui programmatically or inspect the exact state available in a context.
+
+## Pages
+
+<Cards>
+  <Card title={"AssistantRuntime"} href={"/docs/api-reference/runtimes/assistant-runtime"}>
+    {"Root runtime for managing threads, tool UIs, and assistant state."}
+  </Card>
+  <Card title={"AttachmentRuntime"} href={"/docs/api-reference/runtimes/attachment-runtime"}>
+    {"Hooks for accessing attachment state in composer and messages."}
+  </Card>
+  <Card title={"ComposerRuntime"} href={"/docs/api-reference/runtimes/composer-runtime"}>
+    {"Runtime for programmatically controlling the message composer."}
+  </Card>
+  <Card title={"MessagePartRuntime"} href={"/docs/api-reference/runtimes/message-part-runtime"}>
+    {"Hook for accessing message part state within parts."}
+  </Card>
+  <Card title={"MessageRuntime"} href={"/docs/api-reference/runtimes/message-runtime"}>
+    {"Hooks for accessing message state and edit composer."}
+  </Card>
+  <Card title={"ThreadListItemRuntime"} href={"/docs/api-reference/runtimes/thread-list-item-runtime"}>
+    {"Runtime for managing individual thread list items."}
+  </Card>
+  <Card title={"ThreadListRuntime"} href={"/docs/api-reference/runtimes/thread-list-runtime"}>
+    {"Runtime for accessing and managing the list of threads."}
+  </Card>
+  <Card title={"ThreadRuntime"} href={"/docs/api-reference/runtimes/thread-runtime"}>
+    {"Runtime for thread state, messages, and viewport management."}
+  </Card>
+</Cards>

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

@@ -18,6 +18,13 @@ const aui = useAui();
 await aui.threads().switchToNewThread();
 await aui.threads().switchToThread(threadId);
 
+// Re-fetch the thread list from the remote adapter
+// (e.g. after async auth completes)
+await aui.threads().reload();
+
+// Append the next page of threads when the adapter returned a `nextCursor`
+await aui.threads().loadMore();
+
 // Access the main thread runtime
 const mainThread = aui.threads().main;
 
@@ -47,6 +54,8 @@ import { useAuiState } from "@assistant-ui/react";
 
 const threads = useAuiState((s) => s.threads.threadIds);
 const isLoading = useAuiState((s) => s.threads.isLoading);
+const hasMore = useAuiState((s) => s.threads.hasMore);
+const isLoadingMore = useAuiState((s) => s.threads.isLoadingMore);
 ```
 
 <ParametersTable {...ThreadListState} />

package/.docs/raw/docs/(reference)/migrations/v0-14.mdx

@@ -1,8 +1,139 @@
 ---
 title: Migration to v0.14
-description: Primitives migrate from components prop to children render functions.
+description: Drops APIs deprecated since v0.11/v0.12, and primitives migrate from components prop to children render functions.
 ---
 
+Version 0.14 finishes deprecation cycles started in v0.11 and v0.12, and replaces the `components` prop on primitives with a children render function pattern. If your app is on v0.13 and free of deprecation warnings, the only required change is the children API migration.
+
+## Automatic Migration
+
+The codemod that ships with the CLI handles the v0.12 hook renames (`useAssistantApi` → `useAui`, etc.) which are also removed in v0.14:
+
+```bash
+npx assistant-ui@latest upgrade
+```
+
+The other removals listed below are simple renames you can apply with find-and-replace.
+
+## Hook Aliases Removed
+
+These thin aliases existed only for backwards compatibility:
+
+| Removed                              | Replacement                  |
+| ------------------------------------ | ---------------------------- |
+| `useAssistantApi`                    | `useAui`                     |
+| `useAssistantState`                  | `useAuiState`                |
+| `useAssistantEvent`                  | `useAuiEvent`                |
+| `AssistantIf`                        | `AuiIf`                      |
+| `useLocalThreadRuntime`              | `useLocalRuntime`            |
+| `unstable_useRemoteThreadListRuntime`| `useRemoteThreadListRuntime` |
+| `unstable_useCloudThreadListAdapter` | `useCloudThreadListAdapter`  |
+| `unstable_RemoteThreadListAdapter`   | `RemoteThreadListAdapter`    |
+| `unstable_InMemoryThreadListAdapter` | `InMemoryThreadListAdapter`  |
+
+## Runtime API Cleanups
+
+### `AssistantRuntime`
+
+| Removed                                  | Replacement                               |
+| ---------------------------------------- | ----------------------------------------- |
+| `runtime.threadList`                     | `runtime.threads`                         |
+| `runtime.switchToNewThread()`            | `runtime.threads.switchToNewThread()`     |
+| `runtime.switchToThread(id)`             | `runtime.threads.switchToThread(id)`      |
+| `runtime.registerModelConfigProvider(p)` | `runtime.registerModelContextProvider(p)` |
+| `runtime.reset({ initialMessages })`     | `runtime.thread.reset(initialMessages)`   |
+
+### `ThreadRuntime`
+
+| Removed                                    | Replacement                         |
+| ------------------------------------------ | ----------------------------------- |
+| `thread.startRun(parentId)` (positional)   | `thread.startRun({ parentId })`     |
+| `thread.unstable_resumeRun(config)`        | `thread.resumeRun(config)`          |
+| `thread.unstable_loadExternalState(state)` | `thread.importExternalState(state)` |
+| `thread.getModelConfig()`                  | `thread.getModelContext()`          |
+
+### `MessageState` / `MessageRuntime`
+
+The duplicate top-level `submittedFeedback` field has been removed. It has always been mirrored from `message.metadata.submittedFeedback`, which remains the source of truth:
+
+```tsx
+// Before
+useAuiState((s) => s.message.submittedFeedback);
+
+// After
+useAuiState((s) => s.message.metadata.submittedFeedback);
+```
+
+### `ChatModelRunOptions`
+
+If you wrote a custom `ChatModelAdapter`, the legacy alias `options.config` (which mirrored `options.context`) is gone:
+
+```ts
+// Before
+const adapter: ChatModelAdapter = {
+  async run({ messages, config }) {
+    /* config.tools, config.config, ... */
+  },
+};
+
+// After
+const adapter: ChatModelAdapter = {
+  async run({ messages, context }) {
+    /* context.tools, context.config, ... */
+  },
+};
+```
+
+## External Store Helpers
+
+`getExternalStoreMessage` (singular) has been removed. Use `getExternalStoreMessages` (plural), which always returns an array — even when only one source message is bound:
+
+```ts
+// Before
+const original = getExternalStoreMessage<MyMessage>(threadMessage);
+
+// After
+const [original] = getExternalStoreMessages<MyMessage>(threadMessage);
+```
+
+## Assistant Transport Helpers
+
+`toAISDKTools` and `getEnabledTools` (re-exported from `@assistant-ui/react`) have been removed. Both wrapped functionality that's now exposed directly by `assistant-stream`:
+
+```ts
+// Before
+import { toAISDKTools } from "@assistant-ui/react";
+const schemas = toAISDKTools(tools);
+
+// After
+import { toToolsJSONSchema } from "assistant-stream";
+const schemas = toToolsJSONSchema(tools);
+```
+
+`toToolsJSONSchema` filters out `disabled` and `backend` tools by default. To replicate the old `toAISDKTools` behavior exactly (include all tools regardless), pass `{ filter: () => true }`.
+
+## react-langgraph
+
+`useLangGraphRuntime`'s `onSwitchToThread` option has been removed. Use `load`, which has the same signature plus an optional `AbortSignal`:
+
+```ts
+// Before
+useLangGraphRuntime({
+  stream,
+  onSwitchToThread: async (threadId) => {
+    return await fetchThread(threadId);
+  },
+});
+
+// After
+useLangGraphRuntime({
+  stream,
+  load: async (threadId, { signal } = {}) => {
+    return await fetchThread(threadId, { signal });
+  },
+});
+```
+
 ## Children API for Primitives
 
 Version 0.14 replaces the `components` prop on primitives with a children render function pattern. This gives you full control over rendering with simple inline logic.
@@ -150,10 +281,17 @@ When using the children API, tool-call parts include `addResult` and `resume` me
 
 The `components` prop is still supported on all primitives but is deprecated and will be removed in a future version.
 
-## Getting Help
+## Still Deprecated (not removed)
+
+Some APIs marked `@deprecated` are intentionally kept for one more release to give downstream runtimes time to migrate:
+
+- `ThreadState.threadId` and `ThreadState.metadata` — use `useThreadListItem()` (see [v0.12 guide](/docs/migrations/v0-12)). Will be removed in a future minor release.
+- Legacy context hooks under `legacy-runtime/hooks/*` (`useThreadRuntime`, `useMessageRuntime`, etc.) — replaced by `useAui()` / `useAuiState()` in v0.12. The codemod migrates these.
+- Primitive `If` components (`ThreadIf`, `MessageIf`, `ComposerIf`, `ThreadEmpty`) — replaced by `AuiIf`. The codemod migrates these.
 
-If you encounter issues during migration:
+You'll continue to see deprecation warnings on these; expect removal in a future minor release.
+
+## Getting Help
 
-1. Check the updated API documentation for detailed examples
-2. Review the example applications in the repository
-3. Report issues at https://github.com/assistant-ui/assistant-ui/issues
+- File issues at https://github.com/assistant-ui/assistant-ui/issues
+- See the [deprecation policy](/docs/migrations/deprecation-policy) for the support window

package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx

@@ -55,6 +55,9 @@ Create a new project in the [assistant-cloud dashboard](https://cloud.assistant-
 
 Add the following environment variables to your project:
 
+<PlatformTabs>
+<Tab value="React">
+
 ```bash title=".env.local"
 # Frontend API URL from your cloud project settings
 NEXT_PUBLIC_ASSISTANT_BASE_URL=https://proj-[YOUR-ID].assistant-api.com
@@ -63,6 +66,31 @@ NEXT_PUBLIC_ASSISTANT_BASE_URL=https://proj-[YOUR-ID].assistant-api.com
 ASSISTANT_API_KEY=your-api-key-here
 ```
 
+</Tab>
+<Tab value="React Native">
+
+```bash title=".env"
+# Client API URL from your cloud project settings
+EXPO_PUBLIC_ASSISTANT_BASE_URL=https://proj-[YOUR-ID].assistant-api.com
+
+# API key for server-side operations; do not ship this in your app bundle
+ASSISTANT_API_KEY=your-api-key-here
+```
+
+</Tab>
+<Tab value="React Ink">
+
+```bash title=".env"
+# Client API URL from your cloud project settings
+ASSISTANT_BASE_URL=https://proj-[YOUR-ID].assistant-api.com
+
+# API key for server-side operations; do not ship this in your CLI bundle
+ASSISTANT_API_KEY=your-api-key-here
+```
+
+</Tab>
+</PlatformTabs>
+
 </Step>
 
 <Step>
@@ -71,8 +99,24 @@ ASSISTANT_API_KEY=your-api-key-here
 
 Install the required packages:
 
+<PlatformTabs>
+<Tab value="React">
+
 <InstallCommand npm={["@assistant-ui/react", "@assistant-ui/react-ai-sdk"]} />
 
+</Tab>
+<Tab value="React Native">
+
+<InstallCommand expo={["@assistant-ui/react-native", "@assistant-ui/react-ai-sdk", "assistant-cloud"]} />
+
+</Tab>
+<Tab value="React Ink">
+
+<InstallCommand npm={["@assistant-ui/react-ink", "@assistant-ui/react-ai-sdk", "assistant-cloud", "ink", "react"]} />
+
+</Tab>
+</PlatformTabs>
+
 </Step>
 
 <Step>
@@ -81,6 +125,9 @@ Install the required packages:
 
 Create a client-side AssistantCloud instance and integrate it with your AI SDK runtime:
 
+<PlatformTabs>
+<Tab value="React">
+
 ```tsx title="app/chat/page.tsx"
 "use client";
 
@@ -115,6 +162,133 @@ export default function ChatPage() {
 }
 ```
 
+</Tab>
+<Tab value="React Native">
+
+```tsx title="app/chat.tsx"
+import { useMemo } from "react";
+import { Text, View } from "react-native";
+import {
+  AssistantRuntimeProvider,
+  ThreadListItemPrimitive,
+  ThreadListPrimitive,
+} from "@assistant-ui/react-native";
+import { AssistantCloud } from "assistant-cloud";
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
+import { Thread } from "@/components/assistant-ui/thread";
+
+async function getAssistantToken() {
+  // Return a user token from your auth provider.
+  return "...";
+}
+
+function ThreadList() {
+  return (
+    <ThreadListPrimitive.Root>
+      <ThreadListPrimitive.New>
+        <Text>New chat</Text>
+      </ThreadListPrimitive.New>
+      <ThreadListPrimitive.Items
+        renderItem={({ threadId }) => (
+          <ThreadListItemPrimitive.Root key={threadId}>
+            <ThreadListItemPrimitive.Trigger>
+              <ThreadListItemPrimitive.Title fallback="New conversation" />
+            </ThreadListItemPrimitive.Trigger>
+          </ThreadListItemPrimitive.Root>
+        )}
+      />
+    </ThreadListPrimitive.Root>
+  );
+}
+
+export default function ChatScreen() {
+  const cloud = useMemo(
+    () =>
+      new AssistantCloud({
+        baseUrl: process.env.EXPO_PUBLIC_ASSISTANT_BASE_URL!,
+        authToken: getAssistantToken,
+      }),
+    [],
+  );
+
+  const runtime = useChatRuntime({ cloud });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      <View style={{ flex: 1 }}>
+        <ThreadList />
+        <Thread />
+      </View>
+    </AssistantRuntimeProvider>
+  );
+}
+```
+
+</Tab>
+<Tab value="React Ink">
+
+```tsx title="chat.tsx"
+import { useMemo } from "react";
+import { Box, Text } from "ink";
+import {
+  AssistantRuntimeProvider,
+  ThreadListItemPrimitive,
+  ThreadListPrimitive,
+} from "@assistant-ui/react-ink";
+import { AssistantCloud } from "assistant-cloud";
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
+import { Thread } from "./components/thread.js";
+
+async function getAssistantToken() {
+  // Return a user token from your auth provider.
+  return "...";
+}
+
+function ThreadList() {
+  return (
+    <ThreadListPrimitive.Root>
+      <ThreadListPrimitive.New>
+        <Text color="green">[New chat]</Text>
+      </ThreadListPrimitive.New>
+      <ThreadListPrimitive.Items
+        renderItem={({ threadId }) => (
+          <ThreadListItemPrimitive.Root key={threadId}>
+            <ThreadListItemPrimitive.Trigger>
+              <ThreadListItemPrimitive.Title fallback="New conversation" />
+            </ThreadListItemPrimitive.Trigger>
+          </ThreadListItemPrimitive.Root>
+        )}
+      />
+    </ThreadListPrimitive.Root>
+  );
+}
+
+export function Chat() {
+  const cloud = useMemo(
+    () =>
+      new AssistantCloud({
+        baseUrl: process.env.ASSISTANT_BASE_URL!,
+        authToken: getAssistantToken,
+      }),
+    [],
+  );
+
+  const runtime = useChatRuntime({ cloud });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      <Box flexDirection="column">
+        <ThreadList />
+        <Thread />
+      </Box>
+    </AssistantRuntimeProvider>
+  );
+}
+```
+
+</Tab>
+</PlatformTabs>
+
 </Step>
 
 </Steps>
@@ -166,7 +340,7 @@ export default function ChatPage() {
               name: "history",
               type: "ThreadHistoryAdapter",
               description:
-                "Adapter for loading and saving thread history. Used to restore previous messages when switching threads.",
+                "Adapter for loading and saving thread history. Used to restore previous messages when switching threads. The adapter must implement `withFormat` when used with AI SDK — see [Persisting Chat History](/docs/runtimes/ai-sdk/v6#persisting-chat-history).",
             },
           ],
         },
@@ -213,7 +387,7 @@ export async function POST(req: Request) {
   const { messages } = await req.json();
 
   const result = streamText({
-    model: openai("gpt-4o-mini"),
+    model: openai("gpt-5.4-mini"),
     messages,
   });
 
@@ -264,7 +438,10 @@ See the [AI SDK Telemetry guide](/docs/cloud/ai-sdk#sub-agent-model-tracking) fo
 
 ## Authentication
 
-The example above uses anonymous mode (browser session-based user ID) via the env var. For production apps with user accounts, pass an explicit cloud instance:
+The React example above uses anonymous mode for quick demos. For production apps with user accounts, pass an explicit cloud instance with a token from your auth provider:
+
+<PlatformTabs>
+<Tab value="React">
 
 ```tsx
 import { useMemo } from "react";
@@ -285,6 +462,57 @@ function Chat() {
 }
 ```
 
+</Tab>
+<Tab value="React Native">
+
+```tsx
+import { useMemo } from "react";
+import { AssistantCloud } from "assistant-cloud";
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
+
+async function getAssistantToken() {
+  // Return a user token from your native auth provider.
+  return "...";
+}
+
+function Chat() {
+  const cloud = useMemo(() => new AssistantCloud({
+    baseUrl: process.env.EXPO_PUBLIC_ASSISTANT_BASE_URL!,
+    authToken: getAssistantToken,
+  }), []);
+
+  const runtime = useChatRuntime({ cloud });
+  // ...
+}
+```
+
+</Tab>
+<Tab value="React Ink">
+
+```tsx
+import { useMemo } from "react";
+import { AssistantCloud } from "assistant-cloud";
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
+
+async function getAssistantToken() {
+  // Return a user token from your CLI auth flow.
+  return "...";
+}
+
+function Chat() {
+  const cloud = useMemo(() => new AssistantCloud({
+    baseUrl: process.env.ASSISTANT_BASE_URL!,
+    authToken: getAssistantToken,
+  }), []);
+
+  const runtime = useChatRuntime({ cloud });
+  // ...
+}
+```
+
+</Tab>
+</PlatformTabs>
+
 See the [Cloud Authorization](/docs/cloud/authorization) guide for other auth providers.