npm package: @rideds/docs-mcp
Description: The official MCP server for RUI Design documentation
Latest version: 0.5.1

# @rideds/docs-mcp

MCP (Model Context Protocol) tools for accessing RUI Design documentation. This package provides LLMs with structured access to RUI Design's React and Breeze component documentation, design guidelines, Rootage specifications, and more.

## Installation

```bash
npm install @rideds/docs-mcp
# or
bun add @rideds/docs-mcp
```

## Usage

### As a stdio MCP server (CLI)

For use with Claude Desktop or other MCP clients:

```bash
# Global installation
npm install -g @rideds/docs-mcp
rui-docs-mcp

# Or via npx
npx @rideds/docs-mcp
```

### Integration with Claude Desktop

Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "rui-docs": {
      "command": "npx",
      "args": ["-y", "@rideds/docs-mcp"]
    }
  }
}
```

Or if installed globally:

```json
{
  "mcpServers": {
    "rui-docs": {
      "command": "rui-docs-mcp"
    }
  }
}
```

### Programmatic Usage

For building custom MCP servers or integrating into your own applications:

```javascript
import { server } from "@rideds/docs-mcp/server";
import { initializeTools } from "@rideds/docs-mcp/tools";

// Initialize the tools
await initializeTools(server);

// Use with your preferred transport
// Example: stdio, HTTP, SSE, etc.
```

## Available Tools

### Discovery

- `discover_seed_docs` - Discover all available documentation sections and categories. Call this first to understand the documentation structure.

### Documentation

- `list_docs` - List available documents in a section (react, docs, breeze, ai-integration, lynx) with optional category filter
- `get_doc` - Get the content of a specific document by section and path
- `get_full_docs` - Get all documents from a section combined into a single text

### Rootage (Design Tokens & Component Specs)

- `get_rootage` - Get RUI Design rootage specifications (design tokens and component specs)
  - Without path: Returns index with all available resources
  - With path: Returns specific resource (e.g., `/color.json`, `/components/action-button.json`)

### Icons

- `list_icons` - List all available icons with optional type filter
- `search_icons` - Search icons by keyword
- `get_icon_details` - Get detailed information about a specific icon

## Documentation Sections

| Section          | Description                                                          |
| ---------------- | -------------------------------------------------------------------- |
| `react`          | React component library, API references, usage examples              |
| `docs`           | Component design guidelines, Foundation (color, typography, spacing) |
| `breeze`         | Ready-to-use utility UI components                                   |
| `ai-integration` | MCP, llms.txt integration guides                                     |
| `lynx`           | Lynx framework                                                       |

## Example Usage

```text
// 1. Discover available sections
discover_seed_docs()

// 2. List React components
list_docs({ section: "react", category: "components" })

// 3. Get specific component documentation
get_doc({ section: "react", path: "components/button" })

// 4. Get AI integration guide
get_doc({ section: "ai-integration", path: "figma-mcp" })
```

## Development

```bash
# Install dependencies
bun install

# Run in development mode (stdio)
bun run dev

# Build the package
bun run build

# Lint check
bun run lint

# Lint fix
bun run lint:fix

# Type check
bun run typecheck

# Clean build artifacts
bun run clean
```

### Test with MCP Inspector

```bash
npx @modelcontextprotocol/inspector bun ./dist/stdio.js
```