跳到主要内容
版本:3.8.x

部署 API7 MCP

API7-MCP 是用于连接 API7ee API 的模型上下文协议(MCP)服务器,支持 AI 大语言模型分析网关资源配置、监控数据分析、权限管理和风险项检测等。

本教程介绍如何部署 API7-MCP、使用它管理资源和发送请求。教程使用 VS Code 和 Cline 演示,你也可以根据自己的工作流程选择 Cursor、Claude Desktop 等其他 AI 客户端。

前提条件​

  1. 安装 API7 企业版。
  2. 从 Visual Studio Code(VS Code)的扩展市场安装 Cline。

安装并配置 API7-MCP​

以下介绍不同的安装方式。

npm​

如果通过 npm 安装,请使用以下信息配置 MCP 服务器。然后根据你的环境,在 AI 客户端中更新 API7 控制台地址、网关地址和 API7 企业版 Token:

{
"mcpServers": {
"api7-mcp": {
"command": "npx",
"args": ["-y", "api7-mcp"],
"env": {
"DASHBOARD_URL": "your-api7ee-dashboard-url",
"GATEWAY_URL": "your-api7ee-gateway-server-url",
"TOKEN": "your-api7ee-token"
}
}
}
}

从源码安装​

如果从源码安装,请先克隆 api7-mcp 仓库:

git clone https://github.com/api7/api7-mcp.git
cd api7-mcp

安装依赖并构建项目:

pnpm install
pnpm build

最后,使用以下信息配置 MCP 服务器,并根据你的环境在 AI 客户端中更新 API7 控制台地址、网关地址和 API7 企业版 Token:

{
"mcpServers": {
"api7-mcp": {
"disabled": false,
"command": "node",

"args": ["your-project-path/dist/index.js"],
"env": {
"DASHBOARD_URL": "your-api7ee-dashboard-url",
"GATEWAY_URL": "your-api7ee-gateway-server-url",
"TOKEN": "your-api7ee-token"
}
}
}
}

❶ args:运行上述命令后,VS Code 的资源管理器面板中会出现 dist 文件夹。记录 dist 文件夹的路径,例如 /Users/alice/workspace/new/api7-mcp/dist/index.js。

❷ DASHBOARD_URL:API7 企业版 控制台的域名,例如 http://192.168.31.29:7443。

❸ GATEWAY_URL:API7 企业版 的网关服务器 URL,例如 http://192.168.64.1:9080。

❹ TOKEN:配置在 API7 企业版 控制台生成的 Token。

保存配置后,你应该能看到 AI 客户端中已成功安装 MCP 服务器。

启动 MCP 服务器​

本教程使用 VS Code 和 Cline 演示。

打开 VS Code,点击左侧导航栏中的 Cline。

打开 Cline

在 Cline 顶部点击 MCP Servers。

配置 MCP 服务器

选择 Installed,点击 Configure MCP Servers,打开 cline_mcp_settings.json 文件。

配置 MCP 服务器

按照从源码安装部分的说明更新 cline_mcp_settings.json 文件,以配置 MCP 服务器。

配置 cline_mcp_settings.json 文件后,api7-mcp 右侧的状态会变为绿色,表示配置成功且 API7-MCP 正在运行。

MCP 配置成功

点击右上角的 Done 按钮完成配置。

完成 MCP 配置

在 VS Code 中配置 Cline​

点击右上角的设置图标进入设置。

打开设置

在 API Provider 字段中选择你偏好的 API Provider,例如 OpenRouter。

选择 OpenRouter 作为 API Provider

输入在 OpenRouter 平台生成的 OpenRouter API Key。

输入 OpenRouter API Key

在 Model 中选择需要的 AI 模型,例如 deepseek/deepseek-chat-v3-0324。

选择模型

点击右上角的 Save 完成配置。

保存设置

验证​

在 VS Code 中,请 Cline 向 API7 企业版 发送 5 个 API 请求。

发送 5 个 API 请求

Cline 要使用 send_request_to_gateway 操作运行命令。点击 Approve 授权。

授权 Cline 发送请求

Cline 返回 5 个 API 请求已成功发送。

成功发送 API 请求

检查 API 请求数​

请 Cline 检查 API7 企业版 过去 10 分钟的所有 API 请求。

检查 API 请求

Cline 请求获取过去 10 分钟的 API 请求数据。点击 Approve 授权。

批准获取 API 请求数据

Cline 返回 API7 企业版 过去 10 分钟的 API 请求数据。结果显示,过去 10 分钟的请求数为“5.13”,且 5 个请求均成功发送。

API 请求汇总

在 API7 企业版 控制台的侧边导航栏中选择 Monitoring。请求量为 5,且 5 个请求都收到 200 响应,与 API7-MCP 的结果一致。

已验证的 API 请求数

备注

API 请求数 13% 的偏差可能由网络延迟、数据传输问题、缓存机制或数据更新延迟等因素引起,这属于正常现象。

检查 QPS 和延迟​

请 Cline 检查 API7 企业版 过去 10 分钟的 QPS 和延迟数据。

检查 QPS 和延迟

Cline 请求使用 get_prometheus_metrics 操作获取 QPS 和延迟数据。点击 Approve 授权。

获取 QPS 和延迟数据

Cline 返回 API7 企业版 过去 10 分钟的 QPS 和延迟监控数据。结果显示,延迟峰值为 181.9ms。

QPS 和延迟汇总

在 API7 企业版 控制台的侧边导航栏中选择 Monitoring。延迟峰值 181.9ms 出现在 11:15:55,与 API7-MCP 的结论一致。

已验证的 QPS 数据

其他资源​