Skip to content
Back to search

yuque-mcp-server

Yuque MCP Server - Model Context Protocol server for Yuque API

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/yuque--yuque-mcp-server/badge.svg)](/listings/yuque--yuque-mcp-server)

HTML

<a href="/listings/yuque--yuque-mcp-server"><img src="/api/listings/yuque--yuque-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**1. Get a token** — create one at [Yuque Developer Settings](https://www.yuque.com/settings/tokens). 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:

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`.

<details> <summary><b>Claude Code</b></summary>

Register the server directly:

claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN

</details>

<details> <summary><b>Other MCP clients (generic config)</b></summary>

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

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

</details>

**3. Restart your client** and start asking.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 163 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. <a href="https://www.yuque.com/"><img src="https://avatars.githubusercontent.com/u/34602419?s=200&v=4" width="96" alt="Yuque logo"></a>
  3. <h1>Yuque MCP Server</h1>
  4. Let AI assistants read and write your [Yuque (语雀)](https://www.yuque.com/) knowledge base<br>through the [Model Context Protocol](https://modelcontextprotocol.io/).
  5. [![CI][ci-image]][ci-url] [![npm version][npm-image]][npm-url] [![npm downloads][download-image]][download-url] [![License][license-image]][license-url]
  6. [Quick Start](#quick-start) · [Tools](#tools-19) · [Troubleshooting](#troubleshooting) · [Docs](./docs/README.md) · [中文文档](./README.zh-CN.md)
  7. </div>
  8. Once connected, ask your assistant things like:
  9. > "Search my Yuque for everything about canary releases and give me a one-page summary."
  10. >
  11. > "Turn today's meeting notes into a doc in my _Tech Research_ book."
  12. >
  13. > "Add a flowchart of this deployment pipeline to the design doc."
  14. ## Quick Start
  15. **1. Get a token** — create one at [Yuque Developer Settings](https://www.yuque.com/settings/tokens). 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`.
  16. **2. Install** — one command locates the right config file for your OS and merges a `yuque` entry into it, without touching other servers:
  17. ```bash
  18. npx yuque-mcp install --token=YOUR_TOKEN --client=cursor
  19. ```
  20. Supported clients: `claude-desktop` · `vscode` · `cursor` · `windsurf` · `cline` · `trae` · `qoder` · `opencode`. Prefer an interactive flow? Run `npx yuque-mcp setup`.
  21. <details>
  22. <summary><b>Claude Code</b></summary>
  23. Register the server directly:
  24. ```bash
  25. claude mcp add yuque -- npx -y yuque-mcp --token=YOUR_TOKEN
  26. ```
  27. </details>
  28. <details>
  29. <summary><b>Other MCP clients (generic config)</b></summary>
  30. Any client that supports stdio transport works — see [docs/clients.md](./docs/clients.md) for per-client config paths.
  31. ```json
  32. {
  33. "mcpServers": {
  34. "yuque": {
  35. "command": "npx",
  36. "args": ["-y", "yuque-mcp"],
  37. "env": { "YUQUE_TOKEN": "YOUR_TOKEN" }
  38. }
  39. }
  40. }
  41. ```
  42. </details>
  43. **3. Restart your client** and start asking.
  44. ## Configuration
  45. | Setting | Env var / CLI flag | Description |
  46. | -------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------- |
  47. | Token **(required)** | `YUQUE_TOKEN` / `--token` | Personal or team Yuque API token |
  48. | Host (optional) | `YUQUE_HOST` / `--host` | Site or space host, e.g. `https://your-space.yuque.com` — required for space-bound team tokens and private deployments |
  49. Site roots are normalized to `/api/v2`; when unset, the host defaults to `https://www.yuque.com/api/v2`.
  50. ```bash
  51. # Team token / private deployment
  52. npx yuque-mcp install --token=YOUR_TOKEN --client=cursor --host=https://your-space.yuque.com
  53. ```
  54. <details>
  55. <summary>Migrating from an older config?</summary>
  56. `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`.
  57. </details>
  58. ## Tools (19)
  59. Each tool maps to exactly one Yuque API route.
  60. | Category | Tool | Description |
  61. | ----------- | ----------------------- | -------------------------------------------------------- |
  62. | **User** | `yuque_get_user` | Get the authenticated user for the current token |
  63. | **Search** | `yuque_search` | Search docs or repos, with paging |
  64. | **Books** | `yuque_list_books` | List books (知识库) of a user |
  65. | | `yuque_get_book` | Get a book by ID or namespace |
  66. | | `yuque_create_book` | Create a book |
  67. | | `yuque_update_book` | Update name, slug, description, or visibility |
  68. | **Docs** | `yuque_list_docs` | List docs in a book, with paging |
  69. | | `yuque_get_doc` | Get full content — markdown, `lake`, or `html` |
  70. | | `yuque_create_doc` | Create a doc in a book |
  71. | | `yuque_update_doc` | Update a doc's body or metadata |
  72. | **TOC** | `yuque_get_toc` | Get a book's table of contents |
  73. | | `yuque_update_toc` | Append or move a single TOC node |
  74. | **Notes** | `yuque_list_notes` | List notes (小记), with paging and status filter |
  75. | | `yuque_get_note` | Get a note with full content |
  76. | | `yuque_create_note` | Create a note |
  77. | | `yuque_update_note` | Update a note |
  78. | **Boards** | `yuque_get_resource` | Read a board (mindmap / flowchart / diagram) from a doc |
  79. | | `yuque_create_resource` | Create a board in a doc |
  80. | | `yuque_update_resource` | Update a board in a doc |
  81. 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](./docs/capability-scope.md).
  82. **Not covered (yet):** comments, attachment upload and file management, permission and member management, section-level doc edits, and structured resources other than boards.
  83. ## Write access
  84. 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](./SECURITY.md).
  85. ## Troubleshooting
  86. | Error | Solution |
  87. | ----------------------------- | ----------------------------------------------------------------------------- |
  88. | `YUQUE_TOKEN ... is required` | Set `YUQUE_TOKEN=YOUR_TOKEN` or pass `--token=YOUR_TOKEN` |
  89. | `401 Unauthorized` | Token invalid or expired — [regenerate it](https://www.yuque.com/settings/tokens) |
  90. | `429 Rate Limited` | Too many requests — wait a moment and retry |
  91. | `410 Gone` | Target permanently deleted or endpoint deprecated — check the doc/book exists |
  92. | Tool not found | Update to the latest version: `npx -y yuque-mcp@latest` |
  93. | `npx` command not found | Install [Node.js](https://nodejs.org/) v18 or later |
  94. ## Development
  95. ```bash
  96. git clone https://github.com/yuque/yuque-mcp-server.git
  97. cd yuque-mcp-server
  98. npm install
  99. npm test # run tests
  100. npm run build # compile TypeScript
  101. npm run dev # dev mode with hot reload
  102. ```
  103. Architecture, tech stack, and the full tool contract live in [docs/](./docs/README.md). Contributions are welcome — see [CONTRIBUTING.md](./CONTRIBUTING.md).
  104. ## Links
  105. - [Yuque API docs](https://www.yuque.com/yuque/developer/api)
  106. - [Model Context Protocol](https://modelcontextprotocol.io/)
  107. - [Yuque AI Ecosystem](https://yuque.github.io/yuque-ecosystem/) — skills and plugins built on top of this server
  108. ## License
  109. [MIT](./LICENSE)
  110. [ci-image]: https://img.shields.io/github/actions/workflow/status/yuque/yuque-mcp-server/ci.yml?style=flat-square&label=CI
  111. [ci-url]: https://github.com/yuque/yuque-mcp-server/actions/workflows/ci.yml
  112. [npm-image]: https://img.shields.io/npm/v/yuque-mcp?style=flat-square
  113. [npm-url]: https://www.npmjs.com/package/yuque-mcp
  114. [download-image]: https://img.shields.io/npm/dm/yuque-mcp?style=flat-square
  115. [download-url]: https://www.npmjs.com/package/yuque-mcp
  116. [license-image]: https://img.shields.io/github/license/yuque/yuque-mcp-server?style=flat-square
  117. [license-url]: ./LICENSE

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.