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

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
+
+### 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[]; };
+```
+
+### 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;
+```
+{/* api-reference:end */}

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

@@ -0,0 +1,36 @@
+---
+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 } 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} />
+
+### useExternalStoreRuntime
+
+<ParametersTable {...useExternalStoreRuntime} />
+{/* api-reference:end */}

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

@@ -0,0 +1,98 @@
+---
+title: Composer Trigger Hooks
+description: Unstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers.
+---
+
+import { unstable_useMentionAdapter, unstable_useSlashCommandAdapter } 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
+
+### unstable_useTriggerPopoverRootContext
+
+```ts
+const unstable_useTriggerPopoverRootContext: () => TriggerPopoverRootContextValue;
+```
+
+### unstable_useTriggerPopoverRootContextOptional
+
+```ts
+const unstable_useTriggerPopoverRootContextOptional: () => TriggerPopoverRootContextValue | null;
+```
+
+### unstable_useTriggerPopoverScopeContext
+
+```ts
+const unstable_useTriggerPopoverScopeContext: () => TriggerPopoverResourceOutput;
+```
+
+### unstable_useTriggerPopoverScopeContextOptional
+
+```ts
+const unstable_useTriggerPopoverScopeContextOptional: () => TriggerPopoverResourceOutput | null;
+```
+
+### unstable_useTriggerPopoverTriggers
+
+Live map of registered triggers, re-rendering on change. Prefer
+`subscribeLifecycle` for incremental add/remove handling.
+
+```ts
+const unstable_useTriggerPopoverTriggers: () => ReadonlyMap<string, RegisteredTrigger>;
+```
+
+### unstable_useTriggerPopoverTriggersOptional
+
+Like `useTriggerPopoverTriggers` but returns an empty map outside a root.
+
+```ts
+const unstable_useTriggerPopoverTriggersOptional: () => ReadonlyMap<string, RegisteredTrigger>;
+```
+
+### unstable_useMentionAdapter
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Under active development and might change without notice.
+</Callout>
+
+Creates a spreadable `{ adapter, directive }` bundle for `@` mentions.
+Supports tools registered via `useAssistantTool`, explicit items, or both —
+flat or categorized.
+
+```tsx
+const mention = unstable_useMentionAdapter();
+<ComposerTriggerPopover char="@" {...mention} />
+```
+
+<ParametersTable {...unstable_useMentionAdapter} />
+
+### unstable_useSlashCommandAdapter
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Under active development and may change without notice.
+</Callout>
+
+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
+const slash = unstable_useSlashCommandAdapter({
+  commands: [
+    { id: "summarize", execute: () => runSummarize(), icon: "FileText" },
+    { id: "translate", execute: () => runTranslate(), icon: "Languages" },
+  ],
+});
+
+<ComposerTriggerPopover char="/" {...slash} />
+```
+
+<ParametersTable {...unstable_useSlashCommandAdapter} />
+{/* api-reference:end */}

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

@@ -1,26 +1,31 @@
 ---
-title: Overview
-description: Reactive state, runtime creation, model context, and utility hooks for React.
+title: Hooks API Reference
+description: "React hooks for assistant-ui: useAui, useAuiState, runtime creation, model context registration, and helpers for building custom AI chat behavior."
 ---
 
-{/* 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. */}
 
-Hooks are the programmatic layer of `@assistant-ui/react`. Use them when primitives are not enough: reading state, creating runtimes, registering tools, wiring model context, or building custom behavior around the assistant runtime.
+{/* api-manual:start */}
+Hooks are the escape hatch and integration layer for React applications. Use them to read assistant state, call runtime actions, create runtimes, register model context, and connect custom components to assistant-ui behavior.
+{/* api-manual:end */}
 
 ## Pages
 
 <Cards>
-  <Card title={"State Hooks"} href={"/docs/api-reference/hooks/state"}>
-    {"Read assistant state and call runtime actions."}
-  </Card>
-  <Card title={"Runtime Hooks"} href={"/docs/api-reference/hooks/runtimes"}>
-    {"Hooks for creating assistant runtimes."}
+  <Card title={"Composer Trigger Hooks"} href={"/docs/api-reference/hooks/composer-triggers"}>
+    {"Unstable assistant-ui hooks for mention menus, slash commands, and custom composer trigger popovers."}
   </Card>
   <Card title={"Model Context Hooks"} href={"/docs/api-reference/hooks/model-context"}>
-    {"Register instructions, tools, tool UIs, and data renderers."}
+    {"React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers."}
+  </Card>
+  <Card title={"Primitive Hooks"} href={"/docs/api-reference/hooks/primitives"}>
+    {"Primitive hooks for reading scoped assistant-ui runtime state, viewport behavior, timing, and message part data inside React components."}
   </Card>
-  <Card title={"Utility Hooks"} href={"/docs/api-reference/hooks/utilities"}>
-    {"Focused helpers for message parts, quotes, timing, and viewport behavior."}
+  <Card title={"Runtime Hooks"} href={"/docs/api-reference/hooks/runtimes"}>
+    {"Runtime creation hooks for local, remote, cloud, external-store, and AI SDK powered assistant-ui chat experiences."}
+  </Card>
+  <Card title={"State Hooks"} href={"/docs/api-reference/hooks/state"}>
+    {"State selector and action hooks for reading assistant-ui runtime state and controlling threads, composers, messages, and attachments."}
   </Card>
 </Cards>

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

@@ -1,72 +1,33 @@
 ---
 title: Model Context Hooks
-description: Register instructions, tools, tool UIs, and data renderers.
+description: React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers.
 ---
 
-Model context hooks let React components contribute model-facing configuration while they are mounted.
+import { useAssistantInteractable, useInteractableState } from "@/generated/typeDocs";
 
-## Instructions
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
-```tsx
-import { useAssistantInstructions } from "@assistant-ui/react";
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
-useAssistantInstructions("Answer with concise examples.");
-```
+## API Reference
 
-## Tools
+### useAssistantInteractable
 
-`useAssistantTool` registers a tool definition, optional `execute` function, and optional renderer.
+Registers an interactable with the AI assistant.
 
-```tsx
-import { useAssistantTool } from "@assistant-ui/react";
+This hook handles registration only. To read and write the interactable's
+state, use [useInteractableState](/docs/api-reference/hooks/model-context#useinteractablestate) with the returned id.
 
-useAssistantTool({
-  toolName: "get_weather",
-  description: "Get the current weather for a city",
-  parameters: {
-    type: "object",
-    properties: {
-      city: { type: "string" },
-    },
-    required: ["city"],
-  },
-  execute: async ({ city }) => ({ city, temperature: 72 }),
-  render: ({ args, result }) => (
-    <div>
-      {args.city}: {result?.temperature}F
-    </div>
-  ),
-});
-```
+<ParametersTable {...useAssistantInteractable} />
 
-## Tool UI
+### useInteractableState
 
-Use `useAssistantToolUI` when the backend or model already owns the tool definition and the frontend only needs to render calls.
+Reads and writes the state of a registered interactable.
 
-```tsx
-import { useAssistantToolUI } from "@assistant-ui/react";
+Pair with [useAssistantInteractable](/docs/api-reference/hooks/model-context#useassistantinteractable) which handles registration.
 
-useAssistantToolUI({
-  toolName: "get_weather",
-  render: ({ args, result, status }) => (
-    <div>{status.type === "running" ? "Loading..." : result?.summary}</div>
-  ),
-});
-```
-
-## Data UI
-
-`useAssistantDataUI` renders named data message parts.
-
-```tsx
-import { useAssistantDataUI } from "@assistant-ui/react";
-
-useAssistantDataUI({
-  name: "weather_card",
-  render: ({ data }) => <WeatherCard data={data} />,
-});
-```
-
-## Declarative Registration
-
-`makeAssistantTool` and `makeAssistantToolUI` create components that register model context when mounted. They are useful when tools should live in JSX alongside the feature that owns them.
+<ParametersTable {...useInteractableState} />
+{/* api-reference:end */}