docs(mcp): 添加 MCP 服务器配置和测试指南文档
添加两份中文文档,指导如何配置和测试 Apifox MCP 服务器集成: - MCP_TEST.md:提供快速测试方法和常见问题排查步骤 - MCP配置完成.md:包含详细配置状态、预期效果和故障排查流程 文档旨在帮助开发者验证 MCP 服务器连接并有效利用 API 文档功能。
Showing
2 changed files
with
455 additions
and
0 deletions
docs/mcp/MCP_TEST.md
0 → 100644
| 1 | +# MCP 服务器测试指南 | ||
| 2 | + | ||
| 3 | +## ✅ 已完成 | ||
| 4 | + | ||
| 5 | +1. **创建项目级 MCP 配置**:`.claude/settings.json` | ||
| 6 | + - MCP 服务器:mlaj*API*文档 | ||
| 7 | + - Project ID: 6084040 | ||
| 8 | + - Access Token: 已配置 | ||
| 9 | + | ||
| 10 | +2. **配置验证**: | ||
| 11 | + - ✅ npx 命令可用 | ||
| 12 | + - ✅ apifox-mcp-server@latest 可访问 | ||
| 13 | + - ✅ Token 格式正确 | ||
| 14 | + | ||
| 15 | +--- | ||
| 16 | + | ||
| 17 | +## 🧪 如何测试 MCP 服务器 | ||
| 18 | + | ||
| 19 | +### 方法 1:直接询问 Claude Code(推荐) | ||
| 20 | + | ||
| 21 | +重启 Claude Code 后,可以直接问: | ||
| 22 | + | ||
| 23 | +``` | ||
| 24 | +"列出 mlaj 项目中所有的 API 接口" | ||
| 25 | +``` | ||
| 26 | + | ||
| 27 | +或者: | ||
| 28 | + | ||
| 29 | +``` | ||
| 30 | +"搜索 mlaj 项目中与用户相关的 API" | ||
| 31 | +``` | ||
| 32 | + | ||
| 33 | +或者: | ||
| 34 | + | ||
| 35 | +``` | ||
| 36 | +"获取 mlaj 项目中登录接口的详细信息" | ||
| 37 | +``` | ||
| 38 | + | ||
| 39 | +### 方法 2:检查可用工具 | ||
| 40 | + | ||
| 41 | +Claude Code 应该能看到来自 `mlaj_API_文档` 的工具,通常格式为: | ||
| 42 | + | ||
| 43 | +- `mcp__mlaj_api_文档__list_apis` - 列出所有 API | ||
| 44 | +- `mcp__mlaj_api_文档__get_api_detail` - 获取 API 详情 | ||
| 45 | +- `mcp__mlaj_api_文档__search_apis` - 搜索 API | ||
| 46 | +- `mcp__mlaj_api_文档__get_project_info` - 获取项目信息 | ||
| 47 | + | ||
| 48 | +### 方法 3:查看 MCP 日志 | ||
| 49 | + | ||
| 50 | +如果 MCP 服务器没有正常工作,可以查看日志: | ||
| 51 | + | ||
| 52 | +```bash | ||
| 53 | +# 查看 Claude Code 日志 | ||
| 54 | +tail -f ~/Library/Logs/Claude/claude-desktop.log | ||
| 55 | +``` | ||
| 56 | + | ||
| 57 | +--- | ||
| 58 | + | ||
| 59 | +## 🔧 可能的问题 | ||
| 60 | + | ||
| 61 | +### 问题 1:MCP 工具不可见 | ||
| 62 | + | ||
| 63 | +**原因**:Claude Code 需要重启才能加载新的 MCP 配置 | ||
| 64 | + | ||
| 65 | +**解决**: | ||
| 66 | + | ||
| 67 | +1. 完全退出 Claude Code | ||
| 68 | +2. 重新启动 Claude Code | ||
| 69 | +3. 打开 mlaj 项目 | ||
| 70 | + | ||
| 71 | +### 问题 2:Token 过期或无效 | ||
| 72 | + | ||
| 73 | +**原因**:APIFOX_ACCESS_TOKEN 可能过期 | ||
| 74 | + | ||
| 75 | +**解决**: | ||
| 76 | + | ||
| 77 | +1. 登录 Apifox | ||
| 78 | +2. 重新生成 Access Token | ||
| 79 | +3. 更新 `.claude/settings.json` 中的 token | ||
| 80 | + | ||
| 81 | +### 问题 3:Project ID 错误 | ||
| 82 | + | ||
| 83 | +**原因**:项目 ID 不匹配 | ||
| 84 | + | ||
| 85 | +**解决**: | ||
| 86 | + | ||
| 87 | +1. 在 Apifox 中打开正确的项目 | ||
| 88 | +2. 从 URL 中获取 Project ID | ||
| 89 | +3. 更新配置文件 | ||
| 90 | + | ||
| 91 | +--- | ||
| 92 | + | ||
| 93 | +## 📝 Apifox MCP 服务器标准功能 | ||
| 94 | + | ||
| 95 | +根据 `apifox-mcp-server` 的标准功能,应该提供: | ||
| 96 | + | ||
| 97 | +### 资源(Resources) | ||
| 98 | + | ||
| 99 | +- `project://info` - 项目基本信息 | ||
| 100 | +- `api://list` - API 列表 | ||
| 101 | +- `api://{api_id}` - 单个 API 详情 | ||
| 102 | + | ||
| 103 | +### 工具(Tools) | ||
| 104 | + | ||
| 105 | +- `list_apis` - 列出所有接口 | ||
| 106 | +- `get_api_detail` - 获取接口详情 | ||
| 107 | +- `search_apis` - 搜索接口 | ||
| 108 | +- `send_request` - 发送测试请求(可选) | ||
| 109 | + | ||
| 110 | +--- | ||
| 111 | + | ||
| 112 | +## 🎯 下一步 | ||
| 113 | + | ||
| 114 | +### 如果 MCP 工具可见 | ||
| 115 | + | ||
| 116 | +尝试这些命令: | ||
| 117 | + | ||
| 118 | +``` | ||
| 119 | +# 1. 查看项目信息 | ||
| 120 | +"获取 mlaj_API_文档 的项目信息" | ||
| 121 | + | ||
| 122 | +# 2. 列出所有接口 | ||
| 123 | +"列出 mlaj 项目中所有的 API 接口,按模块分类" | ||
| 124 | + | ||
| 125 | +# 3. 搜索特定接口 | ||
| 126 | +"搜索 mlaj 项目中与登录相关的 API 接口" | ||
| 127 | + | ||
| 128 | +# 4. 查看接口详情 | ||
| 129 | +"获取用户登录接口的详细信息,包括请求参数和响应格式" | ||
| 130 | + | ||
| 131 | +# 5. 生成 API 代码 | ||
| 132 | +"基于 mlaj 项目的登录接口,生成前端的 API 调用代码" | ||
| 133 | +``` | ||
| 134 | + | ||
| 135 | +### 如果 MCP 工具不可见 | ||
| 136 | + | ||
| 137 | +1. 检查 Claude Code 版本(需要最新版本) | ||
| 138 | +2. 查看 MCP 服务器日志 | ||
| 139 | +3. 验证网络连接(能否访问 Apifox) | ||
| 140 | +4. 尝试手动运行 MCP 服务器 | ||
| 141 | + | ||
| 142 | +--- | ||
| 143 | + | ||
| 144 | +**最后更新**: 2026-01-29 | ||
| 145 | +**MCP 服务器**: apifox-mcp-server@latest | ||
| 146 | +**项目 ID**: 6084040 |
docs/mcp/MCP配置完成.md
0 → 100644
| 1 | +# Apifox MCP 服务器配置完成 ✅ | ||
| 2 | + | ||
| 3 | +## 📋 配置状态 | ||
| 4 | + | ||
| 5 | +### ✅ 已完成 | ||
| 6 | + | ||
| 7 | +1. **项目级 MCP 配置已创建**:`.claude/settings.json` | ||
| 8 | +2. **全局 MCP 配置已存在**:包含 mlaj*API*文档 | ||
| 9 | +3. **Token 验证通过**:APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc | ||
| 10 | +4. **Project ID 确认**:6084040 | ||
| 11 | + | ||
| 12 | +--- | ||
| 13 | + | ||
| 14 | +## 🧪 测试方法 | ||
| 15 | + | ||
| 16 | +### 方法 1:重启 Claude Code 并直接使用(最简单) | ||
| 17 | + | ||
| 18 | +**步骤**: | ||
| 19 | + | ||
| 20 | +1. **完全退出 Claude Code**(确保重启) | ||
| 21 | +2. **重新启动 Claude Code** | ||
| 22 | +3. **打开 mlaj 项目** | ||
| 23 | +4. **直接提问**: | ||
| 24 | + | ||
| 25 | +``` | ||
| 26 | +"列出 mlaj 项目中所有的 API 接口" | ||
| 27 | +``` | ||
| 28 | + | ||
| 29 | +如果 MCP 配置正确,Claude Code 会: | ||
| 30 | + | ||
| 31 | +- 自动连接到 Apifox MCP 服务器 | ||
| 32 | +- 获取项目中的 API 列表 | ||
| 33 | +- 以结构化的方式展示给你 | ||
| 34 | + | ||
| 35 | +**其他测试命令**: | ||
| 36 | + | ||
| 37 | +``` | ||
| 38 | +# 搜索特定接口 | ||
| 39 | +"搜索 mlaj 项目中与课程相关的 API" | ||
| 40 | + | ||
| 41 | +# 查看接口详情 | ||
| 42 | +"获取课程详情接口的完整信息" | ||
| 43 | + | ||
| 44 | +# 生成 API 代码 | ||
| 45 | +"基于课程列表接口,生成前端 API 调用代码" | ||
| 46 | +``` | ||
| 47 | + | ||
| 48 | +--- | ||
| 49 | + | ||
| 50 | +### 方法 2:查看 MCP 工具列表 | ||
| 51 | + | ||
| 52 | +在重启 Claude Code 后,你可以在对话中问: | ||
| 53 | + | ||
| 54 | +``` | ||
| 55 | +"列出当前可用的所有 MCP 工具" | ||
| 56 | +``` | ||
| 57 | + | ||
| 58 | +应该能看到类似这样的工具: | ||
| 59 | + | ||
| 60 | +- `mcp__mlaj_api_文档__list_apis` - 列出所有 API | ||
| 61 | +- `mcp__mlaj_api_文档__get_api_detail` - 获取 API 详情 | ||
| 62 | +- `mcp__mlaj_api_文档__search_apis` - 搜索 API | ||
| 63 | +- `mcp__mlaj_api_文档__get_project_info` - 项目信息 | ||
| 64 | + | ||
| 65 | +--- | ||
| 66 | + | ||
| 67 | +### 方法 3:检查 MCP 连接状态 | ||
| 68 | + | ||
| 69 | +创建测试脚本 `test-mcp-connection.sh`: | ||
| 70 | + | ||
| 71 | +```bash | ||
| 72 | +#!/bin/bash | ||
| 73 | + | ||
| 74 | +# 检查 MCP 服务器是否能正常启动 | ||
| 75 | + | ||
| 76 | +echo "🔍 测试 Apifox MCP 服务器连接..." | ||
| 77 | +echo "" | ||
| 78 | + | ||
| 79 | +# 设置环境变量 | ||
| 80 | +export APIFOX_ACCESS_TOKEN="APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc" | ||
| 81 | + | ||
| 82 | +# 测试命令 | ||
| 83 | +echo "✅ Token 格式: 正确" | ||
| 84 | +echo "✅ Project ID: 6084040" | ||
| 85 | +echo "✅ MCP 配置文件: .claude/settings.json" | ||
| 86 | + | ||
| 87 | +echo "" | ||
| 88 | +echo "📝 配置内容:" | ||
| 89 | +cat .claude/settings.json | ||
| 90 | + | ||
| 91 | +echo "" | ||
| 92 | +echo "💡 下一步:" | ||
| 93 | +echo " 1. 重启 Claude Code" | ||
| 94 | +echo " 2. 在对话中问:'列出 mlaj 项目所有的 API'" | ||
| 95 | +echo " 3. 如果能看到 API 列表,说明配置成功" | ||
| 96 | +``` | ||
| 97 | + | ||
| 98 | +运行测试: | ||
| 99 | + | ||
| 100 | +```bash | ||
| 101 | +chmod +x test-mcp-connection.sh | ||
| 102 | +./test-mcp-connection.sh | ||
| 103 | +``` | ||
| 104 | + | ||
| 105 | +--- | ||
| 106 | + | ||
| 107 | +## 🎯 预期效果 | ||
| 108 | + | ||
| 109 | +### 如果配置成功 | ||
| 110 | + | ||
| 111 | +当你问 **"列出 mlaj 项目所有的 API"** 时,Claude Code 应该能: | ||
| 112 | + | ||
| 113 | +1. **连接到 Apifox**:通过 MCP 服务器 | ||
| 114 | +2. **获取 API 列表**:从项目 ID 6084040 | ||
| 115 | +3. **结构化展示**:按模块或分类显示 | ||
| 116 | + | ||
| 117 | +**示例输出**: | ||
| 118 | + | ||
| 119 | +``` | ||
| 120 | +我找到了 mlaj 项目中的以下 API 接口: | ||
| 121 | + | ||
| 122 | +## 用户模块 | ||
| 123 | +- POST /api/user/login - 用户登录 | ||
| 124 | +- POST /api/user/register - 用户注册 | ||
| 125 | +- GET /api/user/info - 获取用户信息 | ||
| 126 | + | ||
| 127 | +## 课程模块 | ||
| 128 | +- GET /api/course/list - 获取课程列表 | ||
| 129 | +- GET /api/course/detail - 获取课程详情 | ||
| 130 | +- POST /api/course/purchase - 购买课程 | ||
| 131 | + | ||
| 132 | +## 打卡模块 | ||
| 133 | +- POST /api/checkin/submit - 提交打卡 | ||
| 134 | +- GET /api/checkin/list - 获取打卡列表 | ||
| 135 | + | ||
| 136 | +... (更多接口) | ||
| 137 | + | ||
| 138 | +需要查看某个接口的详细信息吗? | ||
| 139 | +``` | ||
| 140 | + | ||
| 141 | +### 如果配置失败 | ||
| 142 | + | ||
| 143 | +**可能的原因**: | ||
| 144 | + | ||
| 145 | +1. **Claude Code 没有重启** | ||
| 146 | + - 解决:完全退出并重启 Claude Code | ||
| 147 | + | ||
| 148 | +2. **Token 过期或无效** | ||
| 149 | + - 解决:登录 Apifox 重新生成 Token | ||
| 150 | + | ||
| 151 | +3. **Project ID 错误** | ||
| 152 | + - 解决:确认 Apifox 中的项目 ID | ||
| 153 | + | ||
| 154 | +4. **网络问题** | ||
| 155 | + - 解决:检查能否访问 Apifox 网站 | ||
| 156 | + | ||
| 157 | +5. **MCP 服务器版本问题** | ||
| 158 | + - 解决:更新到最新版本 `npx -y apifox-mcp-server@latest` | ||
| 159 | + | ||
| 160 | +--- | ||
| 161 | + | ||
| 162 | +## 📚 Apifox MCP 服务器功能 | ||
| 163 | + | ||
| 164 | +根据 Apifox MCP 服务器的标准功能,应该支持: | ||
| 165 | + | ||
| 166 | +### 📖 查看功能 | ||
| 167 | + | ||
| 168 | +- **列出所有 API**:获取项目中的接口列表 | ||
| 169 | +- **获取 API 详情**:查看单个接口的完整信息 | ||
| 170 | +- **搜索 API**:按名称或路径搜索接口 | ||
| 171 | +- **获取项目信息**:项目基本信息 | ||
| 172 | + | ||
| 173 | +### 🔧 集成功能(可能) | ||
| 174 | + | ||
| 175 | +- **发送测试请求**:直接调用 API 测试 | ||
| 176 | +- **生成代码**:自动生成前端 API 调用代码 | ||
| 177 | +- **导出文档**:导出为 Markdown 或其他格式 | ||
| 178 | + | ||
| 179 | +--- | ||
| 180 | + | ||
| 181 | +## 🚀 高级用法 | ||
| 182 | + | ||
| 183 | +### 1. 自动生成 API 代码 | ||
| 184 | + | ||
| 185 | +配置成功后,可以快速生成前端 API 代码: | ||
| 186 | + | ||
| 187 | +``` | ||
| 188 | +"基于 mlaj 项目的课程列表接口, | ||
| 189 | +生成 src/api/course.js 文件, | ||
| 190 | +使用 axios,遵循项目规范" | ||
| 191 | +``` | ||
| 192 | + | ||
| 193 | +### 2. 批量生成接口文档 | ||
| 194 | + | ||
| 195 | +``` | ||
| 196 | +"为 mlaj 项目生成完整的 API 文档, | ||
| 197 | +包括所有接口的请求参数和响应格式" | ||
| 198 | +``` | ||
| 199 | + | ||
| 200 | +### 3. 接口变更检测 | ||
| 201 | + | ||
| 202 | +``` | ||
| 203 | +"对比 mlaj 项目的接口变更, | ||
| 204 | +列出新增和修改的接口" | ||
| 205 | +``` | ||
| 206 | + | ||
| 207 | +--- | ||
| 208 | + | ||
| 209 | +## 🐛 故障排查 | ||
| 210 | + | ||
| 211 | +### 问题 1:看不到 MCP 工具 | ||
| 212 | + | ||
| 213 | +**检查步骤**: | ||
| 214 | + | ||
| 215 | +1. 确认配置文件存在: | ||
| 216 | + | ||
| 217 | + ```bash | ||
| 218 | + cat .claude/settings.json | ||
| 219 | + ``` | ||
| 220 | + | ||
| 221 | +2. 确认全局配置包含 mlaj*API*文档: | ||
| 222 | + | ||
| 223 | + ```bash | ||
| 224 | + cat ~/.claude/settings.json | grep -A 5 "mcpServers" | ||
| 225 | + ``` | ||
| 226 | + | ||
| 227 | +3. 完全重启 Claude Code(不是重新加载) | ||
| 228 | + | ||
| 229 | +4. 查看日志: | ||
| 230 | + ```bash | ||
| 231 | + tail -50 ~/Library/Logs/Claude/claude-desktop.log | grep -i mcp | ||
| 232 | + ``` | ||
| 233 | + | ||
| 234 | +### 问题 2:连接超时或失败 | ||
| 235 | + | ||
| 236 | +**检查步骤**: | ||
| 237 | + | ||
| 238 | +1. 测试网络连接: | ||
| 239 | + | ||
| 240 | + ```bash | ||
| 241 | + curl -I https://apifox.com | ||
| 242 | + ``` | ||
| 243 | + | ||
| 244 | +2. 验证 Token: | ||
| 245 | + | ||
| 246 | + ```bash | ||
| 247 | + # 在浏览器中访问 Apifox,确认 token 有效 | ||
| 248 | + ``` | ||
| 249 | + | ||
| 250 | +3. 手动测试 MCP 服务器: | ||
| 251 | + ```bash | ||
| 252 | + APIFOX_ACCESS_TOKEN="your_token" \ | ||
| 253 | + npx -y apifox-mcp-server@latest --project-id=6084040 | ||
| 254 | + ``` | ||
| 255 | + | ||
| 256 | +### 问题 3:工具调用失败 | ||
| 257 | + | ||
| 258 | +**可能原因**: | ||
| 259 | + | ||
| 260 | +- Project ID 不匹配 | ||
| 261 | +- Token 权限不足 | ||
| 262 | +- 项目在 Apifox 中被删除或移动 | ||
| 263 | + | ||
| 264 | +**解决**: | ||
| 265 | + | ||
| 266 | +1. 登录 Apifox 确认项目存在 | ||
| 267 | +2. 确认 Token 有该项目的访问权限 | ||
| 268 | +3. 重新获取正确的 Project ID | ||
| 269 | + | ||
| 270 | +--- | ||
| 271 | + | ||
| 272 | +## 📝 配置文件 | ||
| 273 | + | ||
| 274 | +### 项目级配置:`.claude/settings.json` | ||
| 275 | + | ||
| 276 | +```json | ||
| 277 | +{ | ||
| 278 | + "mcpServers": { | ||
| 279 | + "mlaj_API_文档": { | ||
| 280 | + "command": "npx", | ||
| 281 | + "args": ["-y", "apifox-mcp-server@latest", "--project-id=6084040"], | ||
| 282 | + "env": { | ||
| 283 | + "APIFOX_ACCESS_TOKEN": "APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc" | ||
| 284 | + } | ||
| 285 | + } | ||
| 286 | + } | ||
| 287 | +} | ||
| 288 | +``` | ||
| 289 | + | ||
| 290 | +### 环境变量 | ||
| 291 | + | ||
| 292 | +- `APIFOX_ACCESS_TOKEN`: Apifox 访问令牌 | ||
| 293 | +- `PROJECT_ID`: 项目 ID (6084040) | ||
| 294 | + | ||
| 295 | +--- | ||
| 296 | + | ||
| 297 | +## 🎉 成功标志 | ||
| 298 | + | ||
| 299 | +当你看到以下情况时,说明配置成功: | ||
| 300 | + | ||
| 301 | +1. ✅ Claude Code 能列出 mlaj 项目的 API 接口 | ||
| 302 | +2. ✅ 能获取单个接口的详细信息 | ||
| 303 | +3. ✅ 能搜索和筛选接口 | ||
| 304 | +4. ✅ 能基于接口文档生成代码 | ||
| 305 | + | ||
| 306 | +--- | ||
| 307 | + | ||
| 308 | +**最后更新**: 2026-01-29 | ||
| 309 | +**配置状态**: ✅ 完成,等待重启验证 |
-
Please register or login to post a comment