语雀 MCP 服务器
English Version
一个用于与语雀 API 集成的 Model-Context-Protocol (MCP) 服务器。此实现受 Figma-Context-MCP 的启发，并使用 语雀开放 API。
概述
该服务器提供了与语雀知识库平台交互的 MCP 工具，允许 AI 模型：
- 获取用户和文档信息
- 创建、读取、更新和删除文档
- 搜索语雀中的内容
- 获取知识库信息
- 获取统计数据和分析信息
安装
安装 via Smithery
要使用 Smithery 将 Yuque MCP Server 自动安装到 Claude 桌面端：
npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude前提条件
- Node.js 18+ (推荐)
- 拥有 API 令牌的语雀账号
设置
克隆此仓库：
git clone https://github.com/Henryhaoson/Yueque-MCP-Server.git cd Yueque-MCP-Server安装依赖：
npm install基于
.env.example创建.env文件：cp .env.example .env(可选) 在
.env文件中添加你的语雀 API 令牌：YUQUE_API_TOKEN=your_yuque_api_token_here你也可以选择在连接到服务器时通过查询参数提供令牌，而不是在 .env 文件中设置。
使用方法
运行服务器
开发模式
# HTTP 服务器模式
npm run dev
# CLI stdio 模式
npm run dev:cli生产模式
首先，构建项目：
npm run build然后在 HTTP 或 CLI 模式下运行：
# HTTP 服务器模式
npm run start
# CLI stdio 模式
npm run start:cli使用 Docker 部署
本项目提供了 Docker 支持，使您可以轻松地容器化和部署服务器。
使用 Docker Compose（推荐）
构建并启动容器：
docker-compose up -d查看日志：
docker-compose logs -f停止服务：
docker-compose down
您可以通过环境变量或在 .env 文件中设置配置项：
