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

本项目是一个用于与语雀知识库进行交互的 MCP 服务器实现。它允许 AI 模型通过 Model-Context-Protocol 协议连接到服务器，进而利用注册的工具与语雀平台的数据和功能进行交互，实现如查询、创建、更新、删除文档，以及获取团队统计信息等操作。

🚀 快速开始

本项目是用于与语雀知识库交互的 MCP 服务器，AI 模型可通过 MCP 协议连接服务器，利用注册工具与语雀平台交互。以下是快速搭建服务器的步骤：

1. 完成安装依赖项、克隆仓库和安装项目依赖。
2. 配置环境变量和其他服务器行为。
3. 启动服务器。
4. 连接到 SSE 端点，可通过查询参数覆盖配置。
5. 与 AI 模型集成，让模型与语雀知识库交互。

✨ 主要特性

• 标准化协议支持：采用 MCP 标准化协议，定义 AI 模型与外部工具或服务的接口。
• 丰富操作功能：AI 模型可执行查询、创建、更新、删除文档，获取团队统计信息等操作。
• 多文档格式支持：支持 Markdown、HTML、Lake 等多种文档格式。
• 完善文档公开性设置：提供私密、公开、企业内公开等文档公开性设置。
• 强大搜索功能：支持更多参数和过滤条件的搜索。

📦 安装指南

依赖项

确保已安装以下依赖：

• 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 方法中添加新的工具。

最近更新

新增功能

1. 团队统计数据：增加了获取团队、成员、知识库和文档统计数据的功能。
2. 增强文档管理：
   • 支持多种文档格式（Markdown、HTML、Lake）。
   • 完善的文档公开性设置（私密、公开、企业内公开）。
3. 改进搜索功能：支持更多参数和过滤条件。

数据类型完善

更新了接口定义，使其与语雀 OpenAPI 规范保持一致。

📄 许可证

ISC