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

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

@@ -0,0 +1,33 @@
+---
+title: Generative UI Rendering
+description: 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.
+---
+
+import { GenerativeUIRender, GenerativeUIRenderError } 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
+
+### GenerativeUIRender
+
+Internal renderer. Resolves a [GenerativeUISpec](/docs/api-reference/generative-ui/spec#generativeuispec) against the consumer
+allowlist. Used by `MessagePrimitive.GenerativeUI` and by
+`MessagePrimitive.Parts` when handling a `generative-ui` part.
+
+<ParametersTable {...GenerativeUIRender} />
+
+### GenerativeUIRenderError
+
+Thrown when a generative-ui spec references a component name that is not
+present in the consumer-provided allowlist. The allowlist is the security
+boundary in the same-realm rendering path — there is no fallback by
+default. Pass `Fallback` to opt into a soft-fail UX.
+
+<ParametersTable {...GenerativeUIRenderError} />
+{/* api-reference:end */}

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

@@ -0,0 +1,45 @@
+---
+title: Generative UI Spec
+description: 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.
+---
+
+import { GenerativeUIMessagePart, GenerativeUINode, GenerativeUISpec } 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
+
+### GenerativeUIMessagePart
+
+A message part that carries a JSON spec describing UI to render.
+
+Render with `<MessagePrimitive.GenerativeUI components={...} />`. The
+primitive resolves component names against the consumer-provided allowlist
+— any unknown name throws a typed error rather than rendering. Stream-
+friendly: a partially-streamed spec renders progressively.
+
+<ParametersTable {...GenerativeUIMessagePart} />
+
+### GenerativeUINode
+
+A JSON spec describing a tree of UI components to render.
+
+The agent emits a [GenerativeUIMessagePart](/docs/api-reference/generative-ui/spec#generativeuimessagepart) containing this spec, and
+the consumer-provided component allowlist is used to resolve `component`
+names. Any component referenced that is not present in the allowlist is
+rejected with a typed error — the allowlist is the security boundary in the
+default same-realm rendering path.
+
+<ParametersTable {...GenerativeUINode} />
+
+### GenerativeUISpec
+
+The root spec for a generative UI tree.
+
+<ParametersTable {...GenerativeUISpec} />
+{/* 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_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 in model context, 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} />
+
+### 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>;
+```
+{/* 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,51 @@
 ---
 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, useAuiToolOverrides, 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
+### useAuiToolOverrides
 
-Use `useAssistantToolUI` when the backend or model already owns the tool definition and the frontend only needs to render calls.
+<Callout type="warn">
+<strong>Deprecated.</strong> Experimental, API may change.
+</Callout>
 
-```tsx
-import { useAssistantToolUI } from "@assistant-ui/react";
+Overrides toolkit entries for the current assistant scope.
 
-useAssistantToolUI({
-  toolName: "get_weather",
-  render: ({ args, result, status }) => (
-    <div>{status.type === "running" ? "Loading..." : result?.summary}</div>
-  ),
-});
-```
+This is intended for dynamic local-state tools whose model-facing contract is
+declared in a `"use generative"` toolkit file with `execute: stubTool()`, but
+whose actual executor must close over React state in the mounted component.
+Keep the override keys stable after mount; dynamic key addition/removal is not
+currently observed.
+Overrides are registered at priority 1000, above toolkit defaults. Only one
+mounted override provider may define a given tool name at a time.
 
-## Data UI
+<ParametersTable {...useAuiToolOverrides} />
 
-`useAssistantDataUI` renders named data message parts.
+### useInteractableState
 
-```tsx
-import { useAssistantDataUI } from "@assistant-ui/react";
+Reads and writes the state of a registered interactable.
 
-useAssistantDataUI({
-  name: "weather_card",
-  render: ({ data }) => <WeatherCard data={data} />,
-});
-```
+Pair with [useAssistantInteractable](/docs/api-reference/hooks/model-context#useassistantinteractable) which handles registration.
 
-## 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 */}