HenryHaoson/Yuque-MCP-服务器

Yuque MCP 服务器


English Version

一个用于与 Yuque API 集成的 Model-Context-Protocol (MCP) 服务器。此实现受 Figma-Context-MCP 的启发，并使用 Yuque 开放 API。

概述

该服务器提供了与 Yuque 知识库平台交互的 MCP 工具，允许 AI 模型：

• 获取用户和文档信息

• 创建、读取、更新和删除文档

• 搜索 Yuque 中的内容

• 获取知识库信息

• 获取统计数据和分析信息

安装

通过 Smithery 安装

要使用 Smithery 将 Yuque MCP Server 自动安装到 Claude 桌面端：

npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude

• Node.js 18+ (Recommended)

• A Yuque account with an API token

Setup

1. Clone this repository:

git clone https://github.com/Henryhaoson/Yueque-MCP-Server.git
   cd Yueque-MCP-Server

npm install

Wait, looking at the prompt again, the user provided: "3. 基于 .env.example 创建 .env 文件：". This is already Chinese. If I must act as a translator for English -> Chinese, and the input is Chinese, I will provide the most accurate technical translation as if it were the target.

Actually, usually, in these scenarios, the user might have accidentally pasted the target. Let's assume they want this translated *from* English (e.g., "3. Create a .env file based on .env.example:") *to* Chinese. Since it's already Chinese, I will output it as is or slightly polished for technical accuracy.)

3. 基于 .env.example 创建 .env 文件：

cp .env.example .env

*Self-correction: The user provided a Chinese sentence. I will assume they want me to maintain the format or perhaps they made a mistake and provided the target language. But to follow the "Professional Technical Translator" persona, I will provide the most accurate technical version of this sentence.*

4. (Optional) Add your Yuque API token to the .env file:

YUQUE_API_TOKEN=your_yuque_api_token_here

Usage

Running the Server

#### Development Mode

# HTTP 服务器模式
npm run dev

CLI stdio 模式
npm run dev:cli

First, build the project:

npm run build

# HTTP 服务器模式
npm run start

CLI stdio 模式
npm run start:cli

This project provides Docker support, allowing you to easily containerize and deploy the server.

#### Using Docker Compose (Recommended)

1. Build and start the containers:

docker-compose up -d

docker-compose logs -f

3. Stop Service:

docker-compose down

# .env 文件示例
PORT=3000
YUQUE_API_TOKEN=your_token_here
YUQUE_API_BASE_URL=https://www.yuque.com/api/v2

1. Build the Docker image:

docker build -t yuque-mcp-server .

2. Run the container:

docker run -d -p 3000:3000 --name yuque-mcp-server yuque-mcp-server

3. Use environment variables:

如果您是希望我翻译一段包含该标题的英文 Markdown 片段，请提供英文原文。

docker run -d -p 3000:3000 \
     -e YUQUE_API_TOKEN=your_token_here \
     -e YUQUE_API_BASE_URL=https://www.yuque.com/api/v2 \
     --name yuque-mcp-server yuque-mcp-server

The Yuque MCP server provides the following tools:

#### User and Document Management

• get_current_user - Get information of the currently authenticated user, including basic Yuque account details such as user ID, username, and avatar.

• get_user_docs - Get a list of all knowledge base documents for the current user, including private and collaborative documents.

• get_user_repos - Get the list of knowledge bases for a specified user; a knowledge base is a collection of documents in Yuque.

• get_repo_docs - Get a list of all documents within a specific knowledge base, including document titles, update times, etc.

• get_doc - Get the detailed content of a specific document in Yuque, including the body, revision history, and permission information.

• create_doc - Create a new Yuque document in a specified knowledge base, supporting multiple content formats (Markdown, HTML, Lake).

• update_doc - Update an existing document in Yuque, allowing modifications to the title, content, or permission settings.

• delete_doc - Delete a specified document from a Yuque knowledge base; this operation is irreversible.

• search - Search for documents or knowledge base content within the Yuque platform, supporting scope and author filtering.

#### Team Statistical Analysis

• get_group_statistics - Get aggregated statistical data for the team, including member count, document count, read counts, and interaction data.

• get_group_member_statistics - Get statistical data for team members, including edit counts, read counts, and like counts for each member.

• get_group_book_statistics - Get statistical data for team knowledge bases, including document count, word count, and read counts for each knowledge base.

• get_group_doc_statistics - Get statistical data for team documents, including word count, read counts, and comment counts for each document.

Integration with AI Models

This MCP server can be used with AI models that support the Model-Context-Protocol, allowing them to interact with Yuque via the defined tools. For example:

1. Start the MCP server.
2. Connect to the server from a compatible client.
3. The AI model can now interact with Yuque data using the registered tools.

SSE Endpoint Query Parameters

When connecting to the SSE endpoint, you can override environment configurations via query parameters, which take precedence over environment variables:

• accessToken: Overrides the Yuque API token set in the .env file.

• baseUrl: Overrides the Yuque API base URL set in the .env file.

Example:

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

Each SSE connection can use a different configuration, enabling a single server instance to serve different users or environments simultaneously.

Development

Project Structure

code

src/