Yuque MCP 服务器

使用说明（简明中文描述，便于开发者快速上手）

• 项目简介

  • 该仓库实现了一个基于 MCP（Model Context Protocol）的服务器端，专门为 Yuque 知识库提供上下文数据、可调用的工具以及提示模板，方便对接各类 LLM 客户端进行智能会话和信息获取。

• 主要功能点

  • 资源与数据访问：通过 Yuque API 封装的客户端，提供对用户、团队、书库、文档、版本、TOC 等资源的读取与管理能力。
  • 工具注册与执行：统一暴露多种“工具”（如 yuque_get_user、yuque_list_repos、yuque_create_doc 等），LLM 可以通过 JSON-RPC 调用这些工具。
  • 提示与模板：支持渲染和返回用于 LLM 的提示信息和数据摘要，降低上下文 token 消耗。
  • MCP 通信与协议：通过 MCP 标准的 JSON-RPC 请求格式处理 ListTools 与 CallTool 请求，返回工具列表或执行结果。
  • 多传输协议：内置 stdio 和基于 HTTP 的传输实现，方便本地开发与在线部署。

• 安装与运行步骤

  • 克隆仓库后安装依赖
  • 构建/开发模式（TypeScript 项目通常使用 npm install、npm run build、npm run dev 等）
  • 以 stdio 方式启动 MCP 服务器，或者通过 HTTP 传输开启服务端与客户端交互
  • 将 Yuque API TOKEN 配置到环境变量（YUQUE_PERSONAL_TOKEN、YUQUE_GROUP_TOKEN、或 YUQUE_TOKEN），以便访问 Yuque 数据
  • 客户端连接：通过 MCP 客户端的标准启动命令将服务器接入，通常包含 command 与 args 等字段

• 服务器配置（MCP 客户端需要的最小信息） 下面给出常见 MCP 客户端的配置示例（请将 YOUR_TOKEN 替换为你的实际 Yuque 令牌）： { "mcpServers": { "yuque": { "command": "npx", "args": ["-y", "yuque-mcp"], "env": { "YUQUE_PERSONAL_TOKEN": "YOUR_TOKEN" } } } }

  注释：

  • 该配置定义了一个名为 yuque 的 MCP 服务器条目，使用命令 npx，参数为 -y yuque-mcp，并通过环境变量传递Yuque访问令牌。
  • MCP 客户端（如 Claude Desktop、VS Code、Cursor 等）通过读取此配置并执行相应命令，即可与 MCP 服务器建立连接并进行后续交互。

• 基本使用方法

  • 为了让 LLM 客户端工作，需要确保：
    • Yuque API token 已正确配置并可访问Yuque数据
    • MCP 服务器已通过配置启动并可被客户端发现
  • 启动后，LLM 客户端即可向 MCP 服务器发起请求，查询资源、执行工具、获取提示等，服务器会返回标准的 JSON-RPC 响应，方便后续对话与推理。

• 额外信息

  • 服务器端实现了对 25+ 工具的注册与执行能力，涵盖用户、书库、文档、目录、版本、分组、统计、以及辅助工具等各类操作。
  • 客户端与服务器之间通过 JSON-RPC 进行通信，确保请求/响应的一致性和可扩展性。