使用说明
Yuque MCP Server
让AI助手读写你的 Yuque (语雀) 知识库
通过 模型上下文协议.
连接后，向您的助手询问以下问题：
“在我的Yuque上搜索有关金丝雀发布的所有信息，并给我一页摘要。”
“把今天的会议记录变成我的文档 技术研究 书。"
“将此部署管道的流程图添加到设计文档中。”
快速开始
1.获得代币 --创建一个 Yuque开发人员设置。如果您使用绑定到Yuque空间的团队令牌，请同时注意空间主机（例如。 https://your-space.yuque.com)--你会把它当作 --host.
2.安装 --一个命令为您的操作系统定位正确的配置文件，并合并 yuque 在不接触其他服务器的情况下进入它：
npx yuque-mcp install --token=YOUR_TOKEN --client=cursor
支持的客户端： claude-desktop · vscode · cursor · windsurf · cline · trae · qoder · opencode更喜欢互动式流程？跑 npx yuque-mcp setup.
Claude Code
直接注册服务器：
claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN
Other MCP clients (generic config)
任何支持stdio传输的客户端都可以工作——请参阅 docs/clients.md 用于每个客户端的配置路径。
{
"mcpServers": {
"yuque": {
"command": "npx",
"args": ["-y", "yuque-mcp"],
"env": { "YUQUE_TOKEN": "YOUR_TOKEN" }
}
}
}
3.重新启动客户端 然后开始问。
配置
| 设置 | 环境变量/CLI标志 | 说明 |
|---|---|---|
| Token （必填） | YUQUE_TOKEN / --token |
个人或团队Yuque API代币 |
| 主机（可选） | YUQUE_HOST / --host |
站点或空间主机，例如。 https://your-space.yuque.com --空间受限的团队令牌和私有部署所需 |
场地根标准化为 /api/v2；未设置时，主机默认为 https://www.yuque.com/api/v2.
# Team token / private deployment
npx yuque-mcp install --token=YOUR_TOKEN --client=cursor --host=https://your-space.yuque.com
Migrating from an older config?
YUQUE_PERSONAL_TOKEN, YUQUE_BASE_URL，以及 --base-url 仍然作为传统的倒退。优先： YUQUE_TOKEN > YUQUE_PERSONAL_TOKEN > --token，以及 YUQUE_HOST > --host > YUQUE_BASE_URL > --base-url.新配置应使用 YUQUE_TOKEN 和 YUQUE_HOST.
工具（19）
每个工具都映射到一个Yuque API路由。
| 类别 | 工具 | 描述 |
|---|---|---|
| 用户 | yuque_get_user |
获取当前令牌的已验证用户 |
| 搜索 | yuque_search |
使用分页功能搜索文档或仓库 |
| 书籍 | yuque_list_books |
List books (知识库) of a user |
yuque_get_book |
按ID或命名空间获取书籍 | |
yuque_create_book |
创建一本书 | |
yuque_update_book |
更新名称、符号、描述或可见性 | |
| 文档 | yuque_list_docs |
列出书中的文档，并分页 |
yuque_get_doc |
获取完整内容——降价， lake，或 html |
|
yuque_create_doc |
在书中创建文档 | |
yuque_update_doc |
更新文档正文或元数据 | |
| 目录 | yuque_get_toc |
获取一本书的目录 |
yuque_update_toc |
添加或移动单个TOC节点 | |
| 备注 | yuque_list_notes |
列出笔记（小记录），带分页和状态过滤器 |
yuque_get_note |
获取内容完整的笔记 | |
yuque_create_note |
创建注释 | |
yuque_update_note |
更新注释 | |
| 板子 | yuque_get_resource |
从文档中读取电路板（思维导图/流程图/图表） |
yuque_create_resource |
在文档中创建一个板 | |
yuque_update_resource |
更新文档中的板 |
特别地， yuque_update_doc 不能将markdown正文与 title / slug / public 单个调用中的更改--单独更新元数据。完整的合同，包括YMD降价API和传统文档API之间的格式路由，记录在 文档/能力范围.md.
尚未涵盖： 评论、附件上传和文件管理、权限和成员管理、部门级文档编辑以及除板之外的结构化资源。
写入权限
创建/更新工具可以修改知识库中的真实内容，服务器可以执行令牌可以执行的任何操作。请对令牌保密，并首选空间范围的团队令牌（带 YUQUE_HOST)当你只在一个空间内工作时。要报告漏洞，请参阅 安全.md.
故障排除
| 错误 | 解决方案 |
|---|---|
YUQUE_TOKEN ... is required |
设置 YUQUE_TOKEN=YOUR_TOKEN 或通过 --token=YOUR_TOKEN |
401 Unauthorized |
令牌无效或已过期-- 再生它 |
429 Rate Limited |
请求太多--请稍候，然后重试 |
410 Gone |
目标已永久删除或端点已弃用——检查文档/书籍是否存在 |
| 找不到工具 | 更新到最新版本： 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 # run tests
npm run build # compile TypeScript
npm run dev # dev mode with hot reload
架构、技术栈和全工具合同上线 docs/.欢迎捐款----见 贡献.md.
链接
- 尤克API文件
- 模型上下文协议
- Yuque AI生态系统 --基于此服务器构建的技能和插件