Henryhaoson Yuque MCP Server

🚀 语雀 Model-Context-Protocol (MCP) 服务器

本项目实现了一个 MCP 服务器，用于和语雀知识库进行交互。借助 Model-Context-Protocol 协议，AI 模型可连接到该服务器，利用注册工具与语雀平台的数据和功能开展交互。MCP 协议作为标准化协议，明确了 AI 模型与外部工具或服务之间的接口。通过此项目，AI 模型能够执行查询、创建、更新、删除文档以及获取团队统计信息等操作。

🚀 快速开始

本项目是一个用于与语雀知识库进行交互的 MCP 服务器实现。AI 模型可通过 MCP 协议连接到服务器，利用注册工具与语雀平台交互，执行查询、创建、更新、删除文档等操作。

✨ 主要特性

• 标准化协议：采用 MCP 标准化协议，定义 AI 模型与外部工具或服务的接口。
• 丰富操作支持：AI 模型可执行查询、创建、更新、删除文档，以及获取团队统计信息等操作。
• 新增团队统计数据功能：可获取团队、成员、知识库和文档的统计数据。
• 增强文档管理：支持多种文档格式（Markdown、HTML、Lake），具备完善的文档公开性设置（私密、公开、企业内公开）。
• 改进搜索功能：支持更多参数和过滤条件。
• 数据类型完善：接口定义与语雀 OpenAPI 规范保持一致。

📦 安装指南

依赖项

确保你已经安装了以下依赖：

• Node.js (版本要求：18.0.0 或更高)
• npm (版本要求：8.0.0 或更高)

克隆仓库

使用以下命令克隆本项目到你的本地开发环境：

git clone https://github.com/yourusername/yuque-mcp-server.git

安装依赖

进入项目目录后，运行以下命令安装所有依赖项：

npm install

📚 详细文档

配置

环境变量

复制 config.example.ts 文件到项目根目录，并重命名为 config.ts。根据你的需求修改配置参数。

// config.ts
export const config = {
  port: 3000, // 服务器端口
  baseUrl: 'https://api.yuque.com', // 语雀 API 基础 URL
  accessToken: 'your_api_token_here' // 语雀 API 访问令牌
};

其他配置

根据需要，你可以在 src/server.ts 中进一步调整服务器行为。

启动

启动 MCP 服务器：

npm run dev

或者在生产环境中使用：

npm start

使用

连接到 SSE 端点

你可以通过以下 URL 连接到服务器的 SSE（Server-Sent Events）端点：

const eventSource = new EventSource(`http://localhost:${config.port}/sse`);

查询参数覆盖

在连接到 SSE 端点时，可以通过查询参数覆盖环境变量中的配置：

// 示例 URL：
// http://localhost:3000/sse?accessToken=your_token_here&baseUrl=https://custom.yuque.api/v2

与 AI 模型集成

1. 启动 MCP 服务器。
2. 使用兼容的客户端连接到服务器。
3. AI 模型现在可以使用注册的工具与语雀知识库进行交互。

开发

项目结构

src/
├── config.ts          # 服务器配置
├── index.ts           # 主入口点
├── cli.ts             # CLI 入口点 
├── server.ts          # MCP 服务器实现
└── services/
    └── yuque.ts       # 语雀 API 服务

添加新工具

要在 src/server.ts 中的 registerTools 方法中添加新的工具。

📄 许可证

ISC