语雀 MCP 服务器

基本能力

产品定位

语雀 MCP 服务器是一个用于与语雀 API 集成的 MCP 服务器，旨在为 AI 模型提供与语雀知识库平台交互的能力。

核心功能

• 用户和文档管理：获取用户信息、创建/读取/更新/删除文档、搜索内容、获取知识库信息。
• 团队统计分析：获取团队、成员、知识库和文档的统计数据。
• 多种文档格式支持：支持 Markdown、HTML、Lake 等格式。
• 动态配置：支持通过查询参数动态配置 API 令牌和基础 URL。

适用场景

• AI 辅助文档编辑和管理。
• 自动化知识库维护和更新。
• 团队知识库使用情况分析和监控。

MCP 工具列表

1. 用户和文档管理工具：
2. get_current_user：获取当前用户信息。
3. get_user_docs：获取用户的所有文档列表。
4. get_user_repos：获取用户的知识库列表。
5. get_repo_docs：获取知识库中的文档列表。
6. get_doc：获取特定文档的详细内容。
7. create_doc：创建新文档。
8. update_doc：更新文档。
9. delete_doc：删除文档。
10. search：搜索内容。
11. 团队统计分析工具：
12. get_group_statistics：获取团队汇总统计数据。
13. get_group_member_statistics：获取团队成员统计数据。
14. get_group_book_statistics：获取团队知识库统计数据。
15. get_group_doc_statistics：获取团队文档统计数据。

常见问题解答

• 如何动态配置 API 令牌和基础 URL？：通过查询参数 accessToken 和 baseUrl 覆盖环境配置。
• 支持哪些文档格式？：支持 Markdown、HTML、Lake 等格式。

使用教程

使用依赖

• Node.js 18+
• 拥有 API 令牌的语雀账号

安装教程

1. 克隆仓库： bash git clone https://github.com/Henryhaoson/Yueque-MCP-Server.git cd Yueque-MCP-Server
2. 安装依赖： bash npm install
3. 创建 .env 文件： bash cp .env.example .env
4. 添加语雀 API 令牌（可选）： bash YUQUE_API_TOKEN=your_yuque_api_token_here

调试方式

• 开发模式：
• HTTP 服务器模式： bash npm run dev
• CLI stdio 模式： bash npm run dev:cli
• 生产模式：
• 构建项目： bash npm run build
• 运行：
  • HTTP 服务器模式： bash npm run start
  • CLI stdio 模式： bash npm run start:cli

Docker 部署

1. 使用 Docker Compose： bash docker-compose up -d
2. 手动使用 Docker： bash docker build -t yuque-mcp-server . docker run -d -p 3000:3000 --name yuque-mcp-server yuque-mcp-server

许可证

该项目遵循 MIT 开源许可条款。