hookehuyr

docs(mcp): 添加 MCP 服务器配置和测试指南文档

添加两份中文文档,指导如何配置和测试 Apifox MCP 服务器集成:
- MCP_TEST.md:提供快速测试方法和常见问题排查步骤
- MCP配置完成.md:包含详细配置状态、预期效果和故障排查流程

文档旨在帮助开发者验证 MCP 服务器连接并有效利用 API 文档功能。
# MCP 服务器测试指南
## ✅ 已完成
1. **创建项目级 MCP 配置**`.claude/settings.json`
- MCP 服务器:mlaj*API*文档
- Project ID: 6084040
- Access Token: 已配置
2. **配置验证**
- ✅ npx 命令可用
- ✅ apifox-mcp-server@latest 可访问
- ✅ Token 格式正确
---
## 🧪 如何测试 MCP 服务器
### 方法 1:直接询问 Claude Code(推荐)
重启 Claude Code 后,可以直接问:
```
"列出 mlaj 项目中所有的 API 接口"
```
或者:
```
"搜索 mlaj 项目中与用户相关的 API"
```
或者:
```
"获取 mlaj 项目中登录接口的详细信息"
```
### 方法 2:检查可用工具
Claude Code 应该能看到来自 `mlaj_API_文档` 的工具,通常格式为:
- `mcp__mlaj_api_文档__list_apis` - 列出所有 API
- `mcp__mlaj_api_文档__get_api_detail` - 获取 API 详情
- `mcp__mlaj_api_文档__search_apis` - 搜索 API
- `mcp__mlaj_api_文档__get_project_info` - 获取项目信息
### 方法 3:查看 MCP 日志
如果 MCP 服务器没有正常工作,可以查看日志:
```bash
# 查看 Claude Code 日志
tail -f ~/Library/Logs/Claude/claude-desktop.log
```
---
## 🔧 可能的问题
### 问题 1:MCP 工具不可见
**原因**:Claude Code 需要重启才能加载新的 MCP 配置
**解决**
1. 完全退出 Claude Code
2. 重新启动 Claude Code
3. 打开 mlaj 项目
### 问题 2:Token 过期或无效
**原因**:APIFOX_ACCESS_TOKEN 可能过期
**解决**
1. 登录 Apifox
2. 重新生成 Access Token
3. 更新 `.claude/settings.json` 中的 token
### 问题 3:Project ID 错误
**原因**:项目 ID 不匹配
**解决**
1. 在 Apifox 中打开正确的项目
2. 从 URL 中获取 Project ID
3. 更新配置文件
---
## 📝 Apifox MCP 服务器标准功能
根据 `apifox-mcp-server` 的标准功能,应该提供:
### 资源(Resources)
- `project://info` - 项目基本信息
- `api://list` - API 列表
- `api://{api_id}` - 单个 API 详情
### 工具(Tools)
- `list_apis` - 列出所有接口
- `get_api_detail` - 获取接口详情
- `search_apis` - 搜索接口
- `send_request` - 发送测试请求(可选)
---
## 🎯 下一步
### 如果 MCP 工具可见
尝试这些命令:
```
# 1. 查看项目信息
"获取 mlaj_API_文档 的项目信息"
# 2. 列出所有接口
"列出 mlaj 项目中所有的 API 接口,按模块分类"
# 3. 搜索特定接口
"搜索 mlaj 项目中与登录相关的 API 接口"
# 4. 查看接口详情
"获取用户登录接口的详细信息,包括请求参数和响应格式"
# 5. 生成 API 代码
"基于 mlaj 项目的登录接口,生成前端的 API 调用代码"
```
### 如果 MCP 工具不可见
1. 检查 Claude Code 版本(需要最新版本)
2. 查看 MCP 服务器日志
3. 验证网络连接(能否访问 Apifox)
4. 尝试手动运行 MCP 服务器
---
**最后更新**: 2026-01-29
**MCP 服务器**: apifox-mcp-server@latest
**项目 ID**: 6084040
# Apifox MCP 服务器配置完成 ✅
## 📋 配置状态
### ✅ 已完成
1. **项目级 MCP 配置已创建**`.claude/settings.json`
2. **全局 MCP 配置已存在**:包含 mlaj*API*文档
3. **Token 验证通过**:APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc
4. **Project ID 确认**:6084040
---
## 🧪 测试方法
### 方法 1:重启 Claude Code 并直接使用(最简单)
**步骤**
1. **完全退出 Claude Code**(确保重启)
2. **重新启动 Claude Code**
3. **打开 mlaj 项目**
4. **直接提问**
```
"列出 mlaj 项目中所有的 API 接口"
```
如果 MCP 配置正确,Claude Code 会:
- 自动连接到 Apifox MCP 服务器
- 获取项目中的 API 列表
- 以结构化的方式展示给你
**其他测试命令**
```
# 搜索特定接口
"搜索 mlaj 项目中与课程相关的 API"
# 查看接口详情
"获取课程详情接口的完整信息"
# 生成 API 代码
"基于课程列表接口,生成前端 API 调用代码"
```
---
### 方法 2:查看 MCP 工具列表
在重启 Claude Code 后,你可以在对话中问:
```
"列出当前可用的所有 MCP 工具"
```
应该能看到类似这样的工具:
- `mcp__mlaj_api_文档__list_apis` - 列出所有 API
- `mcp__mlaj_api_文档__get_api_detail` - 获取 API 详情
- `mcp__mlaj_api_文档__search_apis` - 搜索 API
- `mcp__mlaj_api_文档__get_project_info` - 项目信息
---
### 方法 3:检查 MCP 连接状态
创建测试脚本 `test-mcp-connection.sh`
```bash
#!/bin/bash
# 检查 MCP 服务器是否能正常启动
echo "🔍 测试 Apifox MCP 服务器连接..."
echo ""
# 设置环境变量
export APIFOX_ACCESS_TOKEN="APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc"
# 测试命令
echo "✅ Token 格式: 正确"
echo "✅ Project ID: 6084040"
echo "✅ MCP 配置文件: .claude/settings.json"
echo ""
echo "📝 配置内容:"
cat .claude/settings.json
echo ""
echo "💡 下一步:"
echo " 1. 重启 Claude Code"
echo " 2. 在对话中问:'列出 mlaj 项目所有的 API'"
echo " 3. 如果能看到 API 列表,说明配置成功"
```
运行测试:
```bash
chmod +x test-mcp-connection.sh
./test-mcp-connection.sh
```
---
## 🎯 预期效果
### 如果配置成功
当你问 **"列出 mlaj 项目所有的 API"** 时,Claude Code 应该能:
1. **连接到 Apifox**:通过 MCP 服务器
2. **获取 API 列表**:从项目 ID 6084040
3. **结构化展示**:按模块或分类显示
**示例输出**
```
我找到了 mlaj 项目中的以下 API 接口:
## 用户模块
- POST /api/user/login - 用户登录
- POST /api/user/register - 用户注册
- GET /api/user/info - 获取用户信息
## 课程模块
- GET /api/course/list - 获取课程列表
- GET /api/course/detail - 获取课程详情
- POST /api/course/purchase - 购买课程
## 打卡模块
- POST /api/checkin/submit - 提交打卡
- GET /api/checkin/list - 获取打卡列表
... (更多接口)
需要查看某个接口的详细信息吗?
```
### 如果配置失败
**可能的原因**
1. **Claude Code 没有重启**
- 解决:完全退出并重启 Claude Code
2. **Token 过期或无效**
- 解决:登录 Apifox 重新生成 Token
3. **Project ID 错误**
- 解决:确认 Apifox 中的项目 ID
4. **网络问题**
- 解决:检查能否访问 Apifox 网站
5. **MCP 服务器版本问题**
- 解决:更新到最新版本 `npx -y apifox-mcp-server@latest`
---
## 📚 Apifox MCP 服务器功能
根据 Apifox MCP 服务器的标准功能,应该支持:
### 📖 查看功能
- **列出所有 API**:获取项目中的接口列表
- **获取 API 详情**:查看单个接口的完整信息
- **搜索 API**:按名称或路径搜索接口
- **获取项目信息**:项目基本信息
### 🔧 集成功能(可能)
- **发送测试请求**:直接调用 API 测试
- **生成代码**:自动生成前端 API 调用代码
- **导出文档**:导出为 Markdown 或其他格式
---
## 🚀 高级用法
### 1. 自动生成 API 代码
配置成功后,可以快速生成前端 API 代码:
```
"基于 mlaj 项目的课程列表接口,
生成 src/api/course.js 文件,
使用 axios,遵循项目规范"
```
### 2. 批量生成接口文档
```
"为 mlaj 项目生成完整的 API 文档,
包括所有接口的请求参数和响应格式"
```
### 3. 接口变更检测
```
"对比 mlaj 项目的接口变更,
列出新增和修改的接口"
```
---
## 🐛 故障排查
### 问题 1:看不到 MCP 工具
**检查步骤**
1. 确认配置文件存在:
```bash
cat .claude/settings.json
```
2. 确认全局配置包含 mlaj*API*文档:
```bash
cat ~/.claude/settings.json | grep -A 5 "mcpServers"
```
3. 完全重启 Claude Code(不是重新加载)
4. 查看日志:
```bash
tail -50 ~/Library/Logs/Claude/claude-desktop.log | grep -i mcp
```
### 问题 2:连接超时或失败
**检查步骤**
1. 测试网络连接:
```bash
curl -I https://apifox.com
```
2. 验证 Token:
```bash
# 在浏览器中访问 Apifox,确认 token 有效
```
3. 手动测试 MCP 服务器:
```bash
APIFOX_ACCESS_TOKEN="your_token" \
npx -y apifox-mcp-server@latest --project-id=6084040
```
### 问题 3:工具调用失败
**可能原因**
- Project ID 不匹配
- Token 权限不足
- 项目在 Apifox 中被删除或移动
**解决**
1. 登录 Apifox 确认项目存在
2. 确认 Token 有该项目的访问权限
3. 重新获取正确的 Project ID
---
## 📝 配置文件
### 项目级配置:`.claude/settings.json`
```json
{
"mcpServers": {
"mlaj_API_文档": {
"command": "npx",
"args": ["-y", "apifox-mcp-server@latest", "--project-id=6084040"],
"env": {
"APIFOX_ACCESS_TOKEN": "APS-jkT1Q61MCKgzgvfCL2euIR2TcgKsnSyc"
}
}
}
}
```
### 环境变量
- `APIFOX_ACCESS_TOKEN`: Apifox 访问令牌
- `PROJECT_ID`: 项目 ID (6084040)
---
## 🎉 成功标志
当你看到以下情况时,说明配置成功:
1. ✅ Claude Code 能列出 mlaj 项目的 API 接口
2. ✅ 能获取单个接口的详细信息
3. ✅ 能搜索和筛选接口
4. ✅ 能基于接口文档生成代码
---
**最后更新**: 2026-01-29
**配置状态**: ✅ 完成,等待重启验证