语雀知识库连接器
概述
本技能指导配置语雀官方 MCP Server(yuque-mcp),将 WorkBuddy 与语雀知识库打通。配置完成后,可通过 MCP 工具直接搜索、创建、更新语雀文档,上传文件到指定知识库文件夹。
前置条件
- Node.js v18+(WorkBuddy 已内置)
- 语雀个人访问令牌(Token)
Token 获取
前往 语雀 Token 设置页 创建个人访问令牌。登录语雀 → 点击头像 → 「设置」 → 左侧菜单「Tokens」 → 创建新令牌。
配置步骤
1. 获取 Token
询问用户提供语雀 Token。若没有,指导其按上方步骤获取。
2. 写入 MCP 配置
读取 ~/.workbuddy/mcp.json,合并写入以下配置:
{
"mcpServers": {
"yuque": {
"command": "npx",
"args": ["-y", "yuque-mcp"],
"env": {
"YUQUE_PERSONAL_TOKEN": "<用户的Token>"
}
}
}
}
注意:若已有其他 mcpServers 条目,只新增 yuque 条目,保留已有配置。
3. 激活连接器
告知用户:打开 WorkBuddy 左侧连接器管理页面,找到 yuque 连接器,点击「信任」激活。
配置完成后的可用工具
激活后提供 19 个 MCP 工具,按场景分类:
| 场景 | 工具 | 用途 |
|---|---|---|
| 搜索 | yuque_search |
全文搜索语雀内容 |
| 知识库 | yuque_list_books |
列出可访问的知识库 |
| 知识库 | yuque_get_book |
获取知识库详情 |
| 知识库 | yuque_create_book |
创建新知识库 |
| 文档 | yuque_list_docs |
列出知识库下文档 |
| 文档 | yuque_get_doc |
获取文档内容 |
| 文档 | yuque_create_doc |
在知识库中创建文档 |
| 文档 | yuque_update_doc |
更新文档内容 |
| 资源 | yuque_create_resource |
上传文件附件 |
| 资源 | yuque_get_resource |
获取资源信息 |
| 目录 | yuque_get_toc |
获取知识库目录结构 |
| 目录 | yuque_update_toc |
更新目录结构 |
| 小记 | yuque_list_notes |
列出小记 |
| 小记 | yuque_create_note |
创建小记 |
典型使用场景
上传文件到语雀知识库
- 使用
yuque_list_books列出知识库,找到目标知识库的book_id - 使用
yuque_get_toc获取目录结构,找到目标文件夹的doc_id - 使用
yuque_create_resource上传文件 - 使用
yuque_create_doc在指定目录下创建文档(引用上传的资源)
在语雀创建文档
- 使用
yuque_list_books找到目标知识库 - 使用
yuque_create_doc创建文档,传入title、body(Markdown 格式)、book_id
搜索语雀内容
- 使用
yuque_search,传入搜索关键词 - 根据返回结果读取具体文档
常见问题
| 错误 | 解决方案 |
|---|---|
YUQUE_PERSONAL_TOKEN is required |
检查 mcp.json 中 env 配置是否正确 |
401 Unauthorized |
Token 无效或过期,到语雀设置页重新生成 |
429 Rate Limited |
请求过于频繁,等待后重试 |
API 基准
- Base URL:
https://www.yuque.com/api/v2 - 认证: 请求头
X-Auth-Token - npm 包:
yuque-mcp - 官方仓库:
https://github.com/yuque/yuque-mcp-server
