@assistant-ui/mcp-docs-server 0.2.3 → 0.3.0

package/.docs/raw/docs/(reference)/api-reference/integrations/ai-sdk.mdx

@@ -1,200 +0,0 @@
----
-title: "@assistant-ui/ai-sdk"
-description: Vercel AI SDK runtime hooks, chat transports, and message conversion utilities for assistant-ui applications.
----
-
-import { aiSdk_AISDKChat, aiSdk_AISDKThreads, aiSdk_AISDKToolkit, aiSdk_AssistantChatTransport, aiSdk_createResumableSessionStorage, aiSdk_getThreadMessageTokenUsage, aiSdk_injectQuoteContext, aiSdk_unstable_injectInteractableContext, aiSdk_useAISDKRuntime, aiSdk_useChatRuntime } from "@/generated/integrationTypeDocs";
-
-{/* 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
-
-### AISDKChat
-
-`AuiConfig` entry that runs the AI SDK chat as the `threads` scope. Hosts the
-same orchestration as `useChatRuntime` inside the client's own resource tree,
-so it works with any `AssistantClient` host, React or not. Single thread; the
-multi-thread and assistant-cloud surface is [AISDKThreads](/docs/api-reference/integrations/ai-sdk#aisdkthreads). The chat
-id is captured when the entry mounts, so a later `id` change in the options
-has no effect.
-
-<ParametersTable {...aiSdk_AISDKChat} />
-
-### AISDKThreads
-
-`AuiConfig` entry that runs one AI SDK chat per thread. Hosts the same
-per-thread orchestration as [AISDKChat](/docs/api-reference/integrations/ai-sdk#aisdkchat) inside the client's own
-resource tree, so it works with any `AssistantClient` host, React or not.
-Without `cloud`, threads live in memory for the client's lifetime and keep
-their history across switches; each thread's chat id is its thread id.
-With `cloud`, the list is a `RemoteThreadList` and the factory is keyed so
-cloud history reloads on a switch. The store entry mounts only the visible
-thread, so a switch cancels an in-flight run. Model context is
-registered on the visible thread only.
-
-<ParametersTable {...aiSdk_AISDKThreads} />
-
-### AISDKToolkit
-
-<ParametersTable {...aiSdk_AISDKToolkit} />
-
-### AssistantChatTransport
-
-<ParametersTable {...aiSdk_AssistantChatTransport} />
-
-### createResumableSessionStorage
-
-`sessionStorage`-backed storage for the pending resumable stream id. See the [Resumable Streams](/docs/guides/resumable-streams) guide for end-to-end wiring.
-
-<ParametersTable {...aiSdk_createResumableSessionStorage} />
-
-### frontendTools
-
-```ts
-const frontendTools: (tools: FrontendTools) => ToolSet;
-```
-
-### getThreadMessageTokenUsage
-
-<ParametersTable {...aiSdk_getThreadMessageTokenUsage} />
-
-### injectQuoteContext
-
-Injects quote context into messages as markdown blockquotes.
-
-Use this in your route handler before `convertToModelMessages` so the LLM
-sees the quoted text that the user is referring to.
-
-```ts
-import { convertToModelMessages, streamText } from "ai";
-import { injectQuoteContext } from "@assistant-ui/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const result = streamText({
-    model: myModel,
-    messages: await convertToModelMessages(injectQuoteContext(messages)),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-<ParametersTable {...aiSdk_injectQuoteContext} />
-
-### RESUMABLE_STREAM_ID_HEADER
-
-Response header used by the [Resumable Streams](/docs/guides/resumable-streams) server and client wiring.
-
-```ts
-const RESUMABLE_STREAM_ID_HEADER: "x-resumable-stream-id";
-```
-
-### unstable_injectInteractableContext
-
-Injects interactable state snapshots into messages as model-visible text.
-
-Mirrors [injectQuoteContext](/docs/api-reference/integrations/ai-sdk#injectquotecontext): reads the frozen snapshot stamped on a user
-message's `metadata.custom.interactables` (by the interactables scope at send
-time) and prepends a text part. Run this in your route handler before
-`convertToModelMessages`, which otherwise ignores `metadata.custom`.
-
-Wording is consumer-owned — pass `format` to control how each snapshot reads.
-A snapshot may originate from a user edit or an agent `update_*` call, so the
-default phrasing is neutral. Keep the instance id visible in custom wording:
-the model needs it to address the `update_*` tool's `id` parameter. A custom
-`format` must also handle entries with `partial: true`, whose `state` carries
-only the fields that changed since the model's last known state.
-
-```ts
-import { convertToModelMessages, streamText } from "ai";
-import { unstable_injectInteractableContext } from "@assistant-ui/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const result = streamText({
-    model: myModel,
-    messages: await convertToModelMessages(unstable_injectInteractableContext(messages)),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-<ParametersTable {...aiSdk_unstable_injectInteractableContext} />
-
-### useAISDKChat
-
-The underlying `useChat` helpers object, for advanced views — reach
-`resumeStream`, `clearError`, or the raw `sendMessage` without forking the
-runtime hook. `undefined` when the current thread is not backed by the AI
-SDK runtime.
-
-```ts
-const useAISDKChat: <UI_MESSAGE extends UIMessage = UIMessage<unknown, UIDataTypes, UITools>>() => UseChatHelpers<UI_MESSAGE> | undefined;
-```
-
-### useAISDKError
-
-Read the last AI SDK chat error object from the runtime extras.
-`undefined` when there is no error or the current thread is not backed by
-the AI SDK runtime.
-
-```ts
-const useAISDKError: () => Error | undefined;
-```
-
-### useAISDKRuntime
-
-<ParametersTable {...aiSdk_useAISDKRuntime} />
-
-### useChatRuntime
-
-<ParametersTable {...aiSdk_useChatRuntime} />
-
-### useThreadTokenUsage
-
-```ts
-function useThreadTokenUsage(): ThreadTokenUsage | undefined;
-```
-
-### generativeTools
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use [AISDKToolkit](/docs/api-reference/integrations/ai-sdk#aisdktoolkit) instead:
-`new AISDKToolkit({ toolkit }).tools({ frontend })`. It is a strict superset
-(it also opens MCP server connections), so it replaces `generativeTools`
-everywhere. The `frontendTools` option is named `frontend` on `.tools()`, and
-`.tools()` is async. `generativeTools` will be removed in a future version.
-</Callout>
-
-Builds an AI SDK `ToolSet` for server-side use with `streamText` /
-`generateText` from a generative `toolkit` and the frontend-uploaded tools.
-
-Each toolkit tool's `execute` runs on the server. Pair this with the
-`"use generative"` compiler: import the toolkit in a server route (where it
-resolves to the server build — schema + `execute`, with `render` stripped) and
-pass it here. Tools without an `execute` are still exposed to the model but
-left for the client to fulfill. `frontendTools` lets the client contribute
-tools that aren't in the static toolkit.
-
-```ts
-// Define once at module scope so any MCP connections pool across requests.
-const aiToolkit = new AISDKToolkit({ toolkit: docsToolkit });
-
-// In your route handler:
-const { tools } = await req.json();
-streamText({
-  model,
-  messages,
-  tools: await aiToolkit.tools({ frontend: tools }),
-});
-```
-
-```ts
-const generativeTools: (options: GenerativeToolsOptions) => ToolSet;
-```
-{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx

@@ -1,24 +0,0 @@
----
-title: "@assistant-ui/cloud-ai-sdk"
-description: Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes.
----
-
-import { cloudAiSdk_useCloudChat, cloudAiSdk_useThreads } from "@/generated/integrationTypeDocs";
-
-{/* 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
-
-### useCloudChat
-
-<ParametersTable {...cloudAiSdk_useCloudChat} />
-
-### useThreads
-
-<ParametersTable {...cloudAiSdk_useThreads} />
-{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx

@@ -1,118 +0,0 @@
----
-title: "@assistant-ui/eve"
-description: Eve runtime hook and message conversion utilities for assistant-ui React applications.
----
-
-import { eve_useEveAgentRuntime } from "@/generated/integrationTypeDocs";
-
-{/* 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
-
-### convertEveMessage
-
-Converts a single Eve message into an assistant-ui thread message.
-
-```ts
-const convertEveMessage: (message: EveMessage, index: number, messages: readonly EveMessage[], options?: ConvertEveMessagesOptions) => ThreadMessage;
-```
-
-### convertEveMessages
-
-Converts the full Eve message data object into assistant-ui thread messages.
-
-```ts
-const convertEveMessages: (data: EveMessageData, options?: ConvertEveMessagesOptions) => ThreadMessage[];
-```
-
-### getEveMessageContent
-
-Converts an assistant-ui append message into the message payload accepted by
-Eve's `send` API.
-
-```ts
-const getEveMessageContent: (message: AppendMessage) => EveMessageContent;
-```
-
-### toEveInputResponse
-
-Converts an assistant-ui tool approval response into an Eve input response.
-
-When `inputRequest` is known, every returned response carries either an
-option the request declares or a free-form answer. A literal option match
-wins, then the `"approve"` / `"cancel"` option the response's boolean decision
-names, then the response's `reason` text when the request takes a free-form
-answer (`display: "text"`, `allowFreeform`, or no options at all, and never
-`display: "confirmation"`) and the response is not a refusal.
-A one-argument call, or a part with no request, still forwards a caller
-`optionId` as it always has, including ids the request never declared.
-
-A response the known request cannot record as the answer it asked for throws
-instead of being submitted, because eve resolves a request the moment any
-response for it arrives, and an empty one is recorded as an answer with no
-content. Not sending leaves the request pending, so the caller can retry or
-the user can answer it as an ordinary message.
-
-With no request to map against — a one-argument call, or a part carrying no
-`toolMetadata.eve.inputRequest` — the response maps as it always has, to the
-literal `"approve"` / `"cancel"` option every eve approval declares. Guessing
-a display mode is what this mapper stopped doing; an unknown request is not
-a guess about one.
-
-```ts
-const toEveInputResponse: (response: RespondToToolApprovalOptions, inputRequest?: EveMessageInputRequest) => InputResponse;
-```
-
-### useEveAgentRuntime
-
-Connects Eve's `useEveAgent` hook to assistant-ui's runtime contract.
-
-The runtime renders Eve messages, forwards new user messages to the Eve
-session, supports cancellation, and maps Eve input requests to assistant-ui
-tool approval UI.
-
-<ParametersTable {...eve_useEveAgentRuntime} />
-
-### useEveError
-
-Read the last Eve session error from the runtime extras.
-
-```ts
-const useEveError: () => Error | undefined;
-```
-
-### useEveEvents
-
-Read the authoritative Eve server event stream from the runtime extras.
-Defaults to an empty array outside an Eve runtime.
-
-```ts
-const useEveEvents: () => EveRuntimeExtras["events"];
-```
-
-### useEveReset
-
-Returns a function that resets the Eve session: aborts any in-flight turn,
-recreates the owned session, and clears events and projected data. Pending
-staged messages and tool execution state are discarded. Safe to render
-outside an Eve runtime; invoking the returned function there throws.
-
-```ts
-const useEveReset: () => () => void;
-```
-
-### useEveSession
-
-Read the current Eve session cursor from the runtime extras. Persist it to
-resume the session later via `initialSession`. `undefined` when no session
-exists yet or outside an Eve runtime.
-
-```ts
-const useEveSession: () => EveRuntimeExtras["session"] | undefined;
-```
-{/* api-reference:end */}

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

@@ -1,28 +0,0 @@
----
-title: Integrations API Reference
-description: Package-level APIs for connecting assistant-ui React to the Vercel AI SDK, Assistant Cloud, and adjacent chat ecosystem hooks and runtimes.
----
-
-{/* 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 */}
-Integration packages connect assistant-ui to adjacent React and AI ecosystems. Use this section when you need the exact hooks, options, and helper exports for a package such as `@assistant-ui/ai-sdk`, `@assistant-ui/react-data-stream`, `@assistant-ui/cloud-ai-sdk`, or `@assistant-ui/eve`.
-{/* api-manual:end */}
-
-## Pages
-
-<Cards>
-  <Card title={"@assistant-ui/ai-sdk"} href={"/docs/api-reference/integrations/ai-sdk"}>
-    {"Vercel AI SDK runtime hooks, chat transports, and message conversion utilities for assistant-ui applications."}
-  </Card>
-  <Card title={"@assistant-ui/react-data-stream"} href={"/docs/api-reference/integrations/react-data-stream"}>
-    {"Data stream runtime hook and message conversion utilities for custom assistant-ui streaming backends."}
-  </Card>
-  <Card title={"@assistant-ui/cloud-ai-sdk"} href={"/docs/api-reference/integrations/cloud-ai-sdk"}>
-    {"Assistant Cloud AI SDK hooks for connecting cloud-backed threads, persistence, and chat state to assistant-ui React runtimes."}
-  </Card>
-  <Card title={"@assistant-ui/eve"} href={"/docs/api-reference/integrations/eve"}>
-    {"Eve runtime hook and message conversion utilities for assistant-ui React applications."}
-  </Card>
-</Cards>

package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx

@@ -1,37 +0,0 @@
----
-title: "@assistant-ui/react-data-stream"
-description: Data stream runtime hook and message conversion utilities for custom assistant-ui streaming backends.
----
-
-import { reactDataStream_toLanguageModelMessages, reactDataStream_useCloudRuntime, reactDataStream_useDataStreamRuntime } from "@/generated/integrationTypeDocs";
-
-{/* 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
-
-### useDataStreamRuntime
-
-<ParametersTable {...reactDataStream_useDataStreamRuntime} />
-
-### toLanguageModelMessages
-
-<Callout type="warn">
-<strong>Deprecated.</strong> Use `toGenericMessages` from `assistant-stream` for framework-agnostic conversion.
-This function is kept for AI SDK compatibility.
-</Callout>
-
-<ParametersTable {...reactDataStream_toLanguageModelMessages} />
-
-### useCloudRuntime
-
-<Callout type="warn">
-<strong>Deprecated.</strong> This is under active development and not yet ready for prod use.
-</Callout>
-
-<ParametersTable {...reactDataStream_useCloudRuntime} />
-{/* api-reference:end */}

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

@@ -1,50 +0,0 @@
----
-title: Model Context
-description: Provide model instructions, contextual state, and inline renderers to assistant-ui runtimes.
----
-
-import { ModelContextProvider, useAssistantContext, useAssistantInstructions, useInlineRender } 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
-
-### makeAssistantVisible
-
-```ts
-const makeAssistantVisible: <T extends ComponentType<any>>(Component: T, config?: { clickable?: boolean | undefined; editable?: boolean | undefined; }) => T;
-```
-
-### mergeModelContexts
-
-```ts
-const mergeModelContexts: (configSet: Set<ModelContextProvider>) => ModelContext;
-```
-
-### ModelContextClient
-
-```ts
-const ModelContextClient: Resource<ClientOutput<"modelContext">, []>;
-```
-
-### ModelContextProvider
-
-<ParametersTable {...ModelContextProvider} />
-
-### useAssistantContext
-
-<ParametersTable {...useAssistantContext} />
-
-### useAssistantInstructions
-
-<ParametersTable {...useAssistantInstructions} />
-
-### useInlineRender
-
-<ParametersTable {...useInlineRender} />
-{/* api-reference:end */}

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

@@ -1,22 +0,0 @@
----
-title: Model Context API Reference
-description: Model instructions, contextual state, provider registries, and renderers for giving assistant-ui runtimes app-aware context.
----
-
-{/* 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 */}
-Model context is the layer that tells the assistant what the surrounding app knows. Use it to contribute instructions, register contextual providers, and keep model-facing state close to the React components that own it.
-{/* api-manual:end */}
-
-## Pages
-
-<Cards>
-  <Card title={"Model Context"} href={"/docs/api-reference/model-context/context"}>
-    {"Provide model instructions, contextual state, and inline renderers to assistant-ui runtimes."}
-  </Card>
-  <Card title={"Model Context Registry"} href={"/docs/api-reference/model-context/registry"}>
-    {"Register and manage assistant-ui model context providers that contribute instructions and app state."}
-  </Card>
-</Cards>

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

@@ -1,20 +0,0 @@
----
-title: Model Context Registry
-description: Register and manage assistant-ui model context providers that contribute instructions and app state.
----
-
-import { ModelContextRegistry } 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
-
-### ModelContextRegistry
-
-<ParametersTable {...ModelContextRegistry} />
-{/* api-reference:end */}