GitHub Actions 工作流使用说明

What is Yuque MCP Server?

A Model-Context-Protocol (MCP) server that integrates with the Yuque knowledge base platform via its open API. It enables AI models to interact with Yuque data—such as user info, documents, knowledge bases, and team statistics—through a set of registered MCP tools.

How to use Yuque MCP Server?

Install via Smithery (npx @smithery/cli install @HenryHaoson/Yuque-MCP-Server) or clone the repository, run npm install, create a .env file with your YUQUE_API_TOKEN, and start the server in HTTP mode (npm run start) or CLI stdio mode (npm run start:cli). Docker deployment is also supported via docker-compose up -d or manual Docker commands.

Key features of Yuque MCP Server

• Retrieve current user, documents, and knowledge base info
• Create, read, update, and delete documents in Yuque
• Search content across documents and knowledge bases
• Access team, member, book, and document statistics
• Support multiple document formats (Markdown, HTML, Lake)

Use cases of Yuque MCP Server

• An AI assistant managing a team’s documentation in Yuque
• Automated content creation and synchronization with Yuque knowledge bases
• Analyzing team knowledge base usage and reading statistics
• Searching and retrieving specific documents from Yuque by an AI agent

FAQ from Yuque MCP Server

What are the prerequisites to run this server?

Node.js 18+ and a Yuque account with an API token are required.

How do I provide my Yuque API token?

You can set YUQUE_API_TOKEN in a .env file or pass it as the accessToken query parameter when connecting to the SSE endpoint.

What transport modes are supported?

The server supports both HTTP (SSE endpoint) and CLI stdio modes, with Docker deployment available for both.

Can the same server instance serve multiple users with different tokens?

Yes, each SSE connection can accept different accessToken and baseUrl query parameters, allowing multiple configurations on a single server instance.

What is the default Yuque API base URL?

The default base URL is https://www.yuque.com/api/v2, which can be overridden via the YUQUE_API_BASE_URL environment variable or the baseUrl query parameter.