Yuque MCP Server

What HenryHaoson/Yuque-MCP-Server MCP server does

HenryHaoson/Yuque-MCP-Server MCP server connects an MCP-compatible AI client to the Yuque Open API. It provides tools for retrieving account and knowledge-base information, browsing documents, changing document content, searching Yuque, and reading team analytics.

The project is intended for workflows where an AI model needs to inspect or maintain Yuque content through defined MCP tools rather than through browser automation. Document operations cover creation, retrieval, modification, and deletion. New documents can use Markdown, HTML, or Lake content formats, and document updates can include title, content, and visibility settings.

How it works

The server acts as an MCP layer over Yuque API requests. A client connects to either the HTTP/SSE server or the CLI stdio process, then invokes the registered tools. The server authenticates requests with a Yuque API token and uses a configurable API base URL.

For SSE connections, accessToken and baseUrl query parameters can override the corresponding environment configuration. These connection-level values take precedence over the environment, allowing separate SSE connections to use different Yuque credentials or API endpoints.

Setup and configuration

HenryHaoson/Yuque-MCP-Server MCP server requires Node.js 18 or later, with Node.js 18 recommended by the project. The repository setup flow consists of cloning the source, installing npm dependencies, creating a .env file from .env.example, and setting YUQUE_API_TOKEN when using environment-based authentication.

The documented configuration variables are:

• YUQUE_API_TOKEN: Yuque API token used for authentication.
• YUQUE_API_BASE_URL: Yuque API base URL; the documented default is https://www.yuque.com/api/v2.
• PORT: HTTP server port, with 3000 shown in the Docker examples.

Development commands provide HTTP and CLI modes through npm run dev and npm run dev:cli. For production, the project is built with npm run build, then started with npm run start or npm run start:cli. Docker and Docker Compose deployment are also documented.

Tools and capabilities

Available tools include:

• get_current_user for the authenticated Yuque account.
• get_user_docs, get_user_repos, and get_repo_docs for listing user documents, knowledge bases, and repository documents.
• get_doc for retrieving document content, revision history, and permission information.
• create_doc, update_doc, and delete_doc for document lifecycle operations.
• search for finding documents or knowledge-base content with scope and author filters.
• get_group_statistics, get_group_member_statistics, get_group_book_statistics, and get_group_doc_statistics for team, member, knowledge-base, and document usage data.

Limitations and notes

The project requires a Yuque account with an API token. Deleting a document is described as irreversible. The material confirms compatibility with MCP clients in general and gives an automated installation path for Claude Desktop through Smithery, but it does not provide client-specific configuration for Cursor, Windsurf, or Cline.

The repository README documents the server's own npm scripts and Docker deployment, but does not identify a published npm package that can be installed as a standalone executable. Query-string credentials for SSE connections should be handled carefully because they are included in the connection URL.