Yuque

This MCP server provides a set of tools to interact with the Yuque knowledge base platform via the Model-Context-Protocol (MCP). It exposes utilities for user and document management, as well as team statistics analysis. Models connected to this server can fetch the current user, list and retrieve documents, create or modify documents in a specified repository, search content across Yuque, and obtain statistics about groups, members, repositories, and documents. The tools are designed to be called by the MCP client in a standardized way, enabling AI agents to perform tasks like drafting a new document, updating existing content, or analyzing knowledge bases without direct Yuque API handling in the agent code.

Prerequisites:

• Node.js 18+ (recommended)
• Access token for Yuque API

1. Install Node dependencies locally

npm install

2. Create a configuration file or environment variables

• Copy the example environment file and populate tokens and base URL:

cp .env.example .env

Edit .env to include:

YUQUE_API_TOKEN=your_yuque_api_token_here
YUQUE_API_BASE_URL=https://www.yuque.com/api/v2

3. Run in development mode

npm run dev

or run the MCP server directly (if built):

node dist/index.js

4. (Optional) Build for production

npm run build

5. Alternatively, deploy with Docker (if preferred):

docker build -t yuque-mcp-server .

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

Notes:

• The server supports environment-variable configuration (PORT, YUQUE_API_TOKEN, YUQUE_API_BASE_URL). When using SSE endpoints, you can override these values via query parameters per-connection (e.g., ?accessToken=...&baseUrl=...).
• Ensure your Yuque API token has appropriate permissions for the operations you intend to perform (read/write, etc.).
• If you deploy behind a reverse proxy or in Docker, open port 3000 (or your chosen port) and ensure the base URL matches your deployment.
• The MCP tools cover user/docs management, doc creation/update/deletion, search, and group statistics (get_group_statistics, get_group_member_statistics, get_group_book_statistics, get_group_doc_statistics).
• When adding new tools or modifying existing ones, edit the server's tool registration (src/server.ts) to reflect changes.