Yuque MCP Server

语雀 MCP Server — 通过 Model Context Protocol 让 AI 助手访问你的语雀知识库。

🌐 官网 · 📖 API 文档 · English

快速开始

1. 获取语雀 API Token

前往 语雀开发者设置 创建个人访问令牌。

2. 快速安装（推荐）

使用内置 CLI 命令一键配置 MCP 客户端：

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

支持的客户端：claude-desktop、vscode、cursor、windsurf、cline、trae

或使用交互式安装向导：

npx yuque-mcp setup

CLI 会自动找到对应操作系统的配置文件路径，与已有配置合并（不会覆盖其他服务器），并打印成功信息。

3. 手动配置

选择你使用的客户端：

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

或使用环境变量：

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

添加到 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"
      }
    }
  }
}

添加到工作区的 .vscode/mcp.json：

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

然后在 GitHub Copilot Chat 中启用 Agent 模式。

添加到 Cursor MCP 配置（~/.cursor/mcp.json）：

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

添加到 Windsurf MCP 配置（~/.windsurf/mcp.json）：

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

添加到 Cline MCP 配置（~/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 中，打开 设置，进入 MCP 部分，添加一个 stdio 类型的 MCP Server，配置如下：

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

详见 Trae MCP 文档。

更多客户端： 任何支持 stdio 传输的 MCP 客户端均可使用 yuque-mcp。通用配置：command = npx，args = ["-y", "yuque-mcp"]，env = YUQUE_PERSONAL_TOKEN。

4. 开始使用！

让 AI 助手搜索语雀文档、创建文档、管理知识库。

认证方式

服务器支持多种方式提供语雀 API Token：

| 方式 | 环境变量 / 参数 | 说明 | |------|----------------|------| | 个人 Token（推荐） | YUQUE_PERSONAL_TOKEN | 访问个人语雀账号 | | 团队 Token | YUQUE_GROUP_TOKEN | 访问语雀团队 | | 旧版 Token | YUQUE_TOKEN | 向后兼容 | | CLI 参数 | --token=YOUR_TOKEN | 通过命令行参数传入 |

优先级： YUQUE_PERSONAL_TOKEN > YUQUE_GROUP_TOKEN > YUQUE_TOKEN > --token

可用工具（25 个）

| 分类 | 工具 | |------|------| | 用户 | yuque_get_user、yuque_list_groups | | 搜索 | yuque_search | | 知识库 | yuque_list_repos、yuque_get_repo、yuque_create_repo、yuque_update_repo、yuque_delete_repo | | 文档 | yuque_list_docs、yuque_get_doc、yuque_create_doc、yuque_update_doc、yuque_delete_doc | | 目录 | yuque_get_toc、yuque_update_toc | | 版本 | yuque_list_doc_versions、yuque_get_doc_version | | 团队 | yuque_list_group_members、yuque_update_group_member、yuque_remove_group_member | | 统计 | yuque_group_stats、yuque_group_member_stats、yuque_group_book_stats、yuque_group_doc_stats | | 工具 | yuque_hello |

常见问题

| 错误 | 解决方案 | |------|----------| | YUQUE_PERSONAL_TOKEN is required | 设置环境变量（YUQUE_PERSONAL_TOKEN、YUQUE_GROUP_TOKEN 或 YUQUE_TOKEN）或传入 --token=YOUR_TOKEN | | 401 Unauthorized | Token 无效或已过期 — 到语雀设置重新生成 | | 429 Rate Limited | 请求过于频繁，等待后重试 | | 找不到工具 | 更新到最新版本：npx -y yuque-mcp@latest | | 找不到 npx 命令 | 安装 Node.js（v18 或更高版本） |

开发

git clone https://github.com/yuque/yuque-mcp-server.git
cd yuque-mcp-server
npm install
npm test              # 运行测试
npm run build         # 编译 TypeScript
npm run dev           # 开发模式（热重载）

链接

• 官网
• 语雀 API 文档
• MCP 协议
• MCP Registry
• 贡献指南

许可证

MIT