yuque

This MCP server provides programmatic access to Yuque (语雀) content through the Model Context Protocol (MCP). It exposes tools to manage knowledge repositories, documents, and search operations, enabling AI assistants to list repos, create and update documents, and perform searches within Yuque. The server supports common document formats such as Markdown, Lake, and HTML, and includes operations for creating, reading, updating, deleting, and searching documents across repositories. When used with Claude Code, you can automatically configure Claude Code to connect to the Yuque MCP server and securely supply the required access token.

To use the server, first install it globally (or run locally) and ensure you have a Yuque API token. Set the YUQUE_TOKEN environment variable with your token. Then start the MCP service via npx (or your preferred installation method). Once running, you can invoke tools like yuque_get_user, yuque_get_repos, yuque_get_docs, yuque_get_doc, yuque_create_doc, yuque_update_doc, yuque_delete_doc, and yuque_search_docs to manage content and perform searches. The Claude Code integration guide also provides a quick setup to wire these tools into Claude Code, enabling seamless access to Yuque data from your AI workflows.

Prerequisites:

• Node.js and npm installed on your machine
• A Yuque API token (from Account Settings > Developer Settings > API Token)

Installation options:

1. Global installation (recommended for CLI usage)

   • npm install -g yuque-mcp-server
   • This allows you to run the MCP server via a simple command in your shell

2. Local installation (per-project)

   • npm install yuque-mcp-server
   • Use the local binary in your project scripts or CLI workflows

3. From source

   • git clone https://github.com/tanis2010/yuque-mcp-server.git
   • cd yuque-mcp-server
   • npm install
   • npm run build
   • npm link

Environment setup (required):

• Create a Yuque API token as described in the README
• Set the environment variable with your token:

export YUQUE_TOKEN="your_yuque_api_token_here"

Starting the server (example using npx):

• npx -y yuque-mcp-server

If you installed locally or are running from source, you can start the server via Node.js entry (example):

• node path/to/yuque-mcp-server/dist/server.js

After starting, Claude Code users can configure Claude Code to connect to the MCP server using the environment variable YUQUE_TOKEN for authentication.

Notes and tips:

• Ensure your Yuque API token has the necessary permissions to read and write repositories and documents.
• If you encounter authentication issues, double-check that YUQUE_TOKEN is exported in the environment where your MCP server runs.
• The MCP server exposes a set of tools for common tasks: getting user info, listing repos, listing docs, retrieving a doc, creating/updating/deleting docs, and searching docs.
• When integrating with Claude Code, you can use the automatic configuration flow to securely inject environment variables and set the correct command and arguments.
• For local development, the recommended local development setup points to a built server.js path in dist, and you should ensure the build step completes successfully before starting the server.