Henryhaoson Yuque MCP Server

🚀 語雀 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