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

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

@@ -14,6 +14,20 @@ import { useExternalMessageConverter } from "@/generated/typeDocs";
 
 ## API Reference
 
+### 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;
+```
+
 ### getExternalStoreMessages
 
 ```ts
@@ -35,18 +49,4 @@ const unstable_convertExternalMessages: <T extends WeakKey>(messages: T[], callb
 ```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

@@ -3,7 +3,7 @@ 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";
+import { ExternalStoreAdapter, ExternalThread, ExternalThreadProps, ExternalThreadQueueAdapter, useExternalStoreRuntime, useExternalStoreSharedOptions } from "@/generated/typeDocs";
 
 {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
 {/* Do not edit manually. */}
@@ -30,7 +30,17 @@ import { ExternalStoreAdapter, ExternalThread, ExternalThreadProps, ExternalThre
 
 <ParametersTable {...ExternalThreadQueueAdapter} />
 
+### pickExternalStoreSharedOptions
+
+```ts
+const pickExternalStoreSharedOptions: (options: ExternalStoreSharedOptions) => ExternalStoreSharedOptions;
+```
+
 ### useExternalStoreRuntime
 
 <ParametersTable {...useExternalStoreRuntime} />
+
+### useExternalStoreSharedOptions
+
+<ParametersTable {...useExternalStoreSharedOptions} />
 {/* api-reference:end */}

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

@@ -0,0 +1,18 @@
+---
+title: Generative UI API Reference
+description: Spec-driven generative UI for assistant-ui. The data format an assistant streams, the component registry that resolves it, and the renderer that turns it into React elements.
+---
+
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
+
+## Pages
+
+<Cards>
+  <Card title={"Generative UI Spec"} href={"/docs/api-reference/generative-ui/spec"}>
+    {"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."}
+  </Card>
+  <Card title={"Generative UI Rendering"} href={"/docs/api-reference/generative-ui/rendering"}>
+    {"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."}
+  </Card>
+</Cards>

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

@@ -14,6 +14,47 @@ import { unstable_useMentionAdapter, unstable_useSlashCommandAdapter } from "@/g
 
 ## 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
@@ -54,45 +95,4 @@ 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/model-context.mdx

@@ -3,7 +3,7 @@ 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";
+import { useAssistantInteractable, useAuiToolOverrides, useInteractableState } from "@/generated/typeDocs";
 
 {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
 {/* Do not edit manually. */}
@@ -23,6 +23,24 @@ state, use [useInteractableState](/docs/api-reference/hooks/model-context#useint
 
 <ParametersTable {...useAssistantInteractable} />
 
+### useAuiToolOverrides
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Experimental, API may change.
+</Callout>
+
+Overrides toolkit entries for the current assistant scope.
+
+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.
+
+<ParametersTable {...useAuiToolOverrides} />
+
 ### useInteractableState
 
 Reads and writes the state of a registered interactable.