@assistant-ui/mcp-docs-server 0.1.34 → 0.1.36

package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx

@@ -3,7 +3,7 @@ title: ThreadPrimitive
 description: Thread primitives for rendering chat transcripts, message lists, viewport state, suggestions, and composers in assistant-ui.
 ---
 
-import { ThreadPrimitiveIfProps, ThreadPrimitiveMessageByIndexProps, ThreadPrimitiveMessagesProps, ThreadPrimitiveRootProps, ThreadPrimitiveScrollToBottomProps, ThreadPrimitiveSuggestionByIndexProps, ThreadPrimitiveSuggestionProps, ThreadPrimitiveSuggestionsProps, ThreadPrimitiveViewportFooterProps, ThreadPrimitiveViewportProps, ThreadPrimitiveViewportProviderProps } from "@/generated/typeDocs";
+import { ThreadPrimitiveIfProps, ThreadPrimitiveMessageByIndexProps, ThreadPrimitiveMessagesProps, ThreadPrimitiveRootProps, ThreadPrimitiveScrollToBottomProps, ThreadPrimitiveSuggestionByIndexProps, ThreadPrimitiveSuggestionProps, ThreadPrimitiveSuggestionsProps, ThreadPrimitiveUnstable_MessageByIdProps, ThreadPrimitiveViewportFooterProps, ThreadPrimitiveViewportProps, ThreadPrimitiveViewportProviderProps } from "@/generated/typeDocs";
 import { ThreadPrimitive as ThreadPrimitiveDocs } from "@/generated/primitiveDocs";
 
 {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
@@ -51,6 +51,16 @@ const Thread = () => (
   <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
 )}
 
+```tsx
+<ThreadPrimitive.Root>
+  <ThreadPrimitive.Viewport>
+    <ThreadPrimitive.Messages>
+      {() => <MyMessage />}
+    </ThreadPrimitive.Messages>
+  </ThreadPrimitive.Viewport>
+</ThreadPrimitive.Root>
+```
+
 <ParametersTable {...ThreadPrimitiveRootProps} />
 
 ### Empty
@@ -101,6 +111,14 @@ const Thread = () => (
   <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Viewport?.element}>`}</code> element unless <code>asChild</code> is set.</p>
 )}
 
+```tsx
+<ThreadPrimitive.Viewport turnAnchor="top">
+  <ThreadPrimitive.Messages>
+    {() => <MyMessage />}
+  </ThreadPrimitive.Messages>
+</ThreadPrimitive.Viewport>
+```
+
 <ParametersTable {...ThreadPrimitiveViewportProps} />
 
 ### ViewportProvider
@@ -133,6 +151,17 @@ const Thread = () => (
   <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.ViewportFooter?.element}>`}</code> element unless <code>asChild</code> is set.</p>
 )}
 
+```tsx
+<ThreadPrimitive.Viewport>
+  <ThreadPrimitive.Messages>
+    {() => <MyMessage />}
+  </ThreadPrimitive.Messages>
+  <ThreadPrimitive.ViewportFooter className="sticky bottom-0">
+    <Composer />
+  </ThreadPrimitive.ViewportFooter>
+</ThreadPrimitive.Viewport>
+```
+
 <ParametersTable {...ThreadPrimitiveViewportFooterProps} />
 
 ### Messages
@@ -167,6 +196,33 @@ const Thread = () => (
 
 <ParametersTable {...ThreadPrimitiveMessageByIndexProps} />
 
+### Unstable_MessageById
+
+{ThreadPrimitiveDocs.Unstable_MessageById?.deprecated && (
+  <Callout type="tip">
+    <strong>Experimental.</strong> {ThreadPrimitiveDocs.Unstable_MessageById.deprecated}
+  </Callout>
+)}
+
+{ThreadPrimitiveDocs.Unstable_MessageById?.description}
+
+{ThreadPrimitiveDocs.Unstable_MessageById?.element && (
+  <p>This primitive renders a <code>{`<${ThreadPrimitiveDocs.Unstable_MessageById?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+```tsx
+const messageIds = unstable_useThreadMessageIds();
+return messageIds.map((messageId) => (
+  <ThreadPrimitive.Unstable_MessageById
+    key={messageId}
+    messageId={messageId}
+    components={MESSAGE_COMPONENTS}
+  />
+));
+```
+
+<ParametersTable {...ThreadPrimitiveUnstable_MessageByIdProps} />
+
 ### ScrollToBottom
 
 {ThreadPrimitiveDocs.ScrollToBottom?.deprecated && (

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

@@ -36,4 +36,10 @@ Toolkits are the current registration API. Tool **rendering** and **status** are
   <Card title={"Tool Status"} href={"/docs/api-reference/tools/status"}>
     {"Read tool arguments, execution status, and result state inside assistant-ui tool UI components."}
   </Card>
+  <Card title={"Interactables"} href={"/docs/api-reference/tools/interactables"}>
+    {"Unstable interactables APIs for model-editable app and message state, including hooks, resources, toolkit helpers, and snapshot utilities."}
+  </Card>
+  <Card title={"Interactables (legacy)"} href={"/docs/api-reference/tools/interactables-legacy"}>
+    {"Deprecated legacy interactables APIs for registering model-editable components with per-instance update tools."}
+  </Card>
 </Cards>

package/.docs/raw/docs/(reference)/api-reference/tools/interactables-legacy.mdx

@@ -0,0 +1,55 @@
+---
+title: Interactables (legacy)
+description: Deprecated legacy interactables APIs for registering model-editable components with per-instance update tools.
+---
+
+import { Interactables, 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
+
+### Interactables
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Since 2026-06-14 — migrate to the Unstable / Experimental API.
+Scheduled for removal on/after 2026-09-14. See
+[Interactables migration guide](https://www.assistant-ui.com/docs/tools/interactables#migrating-from-the-previous-api).
+</Callout>
+
+<ParametersTable {...Interactables} />
+
+### useAssistantInteractable
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Since 2026-06-14 — migrate to the Unstable / Experimental API.
+Scheduled for removal on/after 2026-09-14. See
+[Interactables migration guide](https://www.assistant-ui.com/docs/tools/interactables#migrating-from-the-previous-api).
+</Callout>
+
+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/tools/interactables-legacy#useinteractablestate) with the returned id.
+
+<ParametersTable {...useAssistantInteractable} />
+
+### useInteractableState
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Since 2026-06-14 — migrate to the Unstable / Experimental API.
+Scheduled for removal on/after 2026-09-14. See
+[Interactables migration guide](https://www.assistant-ui.com/docs/tools/interactables#migrating-from-the-previous-api).
+</Callout>
+
+Reads and writes the state of a registered interactable.
+
+Pair with [useAssistantInteractable](/docs/api-reference/tools/interactables-legacy#useassistantinteractable) which handles registration.
+
+<ParametersTable {...useInteractableState} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/tools/interactables.mdx

@@ -0,0 +1,151 @@
+---
+title: Interactables
+description: Unstable interactables APIs for model-editable app and message state, including hooks, resources, toolkit helpers, and snapshot utilities.
+---
+
+import { unstable_formatInteractableSnapshot, unstable_getInteractableSnapshots, unstable_getInteractableVersions, unstable_useInteractable, unstable_useInteractableState, unstable_useInteractableVersions } 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_Interactables
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Registers the unstable interactables store scope.
+
+```ts
+const unstable_Interactables: Resource<ClientOutput<"unstable_interactables">, [(Unstable_InteractablesConfig | undefined)?]>;
+```
+
+### unstable_useInteractable
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Registers an interactable with the AI assistant and returns its live state,
+like `useState` that the model can also read and update.
+
+Call this once per place that shows the interactable. Other components can
+read and write the same instance by passing its `id` to
+`unstable_useInteractableState`.
+
+For tool-created interactables rendered inside tool-call message parts,
+`version` carries this message's version of the instance — its state as of
+that point in the conversation, whether it is the most recent tool-driven
+version, and a `restore()` back to it. Whether older messages render frozen history or stay
+live-editable is the component's choice. Inside an `update_{name}` part the
+instance `id` is inferred from the call, so the same component works at the
+creating call and at update calls.
+
+<ParametersTable {...unstable_useInteractable} />
+
+### unstable_useInteractableState
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Reads and writes the state of an interactable registered elsewhere, by id.
+
+Use this from secondary readers (children, siblings); the owning component
+registers with `unstable_useInteractable`, which returns state directly. Returns
+`undefined` until the owning interactable is registered.
+
+<ParametersTable {...unstable_useInteractableState} />
+
+### unstable_useInteractableVersions
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Every version of a tool-created interactable recorded in the current
+thread, oldest first: the creating tool call, each user edit, and each
+`update_*` call. Each entry carries the full state as of that version and a
+`restore()` that sets the live instance back to it — enough for a version
+picker like an artifact's history dropdown.
+
+<ParametersTable {...unstable_useInteractableVersions} />
+
+### unstable_interactableTool
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Defines a tool that creates a thread-scoped interactable from its arguments,
+for assignment to a toolkit entry — the entry key is the interactable name:
+
+```tsx
+notepad: unstable_interactableTool({
+  description: "A notepad the user can read and edit.",
+  stateSchema: notepadSchema,
+  render: (props) => <Notepad {...props} />,
+}),
+```
+
+`render` shows at the creating call and — installed automatically — at every
+`update_{name}` call, with streaming previews, instance-id wiring, and
+registration handled. It receives the live `state`/`setState` plus this
+message's `version`; whether older messages render frozen history or stay
+live-editable is the render function's choice.
+
+```ts
+const unstable_interactableTool: <TSchema extends Unstable_InteractableStateSchema>(config: Unstable_InteractableToolConfig<TSchema>) => ToolDefinition<Record<string, unknown>, { success: true; }>;
+```
+
+### unstable_getInteractableSnapshots
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Reads the interactable snapshots stamped on a message's
+`metadata.custom.interactables`, or `undefined` if none. This is the read
+half of the snapshot channel — integrations use it to surface interactable
+state to the model (see `unstable_injectInteractableContext` in
+`@assistant-ui/react-ai-sdk` for the AI SDK implementation).
+
+<ParametersTable {...unstable_getInteractableSnapshots} />
+
+### unstable_formatInteractableSnapshot
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Canonical model-facing wording for one snapshot entry.
+
+<ParametersTable {...unstable_formatInteractableSnapshot} />
+
+### unstable_getInteractableVersions
+
+<Callout type="tip">
+<strong>Experimental.</strong> Unstable / Experimental (not actually removed).
+</Callout>
+
+Every version of interactable `id` recorded in the thread, oldest first,
+folded chronologically:
+
+- the tool call whose `toolCallId` equals `id` seeds the baseline with its
+  args (`origin: "create"`) — the `id: toolCallId` convention for
+  tool-created interactables,
+- a snapshot stamped on a user message is a `"user-edit"` version (a full
+  snapshot replaces the state; a partial one shallow-merges),
+- each accepted `update_*` call shallow-merges an `"update"` version.
+
+The last entry is the state the model knows. Partial snapshots and update
+calls with no baseline to merge into are skipped.
+
+<ParametersTable {...unstable_getInteractableVersions} />
+{/* api-reference:end */}

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

@@ -3,7 +3,7 @@ title: Tool Rendering
 description: Register React renderers for assistant-ui tool calls, tool results, and model data parts.
 ---
 
-import { McpAppRenderer, McpAppsRemoteHost, getMcpAppFromToolPart, useAssistantDataUI, useAssistantToolUI } from "@/generated/typeDocs";
+import { DataRenderers, McpAppRenderer, McpAppsRemoteHost, getMcpAppFromToolPart, useAssistantDataUI, useAssistantToolUI } from "@/generated/typeDocs";
 
 {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
 {/* Do not edit manually. */}
@@ -16,15 +16,7 @@ import { McpAppRenderer, McpAppsRemoteHost, getMcpAppFromToolPart, useAssistantD
 
 ### DataRenderers
 
-Registers renderers for `data` message parts.
-
-Data renderers are looked up by the part's `name` field. Use this resource
-directly for a renderer scope, or prefer [useAssistantDataUI](/docs/api-reference/tools/rendering#useassistantdataui) /
-[makeAssistantDataUI](/docs/api-reference/tools/rendering#makeassistantdataui) when registering from React components.
-
-```ts
-const DataRenderers: () => ResourceElement<ClientOutput<"dataRenderers">, undefined>;
-```
+<ParametersTable {...DataRenderers} />
 
 ### getMcpAppFromToolPart
 
@@ -52,6 +44,21 @@ type AssistantDataUIProps = {
 const makeAssistantDataUI: <T = any>(dataUI: AssistantDataUIProps<T>) => AssistantDataUI;
 ```
 
+### McpAppRenderer
+
+<ParametersTable {...McpAppRenderer} />
+
+### McpAppsRemoteHost
+
+<ParametersTable {...McpAppsRemoteHost} />
+
+### useAssistantDataUI
+
+Registers a renderer for named `data` message parts while the component is
+mounted.
+
+<ParametersTable {...useAssistantDataUI} />
+
 ### makeAssistantToolUI
 
 <Callout type="warn">
@@ -82,34 +89,6 @@ type AssistantToolUIProps = {
 const makeAssistantToolUI: <TArgs, TResult>(tool: AssistantToolUIProps<TArgs, TResult>) => AssistantToolUI;
 ```
 
-### McpAppRenderer
-
-Creates a tool-call renderer for MCP Apps embedded in assistant messages.
-
-Compose this into the `Tools` resource through its `mcpApp` option. When a
-tool-call part carries `mcp.app` metadata for a `ui://` resource, the
-renderer loads that resource from the configured host and displays it in a
-sandboxed frame.
-
-<ParametersTable {...McpAppRenderer} />
-
-### McpAppsRemoteHost
-
-Creates the default HTTP host for MCP App widgets.
-
-The host POSTs widget requests to the configured route as `{ method,
-params }`, using the method names expected by the assistant-ui MCP Apps
-guide.
-
-<ParametersTable {...McpAppsRemoteHost} />
-
-### useAssistantDataUI
-
-Registers a renderer for named `data` message parts while the component is
-mounted.
-
-<ParametersTable {...useAssistantDataUI} />
-
 ### useAssistantToolUI
 
 <Callout type="warn">

package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx

@@ -39,4 +39,26 @@ function WeatherToolUI({
 ```ts
 const useToolArgsStatus: <TArgs extends Record<string, unknown> = Record<string, unknown>>() => ToolArgsStatus<TArgs>;
 ```
+
+### useToolCallElapsed
+
+Hook that returns the elapsed wall-clock time of the current tool call in
+milliseconds, ticking once per second while the call runs.
+
+Reads `part.timing`. Returns `undefined` when the part is not a tool call,
+carries no timing, ended without a recorded completion (the duration is
+unknown), or when no message part scope is available (so kit components
+stay renderable standalone, e.g. in docs previews).
+
+```tsx
+function ToolDuration() {
+  const elapsedMs = useToolCallElapsed();
+  if (elapsedMs === undefined) return null;
+  return <span>{(elapsedMs / 1000).toFixed(1)}s</span>;
+}
+```
+
+```ts
+const useToolCallElapsed: () => number;
+```
 {/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx

@@ -80,13 +80,6 @@ type Toolkit = Record<string, ToolDefinition<any, any>>;
 
 ### Tools
 
-Registers tools with model context and installs tool-call renderers.
-
-Mount this resource near an assistant subtree when you want to expose a
-group of tools declaratively. Tool definitions are registered with model
-context, while each tool renderer is registered with the tools scope for
-message rendering.
-
 <ParametersTable {...Tools} />
 
 ### defineMcpToolkit
@@ -122,26 +115,6 @@ client build.
 function externalTool(): never;
 ```
 
-### hitl
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use [humanTool](/docs/api-reference/tools/toolkits#humantool).
-</Callout>
-
-```ts
-const hitl: typeof humanTool;
-```
-
-### hitlTool
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use [humanTool](/docs/api-reference/tools/toolkits#humantool).
-</Callout>
-
-```ts
-const hitlTool: typeof humanTool;
-```
-
 ### humanTool
 
 Marks a tool as **human-in-the-loop**: the agent pauses and the UI (`render`)
@@ -179,4 +152,24 @@ supplied by `useAuiToolOverrides(...)`.
 ```ts
 function stubTool(): never;
 ```
+
+### hitl
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Use [humanTool](/docs/api-reference/tools/toolkits#humantool).
+</Callout>
+
+```ts
+const hitl: typeof humanTool;
+```
+
+### hitlTool
+
+<Callout type="warn">
+<strong>Deprecated.</strong> Use [humanTool](/docs/api-reference/tools/toolkits#humantool).
+</Callout>
+
+```ts
+const hitlTool: typeof humanTool;
+```
 {/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx

@@ -3,7 +3,7 @@ title: Utilities
 description: Miscellaneous @assistant-ui/react utilities for custom rendering, composition, and advanced assistant UI behavior.
 ---
 
-import { AssistantCloud, ChainOfThoughtClient, DevToolsHooks, InMemoryThreadList, SingleThreadList } from "@/generated/typeDocs";
+import { AssistantCloud, ChainOfThoughtClient, DevToolsHooks, InMemoryThreadList, SingleThreadList, Suggestions, useSmooth } from "@/generated/typeDocs";
 
 {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
 {/* Do not edit manually. */}
@@ -36,36 +36,13 @@ const createMessageQueue: (driver: MessageQueueDriver) => MessageQueueController
 
 <ParametersTable {...InMemoryThreadList} />
 
-### Interactables
-
-```ts
-const Interactables: () => ResourceElement<ClientOutput<"interactables">, undefined>;
-```
-
 ### SingleThreadList
 
-A minimal threads scope that wraps a single thread.
-Automatically provided by ExternalThread when no threads scope exists.
-Mounts the provided thread resource element.
-
 <ParametersTable {...SingleThreadList} />
 
 ### Suggestions
 
-```ts
-const Suggestions: {
-  (): ResourceElement<
-    ClientOutput<"suggestions">,
-    undefined
-  >;
-  (
-    suggestions: SuggestionConfig[],
-  ): ResourceElement<
-    ClientOutput<"suggestions">,
-    SuggestionConfig[]
-  >;
-};
-```
+<ParametersTable {...Suggestions} />
 
 ### unstable_defaultDirectiveFormatter
 
@@ -76,4 +53,42 @@ When `id` equals `label`, the `{name=…}` attribute is omitted for brevity.
 ```ts
 const unstable_defaultDirectiveFormatter: Unstable_DirectiveFormatter;
 ```
+
+### useSmooth
+
+Animates streamed message part text with a typewriter-style reveal.
+
+Takes the current part state and a `smooth` argument: `false` disables,
+`true` uses the default rate, and a SmoothOptions object tunes
+the reveal. Returns the part state with `text` replaced by the revealed
+prefix and `status` reporting `running` until the reveal catches up.
+
+```tsx
+const { text, status } = useSmooth(useMessagePartText(), {
+  drainMs: 500,
+  maxCharsPerFrame: 30,
+});
+```
+
+<ParametersTable {...useSmooth} />
+
+### fromThreadMessageLike
+
+<Callout type="tip">
+<strong>Experimental.</strong> This API is experimental and may change without notice.
+</Callout>
+
+```ts
+const fromThreadMessageLike: (like: ThreadMessageLike, fallbackId: string, fallbackStatus: MessageStatus) => ThreadMessage;
+```
+
+### generateId
+
+<Callout type="tip">
+<strong>Experimental.</strong> This API is experimental and may change without notice.
+</Callout>
+
+```ts
+const generateId: (size?: number) => string;
+```
 {/* api-reference:end */}

package/.docs/raw/docs/guides/chain-of-thought.mdx

@@ -60,7 +60,7 @@ const AssistantMessage: FC = () => {
             case "group-reasoning": {
               const running = part.status.type === "running";
               return (
-                <ReasoningRoot defaultOpen={running}>
+                <ReasoningRoot streaming={running}>
                   <ReasoningTrigger active={running} />
                   <ReasoningContent aria-busy={running}>
                     <ReasoningText>{children}</ReasoningText>