Server Yuque.git

Yuque API MCP 服务

一个用于 Yuque API 的 MCP（Model Context Protocol）服务，使大模型能够与 Yuque API 无缝交互。

中文文档

功能

此服务提供以下工具，用于与 Yuque API 交互：

用户管理

• hello - 检查 Yuque API 连接是否正常
• get-current-user - 获取当前授权用户的详细信息

搜索

• search - 搜索文档、知识库、用户或团队

团队（群组）管理

• get-user-groups - 获取用户加入的团队列表
• get-group-users - 获取团队成员列表
• update-group-user - 更新团队成员的角色
• delete-group-user - 移除团队成员
• get-group-stats - 获取团队统计信息
• get-group-repos - 获取团队创建的知识库列表

仓库（知识库）管理

• get-user-repos - 获取用户创建的知识库列表
• create-repo - 创建知识库
• update-repo - 更新知识库信息
• delete-repo - 删除知识库
• get-repo-detail - 获取知识库详细信息

文档管理

• get-book-docs-list - 获取知识库的文档列表
• get-book-doc-detail - 获取知识库中文档的详细信息
• create-book-doc - 在知识库中创建文档
• update-book-doc - 更新知识库中的文档
• delete-book-doc - 从知识库中删除文档
• get-group-docs-list - 获取团队知识库的文档列表
• get-group-doc-detail - 获取团队知识库中文档的详细信息
• create-group-doc - 在团队知识库中创建文档
• update-group-doc - 更新团队知识库中的文档
• delete-group-doc - 从团队知识库中删除文档
• get-doc-versions - 获取文档版本历史
• get-doc-version-detail - 获取文档版本详情

目录（TOC）管理

• get-book-toc - 获取知识库目录（TOC）
• update-book-toc - 更新知识库目录（TOC）
• get-group-book-toc - 获取团队知识库目录（TOC）
• update-group-book-toc - 更新团队知识库目录（TOC）

安装和使用

前置条件

• Node.js 16.x 或更高版本
• Yuque API Token

安装

# Install dependencies
pnpm install

# Build the project
pnpm build

配置

设置 YUQUE_API_TOKEN 环境变量，以授权访问 Yuque API：

export YUQUE_API_TOKEN="your-api-token-here"

运行

# Start the server
pnpm start

在 VS Code 中使用

此项目已配置为可被 VS Code MCP 插件识别。如果已安装 VS Code MCP 插件，可以直接在 VS Code 中使用此服务：

1. 选择 MCP 作为“server-yuque”
2. 输入 Yuque API Token
3. 开始在 VS Code 中使用 Yuque MCP Server

{
  "servers": {
    "yuque-api": {
      "type": "stdio",
      "command": "node",
      "args": ["server-yuque"],
      "env": {
        "YUQUE_API_TOKEN": "YOUR_YUQUE_API_TOKEN"
      }
    }
  }
}

如何获取 Yuque API Token

1. 登录 Yuque 网站（www.yuque.com）
2. 进入个人设置页面
3. 点击“Developer Settings”
4. 创建新的 API Token

许可证

MIT