Log inSubmit server
Yuque MCP logo

Yuque MCP

yuque-mcp MCP server lets AI assistants search, read, create, and update Yuque knowledge-base content.

InstallRepositoryWebsite
Full README Compare alternatives Embed widget Claim this listing

Install Yuque MCP

Pick your client, then add it in one click or paste the config.

STDIONode.js
~/Library/Application Support/Claude/claude_desktop_config.json
claude_desktop_config.json
{
  "mcpServers": {
    "yuque-mcp-2": {
      "command": "npx",
      "args": [
        "-y",
        "yuque-mcp"
      ],
      "env": {
        "YUQUE_TOKEN": "YOUR_VALUE_HERE"
      }
    }
  }
}

Settings → Developer → Edit Config, merge this into mcpServers, then fully quit and reopen Claude Desktop.

Values are written into the snippet above so you can paste it as is. They never leave your browser.

We couldn’t confirm it starts correctly

We ran the install command but it didn't respond within our test window — this can mean a slow first-time install rather than a real problem.

npx -y yuque-mcp

No response to initialize.

This is an experimental automated check and can have false negatives — missing environment variables, a slow cold install, etc. It doesn’t necessarily mean something’s wrong. Last checked Today.

Overview

The yuque-mcp MCP server connects AI assistants to Yuque knowledge bases through the Model Context Protocol. It exposes tools for searching and managing books, documents, notes, tables of contents, and boards, with both read and write operations. Reach for it when an assistant needs to retrieve Yuque content, create or revise knowledge-base material, or work with diagrams using a Yuque API token.

Use cases

  • Search Yuque documents for a topic and summarize the results
  • Create meeting-note documents in a selected Yuque book
  • Update document content or metadata through an assistant
  • Manage books, notes, and table-of-contents entries
  • Read or create flowcharts and other board resources

Key features

  • Search documents and repositories with paging
  • Read and write Yuque books, documents, and notes
  • Retrieve document content as markdown, lake, or HTML
  • Read and update book table-of-contents nodes
  • Create and update board resources in documents
  • Support personal and team Yuque API tokens

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked 1d ago

Recent health check succeeded.

8/8 checks healthy over the last 39d

Supply-chain signal

No high-severity advisories surfaced by our automated scan.

Critical 0High 0Medium 0Low 0

Scanned 8d ago via OSV.dev · yuque-mcp (npm)

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

GitHub stars257Stargazers on the source repository.
npm downloads1.3kPackage downloads in the last 30 days.
Last commit3mo agoMost recent push to the default branch.
Install checkInconclusiveDidn't respond in our test window — often a slow first install.
Directory activity1 viewsConfig copies, upvotes, and views on AllMCPs.

How Yuque MCP works

What yuque-mcp MCP server does

The yuque-mcp MCP server gives MCP-compatible assistants access to a Yuque knowledge base. It supports authenticated user lookup, search across documents or repositories, and management of books, documents, notes, table-of-contents entries, and boards such as mindmaps, flowcharts, and diagrams.

Read and write operations are both available. An assistant can list or retrieve existing content, create new books and documents, update document bodies or metadata, and create or revise notes and board resources. Changes are made with the permissions granted to the configured Yuque token, so write-enabled credentials should be handled carefully.

The server does not currently cover comments, attachments and file management, permissions or members, section-level document edits, or structured resources other than boards.

How it works

The server uses the Model Context Protocol over standard input/output and maps each exposed tool to one Yuque API route. Clients start it with npx, then provide a personal or team API token. The default API host is https://www.yuque.com/api/v2; a different site or space host can be supplied for space-bound team tokens and private deployments.

Its 19 tools are grouped by resource. Search and listing operations support paging where documented, while document retrieval can return markdown, lake, or HTML content. Table-of-contents updates can append or move one node at a time. For documents, body changes and metadata changes such as title, slug, or visibility cannot be combined in one yuque_update_doc call.

Setup and configuration

Create a token in Yuque Developer Settings, then install the server into a supported client configuration:

Terminal
npx yuque-mcp install --token=YOUR_TOKEN --client=cursor

The interactive alternative is npx yuque-mcp setup. Claude Code can register it directly with claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN. Other stdio-capable clients can use a configuration that launches npx -y yuque-mcp and sets YUQUE_TOKEN.

YUQUE_TOKEN is required and accepts a personal or team token. YUQUE_HOST is optional, but is needed when using a space-bound team token or private deployment; it can point to a site or space host such as https://your-space.yuque.com. The command-line equivalents are --token and --host. After configuration, restart the MCP client.

Tools and capabilities

The yuque-mcp MCP server exposes these capabilities:

  • Identify the authenticated Yuque user and search documents or repositories.
  • List, retrieve, create, and update books.
  • List documents in a book and read, create, or update documents.
  • Read and modify a book’s table of contents.
  • List, retrieve, create, and update notes, including status filtering when listing.
  • Read, create, and update board resources within documents.

Limitations and notes

The token determines what the server can access and modify. A space-scoped team token with YUQUE_HOST is an option when work should remain within one space. Keep tokens secret.

A missing token prevents startup. Invalid or expired tokens produce a 401 response, excessive requests can produce a 429 response, and deleted or deprecated targets can produce a 410 response. If npx is unavailable, install Node.js 18 or later. Updating to the latest package version may resolve missing-tool issues.

Read the full README View source on GitHub

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about Yuque MCP

yuque-mcp is an MCP server that connects AI assistants to Yuque knowledge bases through the Model Context Protocol. Its main tools search and manage books, documents, notes, tables of contents, and board resources, including operations to read, create, and update supported Yuque content with an API token.

Install it with `npx yuque-mcp install --token=YOUR_TOKEN --client=cursor`, replacing the client as needed. You can also run `npx yuque-mcp setup` for an interactive setup, or register the stdio command manually in an MCP client configuration.

Yes, yuque-mcp supports Cursor configuration through the install command. Run `npx yuque-mcp install --token=YOUR_TOKEN --client=cursor`, then restart Cursor after the configuration is written.

yuque-mcp requires `YUQUE_TOKEN`, which must contain a personal or team Yuque API token. `YUQUE_HOST` is optional and is used for space-bound team tokens or private deployments.

yuque-mcp can update books, document bodies or metadata, notes, table-of-contents nodes, and board resources. Document body changes cannot be combined with title, slug, or visibility changes in the same update call.

Related MCP servers

All in Knowledge & Memory All alternatives
Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG PreviewYuque MCP AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/yuque-mcp-2?style=directory)](https://allmcps.com/mcp/yuque-mcp-2)
HTML Embed
<a href="https://allmcps.com/mcp/yuque-mcp-2"><img src="https://allmcps.com/api/badge/yuque-mcp-2?style=directory" alt="Yuque MCP on AllMCPs" /></a>