Yuque MCP Server

MCP server for Yuque (语雀) — expose Yuque knowledge base to AI assistants via Model Context Protocol

Local serverstdioTypeScript

What is the Yuque MCP server?

Yuque MCP server exists for a simple reason — assistants are far more useful when they can act on Yuque directly instead of describing what you should do. MCP server for Yuque (语雀) — expose Yuque knowledge base to AI assistants via Model Context Protocol.

What you get

[CI][ci-image]][ci-url] [npm version][npm-image]][npm-url] [npm downloads][download-image]][download-url] [License][license-image]][license-url]

What the assistant can call

Once Yuque is connected, these are the calls the assistant has available:

  • Category — Tool
  • User — yuque_get_user
  • Search — yuque_search
  • Books — yuque_list_books
  • Docs — yuque_list_docs
  • TOC — yuque_get_toc
  • Notes — yuque_list_notes
  • Boards — yuque_get_resource

Configuration and credentials

You will need 5 environment variables: YUQUE_TOKEN, YOUR_TOKEN, YUQUE_HOST, YUQUE_PERSONAL_TOKEN, YUQUE_BASE_URL. The server will not start without them, which is usually why the tools fail to appear on a first run. Keep credentials in your client's env block or a secrets manager rather than in a file you might commit.

Setting it up

Installation goes through your MCP client rather than a global install: point it at yuque-mcp on npm and it is fetched when the client starts. The copy-paste blocks for Claude Desktop, Claude Code and Cursor are further down this page.

Choosing this one

Among the developer tooling options, the useful question is rarely "what can it do" but "what does it cost you to run" — permissions, credentials, and how much of your context its toolset consumes. Yuque's toolset — Category, User, Search and 5 more — is a fair guide to whether it matches your workflow. It is maintained by GitHub Actions; worth a glance at recent repository activity before you build anything load-bearing on it.

SyncDev reviews every entry in this directory against the project's own documentation before publishing, and revisits them as servers change.

Before you rely on it

  • It runs with your machine's permissions. That is convenient and also the reason to think about what you point it at before you approve a tool call.
  • Missing credentials fail quietly in some clients — if no tools show up, check the environment block first.
  • MCP clients confirm each tool call by default. Leave that on until you have watched what the yuque mcp server does with a few real requests.

Available tools

ToolWhat it does
CategoryTool
Useryuque_get_user
Searchyuque_search
Booksyuque_list_books
Docsyuque_list_docs
TOCyuque_get_toc
Notesyuque_list_notes
Boardsyuque_get_resource

How to install the Yuque MCP server

{
  "mcpServers": {
    "yuque": {
      "command": "npx",
      "args": ["-y", "yuque-mcp"],
      "env": {
        "YUQUE_TOKEN": "your-value",
        "YOUR_TOKEN": "your-value",
        "YUQUE_HOST": "your-value",
        "YUQUE_PERSONAL_TOKEN": "your-value",
        "YUQUE_BASE_URL": "your-value"
      }
    }
  }
}

Add to claude_desktop_config.json, then restart Claude Desktop.

Configuration

VariableDescriptionRequired
YUQUE_TOKENCredential the server authenticates with.Yes
YOUR_TOKENCredential the server authenticates with.Yes
YUQUE_HOSTEndpoint or connection string the server talks to.Optional
YUQUE_PERSONAL_TOKENCredential the server authenticates with.Yes
YUQUE_BASE_URLEndpoint or connection string the server talks to.Yes

Example prompts to try

  • Use Yuque to Category.
  • Use Yuque to User.
  • Use Yuque to Search.

Frequently asked questions

It connects Yuque to MCP-compatible AI assistants such as Claude and Cursor, exposing 8 tools (Category, User, Search, and more) that the assistant can call on your behalf. Instead of copying data back and forth by hand, the assistant works with Yuque directly.