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

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

@@ -1,483 +0,0 @@
----
-title: Installation
-description: Get assistant-ui running in 5 minutes with npm and your first chat component.
-platforms: ["react"]
----
-
-
-## Quick Start
-
-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>
-
-### Initialize assistant-ui
-
-**Create a new project:**
-
-```sh
-npx assistant-ui@latest create
-```
-
-Or start from a template:
-
-```sh
-npx assistant-ui@latest create -t cloud
-```
-
-The [CLI reference](/docs/cli#create) lists every template and example, and what each one includes.
-
-**Add to an existing project:**
-
-```sh
-npx assistant-ui@latest init
-```
-
-  </Step>
-  <Step>
-
-### Add API key
-
-Create a `.env` file with your API key:
-
-```
-OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-Developing locally with a ChatGPT Plus or Pro plan? You can skip the API key and run on your subscription instead; see [ChatGPT Subscription](/docs/guides/chatgpt-subscription).
-
-  </Step>
-  <Step>
-
-### Start the app
-
-```sh
-npm run dev
-```
-
-  </Step>
-</Steps>
-
-## Manual Setup
-
-If you prefer not to use the CLI, you can install components manually.
-
-Add the assistant-ui registry to your `components.json` so the shadcn CLI resolves components for your style. Styles whose name starts with `base-` receive Base UI flavored components; all other styles receive the Radix flavored ones. `npx shadcn init` defaults to Base UI styles (for example `base-nova`), so new projects need this style-aware URL for components that compile against that stack.
-
-```json title="components.json"
-{
-  "registries": {
-    "@assistant-ui": "https://r.assistant-ui.com/styles/{style}/{name}.json"
-  }
-}
-```
-
-Existing Radix projects can keep the plain form `https://r.assistant-ui.com/{name}.json` as a fallback (for example `npx shadcn@latest add https://r.assistant-ui.com/thread.json`).
-
-<Steps>
-  <Step>
-
-### Add assistant-ui
-
-<InstallCommand shadcn={["thread", "thread-list"]} manualSetupInstructions />
-
-  </Step>
-  <Step>
-
-### Setup Backend Endpoint
-
-Install provider SDK:
-
-<Tabs groupId="provider" items={["OpenAI", "Anthropic", "Azure", "AWS", "Gemini", "GCP", "Groq", "Fireworks", "Cohere", "Ollama", "Chrome AI"]}>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/openai"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/anthropic"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/azure"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/amazon-bedrock"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/google"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/google-vertex"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/groq"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/fireworks"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "@ai-sdk/cohere"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "ollama-ai-provider-v2"]} />
-  </Tab>
-  <Tab>
-    <InstallCommand npm={["ai", "@assistant-ui/ai-sdk", "chrome-ai"]} />
-  </Tab>
-</Tabs>
-
-Add an API endpoint:
-
-<Tabs groupId="provider" items={["OpenAI", "Anthropic", "Azure", "AWS", "Gemini", "GCP", "Groq", "Fireworks", "Cohere", "Ollama", "Chrome AI"]}>
-```ts title="/app/api/chat/route.ts" tab="OpenAI"
-import { openai } from "@ai-sdk/openai";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: openai("gpt-5.6-luna"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Anthropic"
-import { anthropic } from "@ai-sdk/anthropic";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: anthropic("claude-sonnet-4-6"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Azure"
-import { azure } from "@ai-sdk/azure";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: azure("your-deployment-name"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="AWS"
-import { bedrock } from "@ai-sdk/amazon-bedrock";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: bedrock("anthropic.claude-sonnet-4-6-v1:0"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Gemini"
-import { google } from "@ai-sdk/google";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: google("gemini-2.0-flash"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="GCP"
-import { vertex } from "@ai-sdk/google-vertex";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: vertex("gemini-2.0-flash"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Groq"
-import { groq } from "@ai-sdk/groq";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: groq("llama-3.3-70b-versatile"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Fireworks"
-import { fireworks } from "@ai-sdk/fireworks";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: fireworks("accounts/fireworks/models/llama-v3p3-70b-instruct"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Cohere"
-import { cohere } from "@ai-sdk/cohere";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: cohere("command-r-plus"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Ollama"
-import { ollama } from "ollama-ai-provider-v2";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: ollama("llama3"),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-```ts title="/app/api/chat/route.ts" tab="Chrome AI"
-import { chromeai } from "chrome-ai";
-import { frontendTools } from "@assistant-ui/ai-sdk";
-import { convertToModelMessages, streamText } from "ai";
-
-export const maxDuration = 30;
-
-export async function POST(req: Request) {
-  const { messages, system, tools } = await req.json();
-  const result = streamText({
-    model: chromeai(),
-    system,
-    messages: await convertToModelMessages(messages),
-    tools: frontendTools(tools),
-  });
-  return result.toUIMessageStreamResponse();
-}
-```
-
-</Tabs>
-
-Define environment variables:
-
-<Tabs groupId="provider" items={["OpenAI", "Anthropic", "Azure", "AWS", "Gemini", "GCP", "Groq", "Fireworks", "Cohere", "Ollama", "Chrome AI"]}>
-
-```sh title="/.env.local" tab="OpenAI"
-OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Anthropic"
-ANTHROPIC_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Azure"
-AZURE_RESOURCE_NAME="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-AZURE_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="AWS"
-AWS_ACCESS_KEY_ID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-AWS_SECRET_ACCESS_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-AWS_REGION="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Gemini"
-GOOGLE_GENERATIVE_AI_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="GCP"
-GOOGLE_VERTEX_PROJECT="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-GOOGLE_VERTEX_LOCATION="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-GOOGLE_APPLICATION_CREDENTIALS="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Groq"
-GROQ_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Fireworks"
-FIREWORKS_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh title="/.env.local" tab="Cohere"
-COHERE_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-```
-
-```sh tab="Ollama"
-<none>
-```
-
-```sh tab="Chrome AI"
-<none>
-```
-
-</Tabs>
-
-If you aren't using Next.js, you can also deploy this endpoint to Cloudflare Workers, or any other serverless platform.
-
-  </Step>
-
-  <Step>
-
-### Use it in your app
-
-<Tabs items={["Thread", "AssistantModal"]}>
-
-```tsx title="/app/page.tsx" tab="Thread"
-import { AssistantRuntimeProvider } from "@assistant-ui/react";
-import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/ai-sdk";
-import { ThreadList } from "@/components/assistant-ui/thread-list";
-import { Thread } from "@/components/assistant-ui/thread";
-
-export default function MyApp() {
-  const runtime = useChatRuntime({
-    transport: new AssistantChatTransport({
-      api: "/api/chat",
-    }),
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      <div>
-        <ThreadList />
-        <Thread />
-      </div>
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-```tsx title="/app/page.tsx" tab="AssistantModal"
-// run `npx shadcn@latest add @assistant-ui/assistant-modal`
-
-import { AssistantRuntimeProvider } from "@assistant-ui/react";
-import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/ai-sdk";
-import { AssistantModal } from "@/components/assistant-ui/assistant-modal";
-
-export default function MyApp() {
-  const runtime = useChatRuntime({
-    transport: new AssistantChatTransport({
-      api: "/api/chat",
-    }),
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      <AssistantModal />
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-</Tabs>
-
-</Step>
-</Steps>
-
-## What's Next?
-
-<Cards>
-  <Card
-    title="Pick a Runtime"
-    description="Choose the right runtime for your needs"
-    href="/docs/runtimes/pick-a-runtime"
-  />
-  <Card
-    title="Generative UI"
-    description="Let the model compose UI from a component vocabulary you ship"
-    href="/docs/tools/generative-ui"
-  />
-  <Card
-    title="Add Persistence"
-    description="Save and restore chat conversations"
-    href="/docs/cloud"
-  />
-  <Card
-    title="Examples"
-    description="Explore full implementations and demos"
-    href="https://github.com/assistant-ui/assistant-ui/tree/main/examples"
-  />
-</Cards>

package/.docs/raw/docs/(getting-started)/llm.mdx

@@ -1,211 +0,0 @@
----
-title: "Agent Skills"
-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 add-mcp @assistant-ui/mcp-docs-server
-```
-
-Or specify your IDE directly:
-
-```bash
-npx add-mcp @assistant-ui/mcp-docs-server -a claude-code
-npx add-mcp @assistant-ui/mcp-docs-server -a claude-desktop
-npx add-mcp @assistant-ui/mcp-docs-server -a codex
-npx add-mcp @assistant-ui/mcp-docs-server -a cursor
-npx add-mcp @assistant-ui/mcp-docs-server -a gemini-cli
-npx add-mcp @assistant-ui/mcp-docs-server -a opencode
-npx add-mcp @assistant-ui/mcp-docs-server -a vscode
-npx add-mcp @assistant-ui/mcp-docs-server -a zed
-```
-
-### 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.