Yuque MCP

MCP文档知识

提供方 HenryHaoson · 包名 @smithery/cli

文档知识 stdio · 本地进程 无需鉴权 社区 / 第三方 Claude
查看接入方式

一个用于与语雀API集成的Model-Context-Protocol (MCP)服务器,提供文档管理、内容搜索和团队统计分析功能。

一句话选型结论

按资料字段整理

Yuque MCP 属于文档知识类 MCP 服务器,stdio · 本地进程,无需鉴权,可直接接入 Claude,有可直接复制的远程端点配置。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式支持远程部署
GitHub 星标 61 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

知识管理TypeScript本地部署API集成文档管理团队协作数据分析

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    确认你的客户端支持远程端点,并拿到服务地址。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude,换客户端不用重新研究配置。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Yuque MCP当前 未标注 stdio · 本地进程 支持远程部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方HenryHaoson上游标注的维护方 HenryHaoson
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时@smithery/cli · Node.js本地安装时用到的包标识与运行时
部署类型支持远程部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.0 KB
来自项目仓库与上游目录的原文,未做删改

语雀 MCP 服务器

English Version

一个用于与语雀 API 集成的 Model-Context-Protocol (MCP) 服务器。此实现受 Figma-Context-MCP 的启发,并使用 语雀开放 API。

概述

该服务器提供了与语雀知识库平台交互的 MCP 工具,允许 AI 模型:

  • 获取用户和文档信息
  • 创建、读取、更新和删除文档
  • 搜索语雀中的内容
  • 获取知识库信息
  • 获取统计数据和分析信息

安装

安装 via Smithery

要使用 Smithery 将 Yuque MCP Server 自动安装到 Claude 桌面端:```bash
npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude


### 前提条件

- Node.js 18+ (推荐)
- 拥有 API 令牌的语雀账号

### 设置

1. 克隆此仓库:```
git clone https://github.com/Henryhaoson/Yueque-MCP-Server.git
cd Yueque-MCP-Server
  1. 安装依赖:```
    npm install

3. 基于 `.env.example` 创建 `.env` 文件:```
cp .env.example .env
  1. (可选) 在 .env 文件中添加你的语雀 API 令牌:```
    YUQUE_API_TOKEN=your_yuque_api_token_here

你也可以选择在连接到服务器时通过查询参数提供令牌,而不是在 .env 文件中设置。

## 使用方法

### 运行服务器

#### 开发模式```bash
# HTTP 服务器模式
npm run dev

# CLI stdio 模式
npm run dev:cli

生产模式

首先,构建项目:```bash
npm run build


然后在 HTTP 或 CLI 模式下运行:```bash
# HTTP 服务器模式
npm run start

# CLI stdio 模式
npm run start:cli

使用 Docker 部署

本项目提供了 Docker 支持,使您可以轻松地容器化和部署服务器。

使用 Docker Compose(推荐)

  1. 构建并启动容器:```bash
    docker-compose up -d

2. 查看日志:```bash
docker-compose logs -f
  1. 停止服务:```bash
    docker-compose down

您可以通过环境变量或在 `.env` 文件中设置配置项:```bash
# .env 文件示例
PORT=3000
YUQUE_API_TOKEN=your_token_here
YUQUE_API_BASE_URL=https://www.yuque.com/api/v2

手动使用 Docker

  1. 构建 Docker 镜像:```bash
    docker build -t yuque-mcp-server .

2. 运行容器:```bash
docker run -d -p 3000:3000 --name yuque-mcp-server yuque-mcp-server
  1. 使用环境变量:```bash
    docker run -d -p 3000:3000 \
    -e YUQUE_API_TOKEN=your_token_here \
    -e YUQUE_API_BASE_URL=https://www.yuque.com/api/v2 \
    --name yuque-mcp-server yuque-mcp-server

### MCP 工具

语雀 MCP 服务器提供以下工具:

#### 用户和文档管理
- `get_current_user` - 获取当前认证用户的信息,包括用户ID、用户名、头像等语雀账号基本信息
- `get_user_docs` - 获取当前用户的所有知识库文档列表,包括私人和协作文档
- `get_user_repos` - 获取指定用户的知识库列表,知识库是语雀中组织文档的集合
- `get_repo_docs` - 获取特定知识库中的所有文档列表,包括文档标题、更新时间等信息
- `get_doc` - 获取语雀中特定文档的详细内容,包括正文、修改历史和权限信息
- `create_doc` - 在指定知识库中创建新的语雀文档,支持多种格式内容(Markdown、HTML、Lake)
- `update_doc` - 更新语雀中已存在的文档,可以修改标题、内容或权限设置
- `delete_doc` - 从语雀知识库中删除指定文档,此操作不可撤销
- `search` - 在语雀平台中搜索文档或知识库内容,支持范围和作者筛选

#### 团队统计分析
- `get_group_statistics` - 获取团队的汇总统计数据,包括成员人数、文档数量、阅读量和互动数据等
- `get_group_member_statistics` - 获取团队成员的统计数据,包括各成员的编辑次数、阅读量、点赞量等
- `get_group_book_statistics` - 获取团队知识库的统计数据,包括各知识库的文档数、字数、阅读量等
- `get_group_doc_statistics` - 获取团队文档的统计数据,包括各文档的字数、阅读量、评论量等

## 与 AI 模型的集成

此 MCP 服务器可以与支持 Model-Context-Protocol 的 AI 模型一起使用,允许它们通过定义的工具与语雀交互。例如:

1. 启动 MCP 服务器
2. 从兼容的客户端连接到服务器
3. AI 模型现在可以使用注册的工具与语雀数据交互

### SSE 端点的查询参数

当连接到 SSE 端点时,你可以通过查询参数(query parameters)覆盖环境配置,这些参数的优先级高于环境变量:

- `accessToken`: 覆盖在 .env 文件中设置的语雀 API 令牌
- `baseUrl`: 覆盖在 .env 文件中设置的语雀 API 基础 URL

示例:```
http://localhost:3000/sse?accessToken=your_token_here&baseUrl=https://custom.yuque.api/v2

这允许你在不修改 .env 文件的情况下动态配置服务,并且查询参数的优先级高于环境变量。这对于多用户环境或测试不同 API 端点特别有用。

每个 SSE 连接都可以使用不同的配置,这使得同一个服务器实例可以同时为不同的用户或环境提供服务。

开发

项目结构```

src/
├── config.ts # 服务器配置
├── index.ts # 主入口点
├── cli.ts # CLI 入口点
├── server.ts # MCP 服务器实现
└── services/
└── yuque.ts # 语雀 API 服务
```

添加新工具

要添加新工具,请修改 src/server.ts 中的 registerTools 方法。

API 改进

最近的更新增加了以下功能:

  1. 团队统计数据:添加了获取团队、成员、知识库和文档统计数据的功能,便于分析和监控团队知识库的使用情况。

  2. 文档管理增强:
    - 支持多种文档格式(Markdown、HTML、Lake)
    - 完善的文档公开性设置(私密、公开、企业内公开)
    - 搜索功能支持更多参数和过滤条件

  3. 数据类型完善:更新了接口定义,使其与语雀 OpenAPI 规范保持一致。

许可证

MIT License

Copyright (c) 2025 Henryhaoson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

致谢

  • Figma-Context-MCP 提供 MCP 服务器实现参考
  • 语雀开放 API 提供 API 文档
  • Model Context Protocol 提供 MCP 规范

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Yuque MCP 怎么安装?

在客户端按下面的安装命令接入:npx -y @smithery/cli install @HenryHaoson/Yuque-MCP-Server --client claude。对应的包名是 @smithery/cli。装完在客户端配置里引用同一个包或端点。

Yuque MCP 怎么在 Claude 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Yuque MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Yuque MCP 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Yuque MCP 支持哪些客户端?

资料标注支持 Claude;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Yuque MCP 能提供哪些能力?

资料显示能力标签包括 知识管理、数据分析、TypeScript、Claude、团队协作。具体工具清单以官方文档为准。

Yuque MCP 需要什么运行环境?

运行时为 Node.js;属于本地进程,需要在本机装好运行环境。

Yuque MCP 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。