使用说明
yuque-mcp-server
语雀 MCP 服务器 — 通过 Model Context Protocol 让 AI 助手直接访问语雀知识库。
功能
| 工具 | 说明 |
|---|---|
get_user |
获取当前认证用户的个人信息 |
list_repos |
获取指定用户或团队下的知识库列表 |
list_docs |
获取指定知识库下的文档列表 |
get_doc |
获取文档详情内容 |
search_docs |
搜索语雀文档 |
get_repo_toc |
获取知识库的目录结构 |
前置要求
- Node.js >= 18
- 语雀 API Token(在 语雀个人设置 中创建)
安装
npm install -g @momentyy/yuque-mcp-server
配置
在 MCP 客户端的配置文件中添加:
{
"mcpServers": {
"yuque": {
"command": "npx",
"args": ["-y", "@momentyy/yuque-mcp-server"],
"env": {
"YUQUE_API_TOKEN": "your-token-here"
}
}
}
}
环境变量
| 变量 | 必填 | 说明 |
|---|---|---|
YUQUE_API_TOKEN |
是 | 语雀 API Token |
YUQUE_BASE_URL |
否 | 自定义 API 地址,默认 https://www.yuque.com/api/v2 |
开发
# 开发模式运行
npm run dev
# 运行测试
npm test
许可证
MIT