Jushuitan MCP — AI skill for Claude Code

jushuitan-mcp

[English](#english) | [中文](#中文)

---

中文

**聚水潭开放平台 API 文档 MCP Server** —— 让 AI Agent（Claude、Cursor、ZCode、Cline 等）直接检索聚水潭开放 API 的接口分类、参数说明、错误码与请求/响应示例，不再需要人工翻文档。

数据来源于聚水潭开放平台官方文档站（[openweb.jushuitan.com](https://openweb.jushuitan.com/dev-doc?docType=1&docId=1)），通过其公开文档接口抓取并本地结构化。

⚠️ 本项目为非官方工具，仅聚合公开文档便于检索；文档内容版权归聚水潭所有。仓库**不包含**抓取的文档数据，使用前请自行执行 `npm run fetch` 获取。

功能

工具	说明
list_categories	列出全部接口分类（20 个）及接口数量
list_apis	列出某分类下的所有接口（名称 / 路由 / docId）
search_apis	按关键词全局搜索接口（名称、路由、分类）
get_api_doc	查看接口完整文档，支持按节过滤（公共参数 / 请求参数 / 返回参数 / 错误码 / 各类示例）
refresh_data	从官方文档站重新抓取并更新本地快照

`get_api_doc` 输出包含：请求地址（正式/测试环境 baseurl）、公共请求参数、请求参数说明（由官方 JSON Schema 展开，含嵌套层级与示例值）、返回参数说明、错误码与排查方法、请求/响应/异常示例、CURL/JAVA/C#/PHP 代码示例。

快速开始

要求 Node.js ≥ 20。

git clone https://github.com/CO2T5ZN/jushuitan-mcp.git
cd jushuitan-mcp
npm install
npm run build
npm run fetch   # 拉取文档数据到 data/jushuitan-docs.json（约 10-30 秒）

一键安装（把提示词复制给 AI Agent）

不想手动改配置的话，把下面这段提示词复制给你的 AI Agent（ZCode、Claude Code、Cursor、Cline 等）即可，详细步骤在仓库 README 里，Agent 克隆后会自行阅读执行：

请帮我安装 MCP Server「jushuitan-mcp」：把仓库 https://github.com/CO2T5ZN/jushuitan-mcp 克隆到本地目录，然后阅读仓库根目录的 README.md，按其中「给 AI Agent 的操作指引」完成构建、数据拉取与 MCP 注册，最后调用 list_categories 验证并向我报告结果。

给 AI Agent 的操作指引

1. 克隆与构建：把 https://github.com/CO2T5ZN/jushuitan-mcp.git 克隆到本地目录（若目标目录已存在且是该仓库则跳过克隆），进入仓库目录依次执行 npm install、npm run build、npm run fetch。fetch 会从官方文档站拉取数据到 data/jushuitan-docs.json，约 10-30 秒；若执行失败，可在完成 MCP 注册后改用 refresh_data 工具在线拉取。
2. 注册 MCP：把你自己的 MCP 服务器配置写入 Agent 所用的 MCP 配置文件——名称 jushuitan-mcp，stdio 方式，command: node，args: ["<仓库绝对路径>/dist/index.js"]，env.JUSHUITAN_MCP_DATA 设为 <仓库绝对路径>/data/jushuitan-docs.json。各客户端的配置文件位置与格式见下节「客户端配置」；Windows 下 JSON 里路径必须用正斜杠或双反斜杠。
3. 验证：重新加载 / 重启后调用工具 list_categories，能返回 20 个接口分类即安装成功；向用户报告结果，失败则排查修复后重试。

客户端配置

通用前提：

• 服务器以 stdio 方式启动：node <仓库绝对路径>/dist/index.js。配置中