wehub-resource-sync
e30e75b5d4
Changesets / Create Version PR (push) Has been cancelled
Deploy Shadcn Registry / Deploy Production (push) Has been cancelled
Template Metrics / LOC + Bundle Size (push) Has been cancelled
Code Quality / Oxlint + Oxfmt (push) Has been cancelled
Code Quality / Template Sync (push) Has been cancelled
Code Quality / Build Changed Packages (push) Has been cancelled
Code Quality / Test Changed Packages (push) Has been cancelled
Deploy Expo Example / Deploy Production (push) Has been cancelled
Deploy Ink Example / Deploy Production (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.12) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.12) (push) Has been cancelled
71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
# `@assistant-ui/mcp-docs-server`
|
|
|
|
Model Context Protocol (MCP) server that gives AI assistants direct access to assistant-ui's documentation and example projects. Exposes `assistantUIDocs` (retrieve documentation by path), `assistantUIExamples` (access complete example projects), and `assistantUISearch` (keyword search across the bundled docs), and serves the same docs and examples as readable MCP **resources** (`aui-docs:///{path}`, `aui-example:///{name}`).
|
|
|
|
> [!NOTE]
|
|
> Detailed installation, troubleshooting, and advanced usage at [assistant-ui.com/docs/llm#mcp](https://www.assistant-ui.com/docs/llm#mcp).
|
|
|
|
## Installation
|
|
|
|
### Claude Code
|
|
|
|
```bash
|
|
claude mcp add assistant-ui -- npx -y @assistant-ui/mcp-docs-server
|
|
# or globally for all projects
|
|
claude mcp add --scope user assistant-ui -- npx -y @assistant-ui/mcp-docs-server
|
|
```
|
|
|
|
### Claude Desktop
|
|
|
|
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"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Cursor / Windsurf
|
|
|
|
Add to `.cursor/mcp.json` (or `~/.cursor/mcp.json`) for Cursor, or `~/.codeium/windsurf/mcp_config.json` for Windsurf, using the same `mcpServers` block as above.
|
|
|
|
### VS Code
|
|
|
|
Add to `.vscode/mcp.json`:
|
|
|
|
```json
|
|
{
|
|
"servers": {
|
|
"assistant-ui": {
|
|
"command": "npx",
|
|
"args": ["-y", "@assistant-ui/mcp-docs-server"],
|
|
"type": "stdio"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Zed
|
|
|
|
Add to `settings.json`:
|
|
|
|
```json
|
|
{
|
|
"context_servers": {
|
|
"assistant-ui": {
|
|
"command": {
|
|
"path": "npx",
|
|
"args": ["-y", "@assistant-ui/mcp-docs-server"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
To list, get, or remove the server, use your editor's MCP management commands.
|