语雀 MCP Server for Kimi Code
专为 Kimi Code VSCode 插件 适配的语雀 MCP 服务器。
功能特性
- 获取用户和文档信息
- 创建、读取、更新和删除文档
- 搜索语雀中的内容
- 获取知识库信息
- 获取统计数据和分析信息
- 支持文档分块处理(适合大文档)
安装
前置要求
- Node.js 18+ (推荐)
- 拥有 API 令牌的语雀账号
安装步骤
- 克隆仓库:```bash
git clone https://github.com/zouguanjun/yuque-mcp-server-for-kimicode.git
cd yuque-mcp-server-for-kimicode
2. 安装依赖:```bash
npm install
- 构建项目:```bash
npm run build
## 配置 Kimi Code VSCode 插件
### 方法一:通过 VSCode 设置界面配置
1. 打开 VSCode 设置(`Ctrl + ,` 或 `Cmd + ,`)
2. 搜索 `kimi.mcp.servers`
3. 点击 "Edit in settings.json"
4. 添加以下配置:```json
{
"kimi.mcp.servers": {
"yuque": {
"type": "stdio",
"command": "node",
"args": ["/path/to/yuque-mcp-server-for-kimicode/dist/index.js", "--stdio"],
"env": {
"YUQUE_API_TOKEN": "your_yuque_api_token_here"
}
}
}
}
方法二:直接编辑 settings.json
- 打开 VSCode 命令面板(
Ctrl + Shift + P或Cmd + Shift + P) - 输入并选择 "Preferences: Open User Settings (JSON)"
- 添加 MCP 服务器配置:```json
{
"kimi.mcp.servers": {
"yuque": {
"type": "stdio",
"command": "node",
"args": ["${userHome}/yuque-mcp-server-for-kimicode/dist/index.js", "--stdio"],
"env": {
"YUQUE_API_TOKEN": "your_yuque_api_token_here"
}
}
}
}
### 使用 npx 直接运行(无需克隆仓库)
如果你不想克隆仓库,可以直接使用 npx:```json
{
"kimi.mcp.servers": {
"yuque": {
"type": "stdio",
"command": "npx",
"args": ["-y", "yuque-mcp-server-for-kimicode", "--stdio"],
"env": {
"YUQUE_API_TOKEN": "your_yuque_api_token_here"
}
}
}
}
获取语雀 API Token
- 登录语雀(https://www.yuque.com)
- 点击右上角头像 → 账户设置
- 选择 "Token" 选项卡
- 点击 "新建 Token"
- 输入 Token 名称并选择权限(建议至少选择读取权限)
- 复制生成的 Token
使用方法
配置完成后,重启 VSCode 或重新加载窗口。在 Kimi Code 插件中,你可以:
- 使用
@yuque或工具调用来访问语雀功能 - 可用的工具包括:
-get_current_user- 获取当前用户信息
-get_user_docs- 获取用户文档列表
-get_user_repos- 获取用户知识库列表
-get_repo_docs- 获取知识库中的文档
-get_doc- 获取特定文档内容(支持分块)
-create_doc- 创建新文档
-update_doc- 更新文档
-delete_doc- 删除文档
-search- 搜索语雀内容
-get_group_statistics- 获取团队统计数据
-get_group_member_statistics- 获取团队成员统计
-get_group_book_statistics- 获取知识库统计
-get_group_doc_statistics- 获取文档统计
-get_doc_chunks_info- 获取文档分块信息
示例对话```
用户: @yuque 获取我的语雀用户信息
AI: 我来为您获取语雀用户信息。
[调用 get_current_user 工具]
您的语雀用户信息:
- 用户名: xxx
- 登录名: xxx
- 头像: xxx
...
``````
用户: @yuque 搜索关于 "API 文档" 的内容
AI: 我来在语雀中搜索 "API 文档"。
[调用 search 工具]
找到以下相关内容:
1. xxx
2. xxx
...
## 开发
### 项目结构```
src/
├── config.ts # 服务器配置
├── index.ts # 主入口点
├── cli.ts # CLI 入口点
├── server.ts # MCP 服务器实现
└── services/
└── yuque.ts # 语雀 API 服务
本地开发```bash
开发模式(stdio)
npm run dev:cli
构建
npm run build
运行
npm run start:cli
```
许可证
MIT License
致谢
- 原项目:Yuque-MCP-Server
- Model Context Protocol
- 语雀开放 API
