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

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

@@ -1,260 +0,0 @@
----
-title: "@assistant-ui/react-data-stream"
-description: Hooks for connecting to data stream protocol endpoints and Assistant Cloud.
----
-
-Data Stream protocol integration for assistant-ui.
-
-
-## API Reference
-
-### `useDataStreamRuntime`
-
-Create a runtime that connects to a data stream protocol endpoint.
-
-```tsx
-import { useDataStreamRuntime } from "@assistant-ui/react-data-stream";
-
-const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
-  const runtime = useDataStreamRuntime({
-    api: "/api/chat",
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-};
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "api",
-      type: "string",
-      description: "The API endpoint URL for the data stream protocol.",
-    },
-    {
-      name: "protocol",
-      type: '"ui-message-stream" | "data-stream"',
-      description: 'The streaming protocol to use. Defaults to "ui-message-stream". Use "data-stream" for legacy AI SDK compatibility.',
-    },
-    {
-      name: "onData",
-      type: "(data: { type: string; name: string; data: unknown; transient?: boolean }) => void",
-      description: "Optional callback for data-* parts. Only applies when using the ui-message-stream protocol.",
-    },
-    {
-      name: "onResponse",
-      type: "(response: Response) => void | Promise<void>",
-      description: "Optional callback called when a response is received.",
-    },
-    {
-      name: "onFinish",
-      type: "(message: ThreadMessage) => void",
-      description: "Optional callback called when a message is finished.",
-    },
-    {
-      name: "onError",
-      type: "(error: Error) => void",
-      description: "Optional callback called when an error occurs.",
-    },
-    {
-      name: "onCancel",
-      type: "() => void",
-      description: "Optional callback called when a request is cancelled.",
-    },
-    {
-      name: "credentials",
-      type: "RequestCredentials",
-      description: "Optional credentials mode for the fetch request.",
-    },
-    {
-      name: "headers",
-      type: "Record<string, string> | Headers | (() => Promise<Record<string, string> | Headers>)",
-      description: "Optional headers to include in the request.",
-    },
-    {
-      name: "body",
-      type: "object | (() => Promise<object | undefined>)",
-      description: "Optional additional body parameters to include in the request. Can be an object or an async function that returns one.",
-    },
-    {
-      name: "sendExtraMessageFields",
-      type: "boolean",
-      description: "Whether to include extra message fields like IDs in the request.",
-    },
-  ]}
-/>
-
-### `useCloudRuntime`
-
-Create a runtime that connects to Assistant Cloud using the data stream protocol.
-
-```tsx
-import { useCloudRuntime } from "@assistant-ui/react-data-stream";
-
-const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
-  const runtime = useCloudRuntime({
-    cloud: assistantCloud,
-    assistantId: "my-assistant-id",
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-};
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "cloud",
-      type: "AssistantCloud",
-      description: "The Assistant Cloud instance.",
-    },
-    {
-      name: "assistantId",
-      type: "string",
-      description: "The ID of the assistant to connect to.",
-    },
-    {
-      name: "protocol",
-      type: '"ui-message-stream" | "data-stream"',
-      description: 'The streaming protocol to use. Defaults to "ui-message-stream". Use "data-stream" for legacy AI SDK compatibility.',
-    },
-    {
-      name: "onData",
-      type: "(data: { type: string; name: string; data: unknown; transient?: boolean }) => void",
-      description: "Optional callback for data-* parts. Only applies when using the ui-message-stream protocol.",
-    },
-    {
-      name: "onResponse",
-      type: "(response: Response) => void | Promise<void>",
-      description: "Optional callback called when a response is received.",
-    },
-    {
-      name: "onFinish",
-      type: "(message: ThreadMessage) => void",
-      description: "Optional callback called when a message is finished.",
-    },
-    {
-      name: "onError",
-      type: "(error: Error) => void",
-      description: "Optional callback called when an error occurs.",
-    },
-    {
-      name: "onCancel",
-      type: "() => void",
-      description: "Optional callback called when a request is cancelled.",
-    },
-    {
-      name: "credentials",
-      type: "RequestCredentials",
-      description: "Optional credentials mode for the fetch request.",
-    },
-    {
-      name: "headers",
-      type: "Record<string, string> | Headers | (() => Promise<Record<string, string> | Headers>)",
-      description: "Optional headers to include in the request.",
-    },
-    {
-      name: "body",
-      type: "object | (() => Promise<object | undefined>)",
-      description: "Optional additional body parameters to include in the request. Can be an object or an async function that returns one.",
-    },
-    {
-      name: "sendExtraMessageFields",
-      type: "boolean",
-      description: "Whether to include extra message fields like IDs in the request.",
-    },
-  ]}
-/>
-
-### `toLanguageModelMessages`
-
-Convert assistant-ui messages to AI SDK's `LanguageModelV2Message` format.
-
-<Callout type="info">
-For custom integrations, consider using `toGenericMessages` from `assistant-stream` instead.
-This function is specific to the AI SDK format.
-</Callout>
-
-```tsx
-import { toLanguageModelMessages } from "@assistant-ui/react-data-stream";
-
-const languageModelMessages = toLanguageModelMessages(messages, {
-  unstable_includeId: true,
-});
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "messages",
-      type: "readonly ThreadMessage[]",
-      description: "The messages to convert.",
-    },
-    {
-      name: "options",
-      type: "{ unstable_includeId?: boolean }",
-      description: "Optional conversion options.",
-      children: [
-        {
-          type: "{ unstable_includeId?: boolean }",
-          parameters: [
-            {
-              name: "unstable_includeId",
-              type: "boolean",
-              description: "Whether to include message IDs in the converted messages.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
----
-
-## Framework-Agnostic Utilities
-
-For custom integrations that don't use the AI SDK, use these utilities from `assistant-stream`:
-
-### `toGenericMessages`
-
-Convert thread messages to a framework-agnostic format.
-
-```tsx
-import { toGenericMessages } from "assistant-stream";
-
-const genericMessages = toGenericMessages(messages);
-```
-
-Returns an array of `GenericMessage` which can be one of:
-- `{ role: "system"; content: string }`
-- `{ role: "user"; content: (GenericTextPart | GenericFilePart)[] }`
-- `{ role: "assistant"; content: (GenericTextPart | GenericToolCallPart)[] }`
-- `{ role: "tool"; content: GenericToolResultPart[] }`
-
-### `toToolsJSONSchema`
-
-Convert tool definitions to JSON Schema format.
-
-```tsx
-import { toToolsJSONSchema } from "assistant-stream";
-
-const toolSchemas = toToolsJSONSchema(tools);
-// Returns: Record<string, { description?: string; parameters: JSONSchema7 }>
-```
-
-By default, filters out disabled tools and backend-only tools. Use the `filter` option to customize:
-
-```tsx
-const allTools = toToolsJSONSchema(tools, {
-  filter: () => true, // Include all tools
-});
-```

package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx

@@ -1,103 +0,0 @@
----
-title: "@assistant-ui/react-hook-form"
-description: React Hook Form integration for AI-assisted form filling.
----
-
-A React Hook Form integration for @assistant-ui.
-
-
-## API Reference
-
-### `useAssistantForm`
-
-Drop-in replacement hook for `useForm` that adds support for `@assistant-ui/react`.
-
-```diff
-- import { useForm } from "react-hook-form";
-+ import { useAssistantForm } from "@assistant-ui/react-hook-form";
-
-- useForm({
-+ useAssistantForm({
-    ...
-  });
-```
-
-#### Properties
-
-<ParametersTable
-  type="UseAssistantFormProps"
-  parameters={[
-    {
-      name: "assistant",
-      type: "object",
-      optional: true,
-      description: "Configuration for useAssistantForm",
-      children: [
-        {
-          parameters: [
-            {
-              name: "tools",
-              type: "object",
-              description: "Tools configuration for useAssistantForm",
-              children: [
-                {
-                  parameters: [
-                    {
-                      name: "set_form_field",
-                      type: "object",
-                      description: "Configuration for the set_form_field tool",
-                      children: [
-                        {
-                          parameters: [
-                            {
-                              name: "render",
-                              type: "ToolCallMessagePartComponent<{ name: string; value: string; }, {}>",
-                              description:
-                                "The component to render when set_form_field is called.",
-                            },
-                          ],
-                        },
-                      ],
-                    },
-                    {
-                      name: "submit_form",
-                      type: "object",
-                      description: "Configuration for the submit_form tool",
-                      children: [
-                        {
-                          parameters: [
-                            {
-                              name: "render",
-                              type: "ToolCallMessagePartComponent<{}, {}>",
-                              description:
-                                "The component to render when submit_form is called.",
-                            },
-                          ],
-                        },
-                      ],
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-### `formTools`
-
-The set of tools to use with `useAssistantForm` on the server side. While the AI SDK now supports forwarding frontend tools via `frontendTools()`, using `formTools` directly on the server gives you more control over tool execution.
-
-```tsx {1, 5-7}
-import { formTools } from "@assistant-ui/react-hook-form";
-
-const result = streamText({
-  ...
-  tools: {
-    ...formTools,
-  }
-});
-```

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

@@ -1,254 +0,0 @@
----
-title: "@assistant-ui/react-ai-sdk"
-description: Vercel AI SDK integration with chat runtime hooks and transport utilities.
----
-
-Vercel AI SDK integration for assistant-ui.
-
-
-<Callout type="info">
-  This package provides integration with AI SDK v6. For older versions, see the [AI
-  SDK v5 (Legacy)](/docs/runtimes/ai-sdk/v5-legacy) or [AI SDK v4 (Legacy)](/docs/runtimes/ai-sdk/v4-legacy) documentation.
-</Callout>
-
-## API Reference
-
-### `useChatRuntime`
-
-Creates a runtime with AI SDK's `useChat` hook integration. This is the recommended approach for most use cases.
-
-```tsx
-import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
-import { AssistantRuntimeProvider } from "@assistant-ui/react";
-
-const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
-  const runtime = useChatRuntime({
-    transport: new AssistantChatTransport({
-      api: "/api/chat",
-    }),
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-};
-```
-
-To customize the API endpoint, simply change the `api` parameter:
-
-```tsx
-const runtime = useChatRuntime({
-  transport: new AssistantChatTransport({
-    api: "/my-custom-api/chat",
-  }),
-});
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "options",
-      type: "UseChatRuntimeOptions",
-      description: "Configuration options for the chat runtime.",
-      children: [
-        {
-          type: "UseChatRuntimeOptions",
-          parameters: [
-            {
-              name: "transport",
-              type: "ChatTransport",
-              description:
-                "Custom transport implementation. Defaults to AssistantChatTransport (which sends requests to '/api/chat' and forwards system messages and tools). Use `new AssistantChatTransport({ api: '/custom-endpoint' })` to customize the endpoint.",
-            },
-            {
-              name: "cloud",
-              type: "AssistantCloud",
-              description:
-                "Optional AssistantCloud instance for chat persistence.",
-            },
-            {
-              name: "adapters",
-              type: "RuntimeAdapters",
-              description:
-                "Optional runtime adapters to extend or override built-in functionality (attachments, speech, dictation, feedback, history).",
-            },
-            {
-              name: "toCreateMessage",
-              type: "(message: AppendMessage) => CreateUIMessage",
-              description:
-                "Optional custom function to convert an AppendMessage into an AI SDK CreateUIMessage before sending.",
-            },
-            {
-              name: "initialMessages",
-              type: "UIMessage[]",
-              description: "Initial messages to populate the chat.",
-            },
-            {
-              name: "onFinish",
-              type: "(message: UIMessage) => void",
-              description: "Callback when a message completes streaming.",
-            },
-            {
-              name: "onError",
-              type: "(error: Error) => void",
-              description: "Callback for handling errors.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-<Callout type="info">
-  By default, `useChatRuntime` uses `AssistantChatTransport` which automatically
-  forwards system messages and frontend tools to your backend API. This enables
-  your backend to receive the full context from the assistant-ui.
-</Callout>
-
-### `useAISDKRuntime`
-
-For advanced use cases where you need direct access to the `useChat` hook from AI SDK.
-
-```tsx
-import { useChat } from "@ai-sdk/react";
-import { useAISDKRuntime } from "@assistant-ui/react-ai-sdk";
-import { AssistantRuntimeProvider } from "@assistant-ui/react";
-
-const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
-  const chat = useChat({
-    api: "/api/chat",
-  });
-
-  const runtime = useAISDKRuntime(chat);
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-};
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "chat",
-      type: "ReturnType<typeof useChat>",
-      description: "The chat helpers from @ai-sdk/react's useChat hook.",
-    },
-    {
-      name: "options",
-      type: "AISDKRuntimeAdapter",
-      description: "Optional configuration options.",
-      children: [
-        {
-          type: "AISDKRuntimeAdapter",
-          parameters: [
-            {
-              name: "adapters",
-              type: "RuntimeAdapters",
-              description:
-                "Optional runtime adapters for attachments, feedback, speech, etc.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-### `AssistantChatTransport`
-
-A transport that extends the default AI SDK transport to automatically forward system messages and frontend tools to your backend.
-
-```tsx
-import { AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
-import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
-
-const runtime = useChatRuntime({
-  transport: new AssistantChatTransport({
-    api: "/my-custom-api/chat",
-  }),
-});
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "options",
-      type: "HttpChatTransportInitOptions",
-      description: "Transport configuration options.",
-      children: [
-        {
-          type: "HttpChatTransportInitOptions",
-          parameters: [
-            {
-              name: "api",
-              type: "string",
-              description: "The API endpoint URL.",
-            },
-            {
-              name: "headers",
-              type: "Record<string, string> | Headers",
-              description: "Optional headers to include in requests.",
-            },
-            {
-              name: "credentials",
-              type: "RequestCredentials",
-              description: "Optional credentials mode for fetch requests.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-### `frontendTools`
-
-Helper function to convert frontend tool definitions to AI SDK format for use in your backend.
-
-```tsx
-import { frontendTools } from "@assistant-ui/react-ai-sdk";
-import { streamText, convertToModelMessages } from "ai";
-import { openai } from "@ai-sdk/openai";
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-
-  const result = streamText({
-    model: openai("gpt-4o"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: {
-      // Wrap frontend tools with the helper
-      ...frontendTools(tools),
-      // Your backend tools
-      myBackendTool: tool({
-        // ...
-      }),
-    },
-  });
-
-  return result.toUIMessageStreamResponse();
-}
-```
-
-<ParametersTable
-  parameters={[
-    {
-      name: "tools",
-      type: "Record<string, unknown>",
-      description:
-        "Frontend tools object forwarded from AssistantChatTransport.",
-    },
-  ]}
-/>
-
-<Callout type="info">
-  The `frontendTools` helper converts frontend tool definitions to the AI SDK
-  format and ensures they are properly handled by the streaming response.
-</Callout>