永盛

# 语雀 MCP Server

通过 MCP (Model Context Protocol) 协议接入语雀知识库，支持笔记的增删改查操作。提供两种传输模式：Stdio（本地进程通信）和 Streamable HTTP（远程 HTTP 服务）。

功能特性

• 📋 获取知识库信息 — 通过 namespace 查询知识库详情
• 📄 读取笔记 — 获取单篇笔记的完整内容
• ✏️ 创建笔记 — 在指定知识库中创建新笔记（Markdown 格式）
• 🔄 更新笔记 — 修改已有笔记的内容
• 🔐 多方式鉴权 — 支持命令行参数、环境变量、HTTP Header 三种方式传递 Token
• 🌐 双传输模式 — 同时支持 Stdio 和 Streamable HTTP 两种 MCP 传输协议

安装

# 克隆项目
git clone https://github.com/sheng/yuque-mcp.git
cd yuque-mcp

# 安装依赖
npm install

# 编译 TypeScript
npm run build

配置

获取语雀 Token

1. 登录语雀 → 个人设置 → Token 管理
2. 创建一个新的 Token，记录生成的密钥

方式一：Stdio 模式（本地使用）

在 MCP 客户端配置文件中添加：

{
  "mcpServers": {
    "yuque-mcp": {
      "command": "node",
      "args": [
        "./build/stdio.js",
        "--token",
        "your-yuque-token"
      ]
    }
  }
}

或者通过环境变量传递 Token：

{
  "mcpServers": {
    "yuque-mcp": {
      "command": "node",
      "args": ["./build/stdio.js"],
      "env": {
        "YUQUE_TOKEN": "your-yuque-token"
      }
    }
  }
}

方式二：Streamable HTTP 模式（远程服务）

启动服务端：

# 设置环境变量
export YUQUE_TOKEN="your-yuque-token"

# 启动服务器（默认端口 3000）
npm run streamable

# 或指定端口
PORT=8080 npm run streamable

MCP 客户端配置：

{
  "mcpServers": {
    "yuque": {
      "type": "streamable-http",
      "url": "http://localhost:3000/mcp",
      "headers": {
        "Yuque-Token": "Bearer ${YUQUE_TOKEN}"
      }
    }
  }
}

可用工具

鉴权方式

Token 的解析优先级：

支持环境变量占位符自动解析：

Yuque-Token: Bearer ${YUQUE_TOKEN}      # 简洁写法
Yuque-Token: Bearer ${env:YUQUE_TOKEN}  # MCP 标准写法

本地开发

# 安装依赖
npm install

# 监听模式编译
npm run watch

# 使用 MCP Inspector 调试 Stdio 模式
npm run inspector

# 启动 HTTP 模式并调试
npm run streamable

# 打开 Web 版 MCP Inspector
npm run inspector:web

技术栈

• TypeScript
• @modelcontextprotocol/sdk — MCP 协议 SDK
• axios — HTTP 客户端
• Node.js 原生 http 模块 — HTTP 服务端

License

MIT