yuque

This Yuque MCP Server exposes your Yuque knowledge base to AI assistants via the Model Context Protocol. It acts as a bridge between Yuque and MCP-enabled clients, translating your Yuque content (books, docs, TOCs, versions, and more) into a standardized context that AI models can query. Tools included with the server let you fetch user information, search documents, list and manage repositories (books), read and modify documents, retrieve and update TOCs, and access group and stats data. Supported commands from clients are typically invoked through the standard MCP workflow, using the npx-based server launcher and providing a Yuque token through environment variables or CLI arguments. To get started, configure a token through YUQUE_PERSONAL_TOKEN or related variables, then connect your MCP client (CLAUDE, VS Code Copilot, Cursor, Windsurf, Cline, Trae, etc.).

Prerequisites:\n- Node.js 18 or later\n- npm (comes with Node.js)\n\nInstallation steps:\n1) Install dependencies for the MCP server project (from repository root):\nbash\nnpm install\n\n2) (Optional) Run tests to verify environment:\nbash\nnpm test\n\n3) Build the project (if needed):\nbash\nnpm run build\n\n4) Start the MCP server using the recommended npx command or your preferred MCP client configuration:\nbash\nnpx yuque-mcp install --token=YOUR_TOKEN --client=cursor\n\nAlternatively, configure manually in your MCP client with the following:bash\nnpx -y yuque-mcp\n and provide the token via environment variable (YUQUE_PERSONAL_TOKEN) or token flag as described in the README.\n

Tips and caveats:\n- Token priority: YUQUE_PERSONAL_TOKEN > YUQUE_GROUP_TOKEN > YUQUE_TOKEN > --token. Ensure the token has appropriate permissions for the operations you intend to perform.\n- If you encounter token-related errors, verify the token scope in Yuque and ensure it’s not expired.\n- When using GUI clients ( Claude Desktop, VS Code, Cursor, Windsurf, Cline, Trae ), you typically add a server with command npx and args [-y, yuque-mcp], plus env var YUQUE_PERSONAL_TOKEN=YOUR_TOKEN.\n- If the MCP server cannot be found by a client, update to the latest version using: npx -y yuque-mcp@latest.\n- The server supports a broad set of tools (25 total) including user lookups, docs management, books (repos), docs, TOC, versions, groups, stats, and utilities like yuque_hello.\n- For troubleshooting, consult the Troubleshooting table in the README for common errors like missing tokens, authentication failures, rate limits, and npx not found.\n