说明

该项目使用AI进行重构测试测试提交

Yuque MCP Server

MCP server for Yuque (语雀) — expose your knowledge base to AI assistants through the Model Context Protocol.

🌐 Website · 📖 API Docs · 中文文档

Quick Start

1. Get Your Yuque API Token

Visit Yuque Developer Settings to create a personal access token.

2. Quick Install (Recommended)

Use the built-in CLI to auto-configure your MCP client in one command:

npx yuque-mcp install --token=YOUR_TOKEN --client=cursor

Supported clients: claude-desktop, vscode, cursor, windsurf, cline, trae

Or use the interactive setup wizard:

npx yuque-mcp setup

The CLI will automatically find the correct config file for your OS, merge with any existing configuration (without overwriting other servers), and print a success message.

3. Manual Configuration

Prefer to configure manually? Click to expand all client configs.

Choose your preferred client below:

Claude Code

claude mcp add yuque-mcp -- npx -y yuque-mcp --token=YOUR_TOKEN

Or using environment variables:

export YUQUE_PERSONAL_TOKEN=YOUR_TOKEN
claude mcp add yuque-mcp -- npx -y yuque-mcp

Claude Desktop

Add to your claude_desktop_config.json:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

VS Code (GitHub Copilot)

Add to .vscode/mcp.json in your workspace:

{
  "servers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

Then enable Agent mode in GitHub Copilot Chat.

Cursor

Add to your Cursor MCP configuration (~/.cursor/mcp.json):

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

Windsurf

Add to your Windsurf MCP configuration (~/.windsurf/mcp.json):

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

Cline (VS Code)

Add to your Cline MCP settings (~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json):

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

Trae

In Trae, open Settings and navigate to the MCP section, then add a new stdio-type MCP Server with the following configuration:

Command: npx
Args: -y yuque-mcp
Env: YUQUE_PERSONAL_TOKEN=YOUR_TOKEN

See Trae MCP documentation for detailed instructions.

More clients: Any MCP-compatible client that supports stdio transport can use yuque-mcp. The general pattern is: command = npx, args = ["-y", "yuque-mcp"], env = YUQUE_PERSONAL_TOKEN.

4. Done!

Ask your AI assistant to search your Yuque docs, create documents, or manage books.

Authentication

The server supports multiple ways to provide your Yuque API token:

| Method | Environment Variable / Flag | Description | |--------|---------------------------|-------------| | Personal Token (recommended) | YUQUE_PERSONAL_TOKEN | For accessing your personal Yuque account | | Group Token | YUQUE_GROUP_TOKEN | For accessing a Yuque group | | Legacy Token | YUQUE_TOKEN | Backward-compatible, works the same | | CLI Argument | --token=YOUR_TOKEN | Pass directly as a command-line argument |

Priority order: YUQUE_PERSONAL_TOKEN > YUQUE_GROUP_TOKEN > YUQUE_TOKEN > --token

Available Tools (25)

| Category | Tools | |----------|-------| | User | yuque_get_user, yuque_list_groups | | Search | yuque_search | | Books | yuque_list_repos, yuque_get_repo, yuque_create_repo, yuque_update_repo, yuque_delete_repo | | Docs | yuque_list_docs, yuque_get_doc, yuque_create_doc, yuque_update_doc, yuque_delete_doc | | TOC | yuque_get_toc, yuque_update_toc | | Versions | yuque_list_doc_versions, yuque_get_doc_version | | Groups | yuque_list_group_members, yuque_update_group_member, yuque_remove_group_member | | Stats | yuque_group_stats, yuque_group_member_stats, yuque_group_book_stats, yuque_group_doc_stats | | Utility | yuque_hello |

Troubleshooting

| Error | Solution | |-------|----------| | YUQUE_PERSONAL_TOKEN is required | Set one of the environment variables (YUQUE_PERSONAL_TOKEN, YUQUE_GROUP_TOKEN, or YUQUE_TOKEN) or pass --token=YOUR_TOKEN | | 401 Unauthorized | Token is invalid or expired — regenerate at Yuque Settings | | 429 Rate Limited | Too many requests — wait a moment and retry | | Tool not found | Update to the latest version: npx -y yuque-mcp@latest | | npx command not found | Install Node.js (v18 or later) |

Development

git clone https://github.com/yuque/yuque-mcp-server.git
cd yuque-mcp-server
npm install
npm test              # run tests
npm run build         # compile TypeScript
npm run dev           # dev mode with hot reload

License

MIT

MCP Servers

说明