语雀 MCP 服务器

基本能力

产品定位

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

核心功能

• 获取用户和文档信息
• 创建、读取、更新和删除文档
• 搜索语雀中的内容
• 获取知识库信息
• 获取统计数据和分析信息

适用场景

• AI 模型与语雀知识库的集成
• 团队知识库的管理和分析
• 文档内容的自动化处理

MCP 工具列表

用户和文档管理

• get_current_user - 获取当前认证用户的信息
• get_user_docs - 获取当前用户的所有知识库文档列表
• get_user_repos - 获取指定用户的知识库列表
• get_repo_docs - 获取特定知识库中的所有文档列表
• get_doc - 获取语雀中特定文档的详细内容
• create_doc - 在指定知识库中创建新的语雀文档
• update_doc - 更新语雀中已存在的文档
• delete_doc - 从语雀知识库中删除指定文档
• search - 在语雀平台中搜索文档或知识库内容

团队统计分析

• get_group_statistics - 获取团队的汇总统计数据
• get_group_member_statistics - 获取团队成员的统计数据
• get_group_book_statistics - 获取团队知识库的统计数据
• get_group_doc_statistics - 获取团队文档的统计数据

常见问题解答

• 如何配置语雀 API 令牌？可以在 .env 文件中设置 YUQUE_API_TOKEN 或通过查询参数动态提供。
• 如何运行服务器？可以使用 npm run dev 或 npm run start 命令启动服务器。

使用教程

使用依赖

• 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.example 创建 .env 文件： bash cp .env.example .env

4. (可选) 在 .env 文件中添加你的语雀 API 令牌： bash YUQUE_API_TOKEN=your_yuque_api_token_here

调试方式

开发模式

# HTTP 服务器模式
npm run dev

# CLI stdio 模式
npm run dev:cli

生产模式

# 构建项目
npm run build

# HTTP 服务器模式
npm run start

# CLI stdio 模式
npm run start:cli

使用 Docker 部署

使用 Docker Compose（推荐）

# 构建并启动容器
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止服务
docker-compose down

手动使用 Docker

# 构建 Docker 镜像
docker build -t yuque-mcp-server .

# 运行容器
docker run -d -p 3000:3000 --name yuque-mcp-server yuque-mcp-server

许可证

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