@assistant-ui/mcp-docs-server 0.1.18 → 0.1.20

package/.docs/raw/docs/{getting-started.mdx → (docs)/installation.mdx}

@@ -1,16 +1,15 @@
 ---
-title: Getting Started
+title: Installation
+description: Get assistant-ui running in 5 minutes with npm and your first chat component.
 ---
 
-import { Step, Steps } from "fumadocs-ui/components/steps";
-import { Tab, Tabs } from "fumadocs-ui/components/tabs";
-import { Callout } from "fumadocs-ui/components/callout";
-import { Card, Cards } from "fumadocs-ui/components/card";
-import { InstallCommand } from "@/components/docs/install-command";
+import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
 
-## Start with a new project
+## Quick Start
 
-![animated gif showing the steps to create a new project](../../../../.github/assets/assistant-ui-starter.gif)
+The fastest way to get started with assistant-ui.
+
+![animated gif showing the steps to create a new project](../../../../../.github/assets/assistant-ui-starter.gif)
 
 <Steps>
   <Step>
@@ -20,11 +19,13 @@ import { InstallCommand } from "@/components/docs/install-command";
 **Create a new project:**
 
 ```sh
-# Create a new project with the default template
 npx assistant-ui@latest create
+```
+
+Or choose a template:
 
-# Or choose one of the following templates:
-# Assistant Cloud for baked in persistence and thread management
+```sh
+# Assistant Cloud - with persistence and thread management
 npx assistant-ui@latest create -t cloud
 
 # LangGraph
@@ -34,10 +35,9 @@ npx assistant-ui@latest create -t langgraph
 npx assistant-ui@latest create -t mcp
 ```
 
-**Add assistant-ui to an existing React project:**
+**Add to an existing project:**
 
 ```sh
-# Add assistant-ui to an existing React project
 npx assistant-ui@latest init
 ```
 
@@ -46,13 +46,10 @@ npx assistant-ui@latest init
 
 ### Add API key
 
-Add a new `.env` file to your project with your OpenAI API key:
+Create a `.env` file with your API key:
 
 ```
 OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-
-# chat history -- sign up for free on https://cloud.assistant-ui.com
-# NEXT_PUBLIC_ASSISTANT_BASE_URL="https://..."
 ```
 
   </Step>
@@ -67,11 +64,9 @@ npm run dev
   </Step>
 </Steps>
 
-## Manual installation
+## Manual Setup
 
-<Callout>
-  We recommend `npx assistant-ui init` to setup existing projects.
-</Callout>
+If you prefer not to use the CLI, you can install components manually.
 
 <Steps>
   <Step>
@@ -404,7 +399,7 @@ const MyApp = () => {
 ```
 
 ```tsx title="/app/page.tsx" tab="AssistantModal"
-// run `npx shadcn@latest add @assistant-ui/assistant-modal`
+// run `npx shadcn@latest add https://r.assistant-ui.com/assistant-modal.json`
 
 import { AssistantRuntimeProvider } from "@assistant-ui/react";
 import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
@@ -441,7 +436,7 @@ const MyApp = () => {
   <Card
     title="Generative UI"
     description="Create rich UI components for tool executions"
-    href="/docs/guides/ToolUI"
+    href="/docs/guides/tool-ui"
   />
   <Card
     title="Add Persistence"

package/.docs/raw/docs/(docs)/llm.mdx

@@ -0,0 +1,209 @@
+---
+title: "AI-Assisted Development"
+description: Use AI tools to build with assistant-ui faster. AI-accessible documentation, Claude Code skills, and MCP integration.
+---
+
+import { FileText } from "lucide-react";
+
+Build faster with AI assistants that understand assistant-ui. This page covers all the ways to give your AI tools access to assistant-ui documentation and context.
+
+## AI Accessible Documentation
+
+Our docs are designed to be easily accessible to AI assistants:
+
+<Cards>
+  <Card icon={<FileText className="text-blue-300" />} title="/llms.txt" href="/llms.txt" external>
+    Structured index of all documentation pages. Point your AI here for a quick overview.
+  </Card>
+
+  <Card icon={<FileText className="text-green-300" />} title="/llms-full.txt" href="/llms-full.txt" external>
+    Complete documentation in a single file. Use this for full context.
+  </Card>
+
+  <Card icon={<FileText className="text-purple-300" />} title=".mdx suffix">
+    Add `.mdx` to any page's URL to get raw markdown content (e.g., `/docs/installation.mdx`).
+  </Card>
+</Cards>
+
+### Context Files
+
+Add assistant-ui context to your project's `CLAUDE.md` or `.cursorrules`:
+
+```md
+## assistant-ui
+
+This project uses assistant-ui for chat interfaces.
+
+Documentation: https://www.assistant-ui.com/llms-full.txt
+
+Key patterns:
+- Use AssistantRuntimeProvider at the app root
+- Thread component for full chat interface
+- AssistantModal for floating chat widget
+- useChatRuntime hook with AI SDK transport
+```
+
+## Skills
+
+Install assistant-ui skills for AI Tools:
+
+```sh
+npx skills add assistant-ui/skills
+```
+
+| Skill | Purpose |
+|-------|---------|
+| `/assistant-ui` | General architecture and overview guide |
+| `/setup` | Project setup and configuration (AI SDK, LangGraph, custom backends) |
+| `/primitives` | UI component primitives (Thread, Composer, Message, etc.) |
+| `/runtime` | Runtime system and state management |
+| `/tools` | Tool registration and tool UI |
+| `/streaming` | Streaming protocol with assistant-stream |
+| `/cloud` | Cloud persistence and authorization |
+| `/thread-list` | Multi-thread management |
+| `/update` | Update assistant-ui and AI SDK to latest versions |
+
+Use by typing the command in Claude Code, e.g., `/assistant-ui` for the main guide or `/setup` when setting up a project.
+
+## MCP
+
+`@assistant-ui/mcp-docs-server` provides direct access to assistant-ui documentation and examples in your IDE via the Model Context Protocol.
+
+Once installed, your AI assistant will understand everything about assistant-ui - just ask naturally:
+
+- "Add a chat interface with streaming support to my app"
+- "How do I integrate assistant-ui with the Vercel AI SDK?"
+- "My Thread component isn't updating, what could be wrong?"
+
+### Quick Install (CLI)
+
+```bash
+npx assistant-ui mcp
+```
+
+Or specify your IDE directly:
+
+```bash
+npx assistant-ui mcp --cursor
+npx assistant-ui mcp --windsurf
+npx assistant-ui mcp --vscode
+npx assistant-ui mcp --zed
+npx assistant-ui mcp --claude-code
+npx assistant-ui mcp --claude-desktop
+```
+
+### Manual Installation
+
+<Tabs items={["Cursor", "Windsurf", "VSCode", "Zed", "Claude Code", "Claude Desktop"]}>
+  <Tab>
+<a href="cursor://anysphere.cursor-deeplink/mcp/install?name=assistant-ui&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBhc3Npc3RhbnQtdWkvbWNwLWRvY3Mtc2VydmVyIl19">
+  <img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor" className="not-prose" />
+</a>
+
+Or add to `.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "assistant-ui": {
+      "command": "npx",
+      "args": ["-y", "@assistant-ui/mcp-docs-server"]
+    }
+  }
+}
+```
+
+After adding, open Cursor Settings → MCP → find "assistant-ui" and click enable.
+  </Tab>
+  <Tab>
+Add to `~/.codeium/windsurf/mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "assistant-ui": {
+      "command": "npx",
+      "args": ["-y", "@assistant-ui/mcp-docs-server"]
+    }
+  }
+}
+```
+
+After adding, fully quit and re-open Windsurf.
+  </Tab>
+  <Tab>
+Add to `.vscode/mcp.json` in your project:
+
+```json
+{
+  "servers": {
+    "assistant-ui": {
+      "command": "npx",
+      "args": ["-y", "@assistant-ui/mcp-docs-server"],
+      "type": "stdio"
+    }
+  }
+}
+```
+
+Enable MCP in Settings → search "MCP" → enable "Chat > MCP". Use GitHub Copilot Chat in Agent mode.
+  </Tab>
+  <Tab>
+Add to your Zed settings file:
+- macOS: `~/.zed/settings.json`
+- Linux: `~/.config/zed/settings.json`
+- Windows: `%APPDATA%\Zed\settings.json`
+
+Or open via `Cmd/Ctrl + ,` → "Open JSON Settings"
+
+```json
+{
+  "context_servers": {
+    "assistant-ui": {
+      "command": {
+        "path": "npx",
+        "args": ["-y", "@assistant-ui/mcp-docs-server"]
+      }
+    }
+  }
+}
+```
+
+The server starts automatically with the Assistant Panel.
+  </Tab>
+  <Tab>
+```bash
+claude mcp add assistant-ui -- npx -y @assistant-ui/mcp-docs-server
+```
+
+The server starts automatically once added.
+  </Tab>
+  <Tab>
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+
+```json
+{
+  "mcpServers": {
+    "assistant-ui": {
+      "command": "npx",
+      "args": ["-y", "@assistant-ui/mcp-docs-server"]
+    }
+  }
+}
+```
+
+Restart Claude Desktop after updating the configuration.
+  </Tab>
+</Tabs>
+
+### Available Tools
+
+| Tool | Description |
+|------|-------------|
+| `assistantUIDocs` | Access documentation: getting started, component APIs, runtime docs, integration guides |
+| `assistantUIExamples` | Browse code examples: AI SDK, LangGraph, OpenAI Assistants, tool UI patterns |
+
+### Troubleshooting
+
+- **Server not starting**: Ensure `npx` is installed and working. Check configuration file syntax.
+- **Tool calls failing**: Restart the MCP server and/or your IDE. Update to latest IDE version.

package/.docs/raw/docs/{api-reference/context-providers/AssistantRuntimeProvider.mdx → (reference)/api-reference/context-providers/assistant-runtime-provider.mdx}

@@ -1,8 +1,9 @@
 ---
 title: <AssistantRuntimeProvider />
+description: Root provider that connects your runtime to assistant-ui components.
 ---
 
-import { ParametersTable } from "@/components/docs";
+import { ParametersTable } from "@/components/docs/tables/ParametersTable";
 import { AssistantRuntimeProvider } from "@/generated/typeDocs";
 
 The `AssistantRuntimeProvider` provides data and APIs used by assistant-ui components.

package/.docs/raw/docs/{api-reference/context-providers/TextMessagePartProvider.mdx → (reference)/api-reference/context-providers/text-message-part-provider.mdx}

@@ -1,8 +1,9 @@
 ---
 title: <TextMessagePartProvider />
+description: Context provider for reusing text components outside of message content.
 ---
 
-import { ParametersTable } from "@/components/docs";
+import { ParametersTable } from "@/components/docs/tables/ParametersTable";
 import { AssistantRuntimeProvider } from "@/generated/typeDocs";
 
 The `TextMessagePartProvider` provides data and APIs for `TextMessagePart` components.

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

@@ -1,10 +1,11 @@
 ---
 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.
 
-import { ParametersTable } from "@/components/docs";
+import { ParametersTable } from "@/components/docs/tables/ParametersTable";
 
 ## API Reference
 
@@ -156,7 +157,12 @@ const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
 
 ### `toLanguageModelMessages`
 
-Convert assistant-ui messages to language model format.
+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";
@@ -191,4 +197,45 @@ const languageModelMessages = toLanguageModelMessages(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/{api-reference → (reference)/api-reference}/integrations/react-hook-form.mdx

@@ -1,10 +1,11 @@
 ---
 title: "@assistant-ui/react-hook-form"
+description: React Hook Form integration for AI-assisted form filling.
 ---
 
 A React Hook Form integration for @assistant-ui.
 
-import { ParametersTable } from "@/components/docs";
+import { ParametersTable } from "@/components/docs/tables/ParametersTable";
 
 ## API Reference
 

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

@@ -1,11 +1,11 @@
 ---
 title: "@assistant-ui/react-ai-sdk"
+description: Vercel AI SDK v5 integration with chat runtime hooks and transport utilities.
 ---
 
 Vercel AI SDK integration for assistant-ui.
 
-import { ParametersTable } from "@/components/docs";
-import { Callout } from "fumadocs-ui/components/callout";
+import { ParametersTable } from "@/components/docs/tables/ParametersTable";
 
 <Callout type="info">
   This package provides integration with AI SDK v5. For AI SDK v4, see the [AI

package/.docs/raw/docs/{api-reference → (reference)/api-reference}/overview.mdx

@@ -1,8 +1,8 @@
 ---
 title: Overview
+description: API reference for primitives, runtime hooks, and context providers.
 ---
 
-import { Callout } from "fumadocs-ui/components/callout";
 
 import { Component, ContextLevel, RuntimeHooks } from "./context";
 
@@ -35,7 +35,13 @@ export const contextColors = {
 
 - [`useDataStreamRuntime`](#use-data-stream-runtime)
 - [`useCloudRuntime`](#use-cloud-runtime)
-- [`toLanguageModelMessages`](#to-language-model-messages)
+- [`toLanguageModelMessages`](#to-language-model-messages) (AI SDK specific)
+
+### assistant-stream (Framework-Agnostic)
+
+- [`toGenericMessages`](#to-generic-messages)
+- [`toToolsJSONSchema`](#to-tools-json-schema)
+- [`GenericMessage`](#generic-message)
 
 ### LangGraph
 
@@ -239,7 +245,7 @@ A conversation thread.
       tooltip="Displayed when the thread is empty"
     />
     <Component
-      name="AssistantIf"
+      name="AuiIf"
       docsLink="#assistant-if"
       tooltip="Conditional rendering based on assistant state"
     />
@@ -383,7 +389,7 @@ Manages the state and actions for individual messages
     tooltip="Displays attachments in the message"
   />
   <Component
-    name="AssistantIf"
+    name="AuiIf"
     docsLink="#assistant-if"
     tooltip="Conditional rendering based on assistant state"
   />