Yuque Mcp

io.github.yuque由 GitHub 账号 yuque 发布v0.1.4更新于 Oct 24, 2026

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

已验证STDIO仅桌面效率与工作流知识与记忆

概览

AI 生成的概览

让 AI 助手读写语雀知识库：搜索、列出、创建和更新知识库、文档、小记与画板。

可以做什么
这是一个本地 stdio MCP 服务器，把 19 个工具对应到语雀 API 接口。它可以获取当前令牌对应的用户、搜索文档或仓库、列出和管理知识库、以 markdown、lake 或 html 读取并创建、更新文档、读取和调整知识库目录、管理小记，以及在文档中读取或创建思维导图、流程图等画板。评论、附件上传、权限与成员管理暂未覆盖。
适用场景
当你的笔记、文档或团队知识存放在语雀，并希望助手直接搜索、总结，或起草并归档新文档和会议记录而无需切换应用时，适合使用。
运行要求
需要 Node.js v18 或更高版本，因为它通过 npx 在本地运行。必须提供语雀 API 令牌，可通过 YUQUE_TOKEN（或旧版 YUQUE_PERSONAL_TOKEN、YUQUE_GROUP_TOKEN）或 --token 参数传入。若使用绑定空间的团队令牌或私有部署，需设置 YUQUE_HOST 或 --host。需要能访问语雀的网络。
安装前请注意
令牌会让服务器拥有该令牌的全部权限，创建和更新类工具会真实修改知识库内容。请妥善保管令牌；若只在一个空间内工作，建议使用绑定空间的团队令牌并配合 YUQUE_HOST。令牌可能过期，请求也可能被限流。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Yuque Mcp，将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only，通过 STDIO。 STDIO 服务会启动本地进程，因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

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

来源：README.md，提交 757a408

工具

0
SourceWeft 尚未在沙箱中启动过该软件包，因此其工具未知。

版本历史

1
  1. v0.1.4最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度，依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价，也不表示服务器安全或当前可用：可连通性是带日期的检查结果，评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手；SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头，或保持端点能够响应探测，以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list，或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分