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

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
+
+### 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

@@ -0,0 +1,31 @@
+---
+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 PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
+
+{/* 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={"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"}>
+    {"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={"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

@@ -0,0 +1,33 @@
+---
+title: Model Context Hooks
+description: React hooks for registering assistant-ui tools, data renderers, instructions, and model context providers.
+---
+
+import { useAssistantInteractable, useInteractableState } 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
+
+### useAssistantInteractable
+
+Registers an interactable with the AI assistant.
+
+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.
+
+<ParametersTable {...useAssistantInteractable} />
+
+### useInteractableState
+
+Reads and writes the state of a registered interactable.
+
+Pair with [useAssistantInteractable](/docs/api-reference/hooks/model-context#useassistantinteractable) which handles registration.
+
+<ParametersTable {...useInteractableState} />
+{/* api-reference:end */}