yehuoshun/yuque-ai-mcp

65 MCP tools (45 OpenAPI + 20 web-API)
中文文档
---
A full-featured Yuque (语雀) MCP Server built on the Model Context Protocol. Provides 65 fine-grained tools across 13 domains — 45 Yuque OpenAPI endpoints plus 20 web-API tools requiring a browser session cookie.
Why
- **19 → 65 tools** — 3x more coverage than the official yuque-mcp-server
- **Dual transport** — stdio + HTTP SSE, shared registry, zero downtime on reload
- **Modular architecture** — 13 domains, barrel exports, single source of truth registry
- **Full API coverage** — group, recycle, upload, statistics, versions, boards — all the missing pieces
- **Skill layer** — 67 usage guides for AI agents
Table of Contents
- Quick Start
- Tool Overview
- Architecture
- Configuration
- Error Handling
- Contributing
- License
Quick Start
> **Note**: npm run dev:http uses tsx for hot-reload during development.
Tool Overview
| Domain | Tools | Highlights |
|--------|-------|------------|
| **doc** | 15 | CRUD, versions, diff, batch get, import URL/file, cross-book copy, export, resource download |
| **repo** | 8 | CRUD, batch get, cross-book copy, full export (TOC-structure + INDEX/GRAPH) |
| **toc** | 3 | Get, update, batch update (createTitle/appendNode/removeNode/moveNode) |
| **search** | 3 | General search + RAG-enhanced search + Cookie web search |
| **user** | 3 | User info, heartbeat, group list |
| **group** | 3 | Member list, role change, delete member |
| **statistic** | 4 | Group/member/repo/doc statistics |
| **note** | 4 | CRUD + soft-delete/restore |
| **recycle** | 3 | List, restore, destroy (Cookie auth) |
| **upload** | 1 | File upload to Yuque CDN (Cookie auth) |
| **board** | 3 | Mindmap, flowchart, architecture diagram |
| **mine** | 7 | Book stacks, editor center, update/sort book stack (Cookie auth) |
| **web_doc** | 8 | Web API: get/list docs, repos, TOC, move/copy/delete catalog nodes (Cookie auth) |
| **Total** | **65** | |
**Auth split**: 45 tools use the OpenAPI (X-Auth-Token); 20 are Web API requiring Cookie + x-csrf-token — web_doc (8), mine (7), recycle (3), upload (1), web_search (1).
All 65 Tools
| Tool | Domain | Description |
|------|--------|-------------|
| yuque_hello | user | 心跳检测，验证 Token 有效性 |
| yuque_get_user | user | 获取当前 Token 的用户详情 |
| yuque_get_user_groups | user | 获取用户所属的团队列表 |
| yuque_search | search | 通用搜索文档/知识库 |
| yuque_rag_search | search | RAG 检索增强搜索 + 自动获取文档内容 |
| yuque_web_search | search | Cookie 态 Web 搜索，返回完整文档对象 + 精确总数 + 高亮摘要 |
| yuque_get_group_users | group | 获取团队成员列表 |
| yuque_update_group_user | group | 变更团队成员角色 |
| yuque_delete_group_user | group | 删除团队成员 |
| yuque_list_docs | doc | 获取知识库文档列表 |
| yuque_create_doc | doc | 创建文档 |
| yuque_get_doc | doc | 获取文档详情（支持 ID 或 slug） |
| yuque_update_doc | doc | 更新文档 |
| yuque_delete_doc | doc | 删除文档 |
| yuque_batch_get_docs | doc | 批量获取文档详情（max 20） |
| yuque_get_doc_versions | doc | 获取文档历史版本列表 |
| yuque_get_doc_version_detail | doc | 获取文档历史版本详情 |
| yuque_diff_doc_versions | doc | 对比两个版本的行级差异 |
| yuque_copy_doc | doc | 单文档跨库复制 |
| yuque_export_doc | doc | 导出单篇文档为 Markdown 文件 |
| yuque_export_resources | doc | 下载文档中的图片/附件到本地 |
| yuque_import_url | doc | 从网页 URL 导入文档 |
| yuque_import_file | doc | 从本地文件导入文档 |
| yuque_embed_url | doc | 生成文档嵌入阅读器 URL |
| yuque_get_toc | toc | 获取知识库目录 |
| yuque_update_toc | toc | 更新知识库目录 |
| yuque_batch_update_toc | toc | 批量更新目录（createTitle/appendNode/removeNode/moveNode/prependDoc） |