语雀 MCP 代理服务器
语雀 Model Context Protocol (MCP) 代理服务器，让 AI 助手能够通过 MCP 协议与语雀平台交互。
兼容性: 支持所有符合 MCP 标准的客户端，包括 Chatbox、Claude Desktop、Cherry Studio、Cursor 等主流工具。
✨ 功能特性
🔌 MCP 协议支持 - 完全兼容 Model Context Protocol 2024-11-05
🌐 多客户端支持 - 支持 Chatbox、Claude Desktop、Cherry Studio、Cursor 等主流工具
🪟 跨平台支持 - 支持 macOS、Linux 和 Windows 系统
📚 知识库管理 - 创建、读取、更新、删除知识库
📄 文档管理 - 完整的文档 CRUD 操作
🔍 搜索功能 - 全文搜索、高级搜索
👥 用户管理 - 获取用户信息、团队管理
🔐 安全配置 - 支持 HTTP Header 和环境变量配置 Token
🚀 自动启动 - 支持系统服务自动启动（macOS launchd / Windows Service）
📋 支持的工具
用户相关
get_user_info- 获取当前用户信息get_user- 获取指定用户信息
知识库管理
list_repos- 列出所有知识库list_user_repos- 列出指定用户的知识库get_repo- 获取知识库详情create_repo- 创建知识库update_repo- 更新知识库信息delete_repo- 删除知识库get_repo_toc- 获取知识库目录update_repo_toc- 更新知识库目录
文档管理
list_docs- 列出知识库中的文档get_doc- 获取文档内容create_doc- 创建文档update_doc- 更新文档delete_doc- 删除文档list_doc_versions- 列出文档版本历史
搜索功能
search_docs- 搜索文档
团队管理（需要团队权限）
list_groups- 列出团队get_group- 获取团队信息list_group_users- 列出团队成员list_group_repos- 列出团队知识库... 等更多功能
🚀 快速开始
方式一：Docker 部署（推荐）
方式二：本地部署
1. 克隆项目
2. 配置 Token
方式一：配置文件（推荐）
方式二：环境变量
方式三：HTTP Header（Chatbox 配置）
在 Chatbox 的 MCP Server 配置中，HTTP Header 字段添加：
获取 Token：语雀设置 > 个人设置 > Token
3. 启动服务
4. 验证服务
📝 常用命令
⚙️ 配置说明
配置文件格式
yuque-config.env:
配置优先级
HTTP Header (
X-Yuque-Token) - 最高优先级环境变量 (
YUQUE_TOKEN)配置文件 (
yuque-config.env)
如果都未配置，系统会返回明确的错误提示。
🔧 系统服务（macOS）
如果您希望服务在系统启动时自动运行：
安装后，服务会在开机时自动启动，无需手动操作。
服务管理
📚 文档
详细文档请查看 docs/ 目录：
docs/QUICK_START.md- 快速开始指南docs/CONFIG_GUIDE.md- 配置指南docs/DOCKER_DEPLOYMENT.md- Docker 部署指南（推荐）docs/AUTO_START_GUIDE.md- 自动启动指南（macOS）docs/WINDOWS_DEPLOYMENT.md- Windows 部署指南docs/CLIENT_COMPATIBILITY.md- 客户端兼容性指南（多工具配置）docs/YUQUE_API_REFERENCE.md- 语雀 API 接口文档（OpenAPI 规范）
🔒 安全提示
✅ 配置文件
yuque-config.env已添加到.gitignore，不会被提交到代码仓库✅ 文件权限已设置为 600（仅所有者可读写）
⚠️ 请勿将 Token 提交到代码仓库
⚠️ 定期轮换 Token，确保安全
🐛 故障排查
服务无法启动
Token 配置问题
端口被占用
📊 API 端点
POST /mcp- MCP 协议端点GET /health- 健康检查GET /test- 测试端点
🤝 贡献
欢迎提交 Issue 和 Pull Request！
📄 许可证
MIT License
🙏 致谢
提示: 所有操作都在项目根目录中执行。
This server cannot be installed