Yuque Mcp

io.github.yuquePublished by GitHub account yuquev0.1.4Updated Oct 24, 2026

MCP server for Yuque — expose your knowledge base to AI assistants.

VerifiedSTDIODesktop onlyProductivity & WorkflowKnowledge & Memory

Overview

AI-generated overview

Lets an AI assistant read and write a Yuque knowledge base: search, list, create and update books, docs, notes and boards.

What you can do
A local stdio MCP server that maps 19 tools onto Yuque API routes. It can fetch the authenticated user, search docs or repos, list and manage books (knowledge bases), read, create and update docs in markdown, lake or html, read and edit a book's table of contents, manage notes, and read or create boards such as mindmaps and flowcharts inside docs. Comments, attachments, permissions and member management are not covered.
When to use it
Useful when your notes, documentation or team knowledge live in Yuque and you want an assistant to search them, summarize them, or draft and file new docs and meeting notes without switching apps.
Requirements
Node.js v18 or later, since it runs locally via npx. A Yuque API token is required, supplied as YUQUE_TOKEN (or the legacy YUQUE_PERSONAL_TOKEN or YUQUE_GROUP_TOKEN) or the --token flag. For space-bound team tokens or private deployments, set YUQUE_HOST or --host. Network access to Yuque is needed.
Before you install
The token grants the server whatever that token can do, and the create and update tools change real content in your knowledge base. Keep the token secret and prefer a space-scoped team token with YUQUE_HOST when you only work in one space. Tokens can expire, and requests may be rate limited.

Installation

In SourceWeft

  1. Open Yuque Mcp in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

[Yuque logo]

Yuque MCP Server

Let AI assistants read and write your Yuque (语雀) knowledge base
through the Model Context Protocol.

[CI] [npm version] [npm downloads] [License]

Quick Start · Tools · Troubleshooting · Docs · 中文文档

Once connected, ask your assistant things like:

"Search my Yuque for everything about canary releases and give me a one-page summary."

"Turn today's meeting notes into a doc in my Tech Research book."

"Add a flowchart of this deployment pipeline to the design doc."

Quick Start

1. Get a token — create one at Yuque Developer Settings. If you use a team token bound to a Yuque space, also note the space host (e.g. https://your-space.yuque.com) — you will pass it as --host.

2. Install — one command locates the right config file for your OS and merges a yuque entry into it, without touching other servers:

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

Supported clients: claude-desktop · vscode · cursor · windsurf · cline · trae · qoder · opencode. Prefer an interactive flow? Run npx yuque-mcp setup.

Claude Code

Register the server directly:

bash
claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN
Other MCP clients (generic config)

Any client that supports stdio transport works — see docs/clients.md for per-client config paths.

json
{  "mcpServers": {    "yuque": {      "command": "npx",      "args": ["-y", "yuque-mcp"],      "env": { "YUQUE_TOKEN": "YOUR_TOKEN" }    }  }}

3. Restart your client and start asking.

Configuration

SettingEnv var / CLI flagDescription
Token (required)YUQUE_TOKEN / --tokenPersonal or team Yuque API token
Host (optional)YUQUE_HOST / --hostSite or space host, e.g. https://your-space.yuque.com — required for space-bound team tokens and private deployments

Site roots are normalized to /api/v2; when unset, the host defaults to https://www.yuque.com/api/v2.

bash
# Team token / private deploymentnpx yuque-mcp install --token=YOUR_TOKEN --client=cursor --host=https://your-space.yuque.com
Migrating from an older config?

YUQUE_PERSONAL_TOKEN, YUQUE_BASE_URL, and --base-url still work as legacy fallbacks. Precedence: YUQUE_TOKEN > YUQUE_PERSONAL_TOKEN > --token, and YUQUE_HOST > --host > YUQUE_BASE_URL > --base-url. New configs should use YUQUE_TOKEN and YUQUE_HOST.

Tools (19)

Each tool maps to exactly one Yuque API route.

CategoryToolDescription
Useryuque_get_userGet the authenticated user for the current token
Searchyuque_searchSearch docs or repos, with paging
Booksyuque_list_booksList books (知识库) of a user
yuque_get_bookGet a book by ID or namespace
yuque_create_bookCreate a book
yuque_update_bookUpdate name, slug, description, or visibility
Docsyuque_list_docsList docs in a book, with paging
yuque_get_docGet full content — markdown, lake, or html
yuque_create_docCreate a doc in a book
yuque_update_docUpdate a doc's body or metadata
TOCyuque_get_tocGet a book's table of contents
yuque_update_tocAppend or move a single TOC node
Notesyuque_list_notesList notes (小记), with paging and status filter
yuque_get_noteGet a note with full content
yuque_create_noteCreate a note
yuque_update_noteUpdate a note
Boardsyuque_get_resourceRead a board (mindmap / flowchart / diagram) from a doc
yuque_create_resourceCreate a board in a doc
yuque_update_resourceUpdate a board in a doc

In particular, yuque_update_doc cannot combine a markdown body with title / slug / public changes in a single call — update metadata separately. The full contract, including format routing between the YMD markdown API and the legacy document API, is documented in docs/capability-scope.md.

Not covered (yet): comments, attachment upload and file management, permission and member management, section-level doc edits, and structured resources other than boards.

Write access

The create/update tools modify real content in your knowledge base, and the server can do whatever your token can do. Keep the token secret, and prefer a space-scoped team token (with YUQUE_HOST) when you only work within one space. To report a vulnerability, see SECURITY.md.

Troubleshooting

ErrorSolution
YUQUE_TOKEN ... is requiredSet YUQUE_TOKEN=YOUR_TOKEN or pass --token=YOUR_TOKEN
401 UnauthorizedToken invalid or expired — regenerate it
429 Rate LimitedToo many requests — wait a moment and retry
410 GoneTarget permanently deleted or endpoint deprecated — check the doc/book exists
Tool not foundUpdate to the latest version: npx -y yuque-mcp@latest
npx command not foundInstall Node.js v18 or later

Development

bash
git clone https://github.com/yuque/yuque-mcp-server.gitcd yuque-mcp-servernpm installnpm test              # run testsnpm run build         # compile TypeScriptnpm run dev           # dev mode with hot reload

Architecture, tech stack, and the full tool contract live in docs/. Contributions are welcome — see CONTRIBUTING.md.

Links

License

MIT

Source: README.md at commit 757a408

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.1.4LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts