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 分