使用说明
语雀MCP服务器
🎉 语雀MCP服务器
一个模型上下文协议(MCP)服务器,它能够与语雀(一个流行的中文文档平台)实现无缝集成。该服务器使AI助手能够通过标准化的MCP接口管理语雀中的内容。
✨ 特点
📚 知识库管理
- 列出并创建知识库
- 管理仓库设置和可见性
📄 文档操作
- 创建、读取、更新、删除文档
- 支持Markdown、Lake和HTML格式
- 高级文档搜索功能
🔍 搜索与发现
- 全局搜索和仓库特定搜索
- 智能查询处理
📦 安装
全局安装(推荐)
npm install -g yuque-mcp-server
本地安装
npm install yuque-mcp-server
来自源(或“原始出处”)
git clone https://github.com/tanis2010/yuque-mcp-server.git
cd yuque-mcp-server
npm install
npm run build
npm link
🔧 配置
获取你的语雀API令牌
- 登录语雀
- 进入:账户设置 → 开发者设置 → API令牌 (前往:账户设置 → 开发者设置 → API令牌)
- 创建新的令牌并复制它
2. 设置环境变量
export YUQUE_TOKEN="your_yuque_api_token_here"
Claude 代码集成机器人
这款MCP服务器是专为与Claude Code协同工作而设计的。以下是设置它的最简单方法:
🚀 快速设置(推荐)
使用Claude Code CLI自动配置MCP服务器:
# Install the package globally first
npm install -g yuque-mcp-server
# Add to Claude Code with automatic configuration
claude mcp add -s local yuque yuque-mcp-server --env YUQUE_TOKEN=your_yuque_api_token_here
就是这样!那个 claude mcp add 命令将会:
- 在您的Claude代码设置中自动配置MCP服务器
- 安全地处理环境变量
- 建立适当的指挥结构
手动配置(备选方案)
如果您更喜欢手动配置,您可以编辑 ~/.claude/settings.json 直接地:
{
"mcpServers": {
"yuque": {
"command": "yuque-mcp-server",
"env": {
"YUQUE_TOKEN": "your_yuque_api_token_here"
}
}
}
}
本地开发环境设置
从源代码进行开发:
{
"mcpServers": {
"yuque": {
"command": "node",
"args": ["path/to/yuque-mcp-server/dist/server.js"],
"env": {
"YUQUE_TOKEN": "your_yuque_api_token_here"
}
}
}
}
验证安装
设置完成后,重启 Claude Code,您应该能看到这些语雀工具已可用:
yuque_get_user- 获取当前用户信息yuque_get_repos- 列出知识库yuque_get_docs- 列出存储库中的文档yuque_get_doc- 获取文档详情yuque_create_doc- 创建新文档yuque_update_doc- 更新现有文档yuque_delete_doc- 删除文档yuque_search_docs- 搜索文档
API工具
该MCP服务器提供以下工具:
yuque_get_user 可以翻译为“获取用户信息”或“从语雀获取用户”,具体翻译取决于上下文和语雀(Yuque)在这个场景中的具体用途。如果“yuque”是特定平台或系统的名称,那么翻译时可能需要保留该名称以指明来源。在这里,为了简洁明了,我们可以翻译为“从语雀获取用户信息”
获取当前用户信息
获取语雀仓库(yuque_get_repos,这里“yuque”可能指某个特定平台或系统的名称,根据上下文可译为“语雀”或其他相应名称,但在此处直接保留原音译以体现其特定含义)
获取知识库列表
userId(可选):用户ID
获取语雀文档(yuque_get_docs)
获取文档列表
repoId(必需):知识库IDlimit(可选): 返回数量限制offset(可选): 偏移量
yuque_get_doc 翻译为中文是:“从语雀获取文档”
获取文档详情
docId(必需): 文档ID
创建文档于语雀(Yuque)
创建新文档
repoId(必需): 知识库IDtitle(必需): 文档标题content(必需): 文档内容format(可选):文档格式(markdown/lake/html)
更新语雀文档
更新文档
docId(必需): 文档IDtitle(可选): 文档标题content(可选): 文档内容format(可选): 文档格式
删除文档(Yuque平台相关操作)
删除文档
docId(必需): 文档ID
语雀搜索文档
搜索文档
query(必需):搜索关键词repoId(可选): 知识库ID
开发
# 开发模式
npm run dev
# 构建
npm run build
许可证
麻省理工学院(MIT)