The Yuque MCP Server enables interaction with Yuque (语雀) knowledge bases through Claude, providing comprehensive document management capabilities:
Available Tools:
search - Find documents by keywords using a search query (
qparameter)get_doc - Retrieve detailed content of a specific document (requires
doc_idandbook_id)get_toc - Browse the knowledge base's table of contents and directory structure
create_doc - Add new documents with
titleandcontent, with optionaltarget_uuidandaction_modefor placement controlupdate_doc - Modify existing documents by updating their
title,content, orslugpath (requiresdoc_id)
Key Capabilities:
Search across documents using keyword queries
Retrieve full document content from specific knowledge bases
Browse and navigate knowledge base structure
Create and update documents for seamless content management
Integrate with Claude Desktop via MCP protocol for efficient workflows
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Yuque MCP Serversearch for documentation about the frontend development workflow"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Yuque MCP Server
语雀(Yuque)文档 Model Context Protocol (MCP) 服务器,提供文档搜索、目录浏览、内容获取和文档创建功能。
功能
search: 搜索语雀文档
get_doc: 获取文档详细内容
get_toc: 获取知识库目录结构
create_doc: 创建新文档
update_doc: 更新现有文档
安装
构建
MCP 配置
在 Claude Desktop 配置文件中添加:
macOS
~/Library/Application Support/Claude/claude_desktop_config.json
Windows
%APPDATA%\Claude\claude_desktop_config.json
配置内容:
CLI 配置
工具说明
search
搜索语雀文档。
参数:
参数 | 类型 | 必填 | 说明 |
q | string | 是 | 搜索关键词 |
使用场景: 用户想查找特定内容的文档
示例:
get_toc
获取知识库目录结构。
参数: 无(从环境变量读取知识库配置)
使用场景: 用户想浏览目录或导航文件夹结构
返回: 扁平化的目录项列表,包含 uuid 和 title
示例:
get_doc
获取指定文档的详细内容。
参数:
参数 | 类型 | 必填 | 说明 |
doc_id | number | 是 | 文档 ID |
使用场景: 已有文档 ID,需要读取完整文档内容
示例:
create_doc
创建新文档并添加到目录结构中。
参数:
参数 | 类型 | 必填 | 说明 |
title | string | 是 | 文档标题 |
content | string | 是 | 文档内容(Markdown 格式) |
target_uuid | string | 否 | 目标节点 UUID(通过 get_toc 获取)。不填则添加到根节点 |
action_mode | string | 否 | 插入模式: |
使用场景: 用户想创建新文档
返回: 文档 ID、标题和访问 URL
示例:
update_doc
更新现有文档的标题、内容或路径。
参数:
参数 | 类型 | 必填 | 说明 |
doc_id | string | 是 | 文档 ID 或路径 |
title | string | 否 | 新文档标题 |
content | string | 否 | 文档内容(Markdown 格式) |
slug | string | 否 | 新文档路径 |
使用场景: 修改已有文档的内容或标题
返回: 文档 ID、标题、路径、访问 URL 和更新时间
示例:
项目结构
使用示例
搜索文档
浏览目录
创建文档
更新文档
组合使用
许可证
MIT