APISIX 模型上下文协议(APISIX-MCP)
APISIX-MCP 是一个模型上下文协议(Model Context Protocol,MCP)服务器,可将 APISIX 操作作为工具公开给兼容 MCP 的 AI 客户端和 Agent。配置服务器后,客户端或 Agent 可以发现并调用这些工具,以检查或管理 APISIX 资源,并通过网关发送测试请求。
APISIX-MCP 通过 Admin API 执行资源操作,其网关请求工具则通过 APISIX 代 理发送流量。
APISIX-MCP 不随 APISIX 一起提供。其源代码托管在 API7 GitHub 组织下,软件包发布在 npm 上。
如需比较 APISIX-MCP 与其他 APISIX 管理方式,请参阅管理方式。
安装和配置 APISIX-MCP
通过 npm 运行 APISIX-MCP 或从源代码构建,然后将服务器添加到 AI 客户端的 MCP 配置中。
通过 npm
将以下 MCP 服务器配置添加到 AI 客户端。根据你的环境更新 APISIX 服务器地址、端口、API 前缀和身份认证密钥:
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": ["-y", "apisix-mcp"],
"env": {
"APISIX_SERVER_HOST": "http://127.0.0.1",
"APISIX_SERVER_PORT": "9080",
"APISIX_ADMIN_API_PORT": "9180",
"APISIX_ADMIN_API_PREFIX": "/apisix/admin",
"APISIX_ADMIN_KEY": "edd1c9f034335f136f87ad84b625c8f1"
}
}
}
}
从源代码构建
要从源代码安装,请先克隆 apisix-mcp 仓库:
git clone https://github.com/api7/apisix-mcp.git
cd apisix-mcp
安装依赖项并构建项目:
pnpm install
pnpm build
将以下 MCP 服务器配置添加到 AI 客户端。替换可执行文件路径,并根据你的环境更新 APISIX 连接设置:
{
"mcpServers": {
"apisix-mcp": {
"command": "node",
"args": [
"/absolute/path/to/apisix-mcp/dist/index.js"
],
"env": {
"APISIX_SERVER_HOST": "http://127.0.0.1",
"APISIX_SERVER_PORT": "9080",
"APISIX_ADMIN_API_PORT": "9180",
"APISIX_ADMIN_API_PREFIX": "/apisix/admin",
"APISIX_ADMIN_KEY": "edd1c9f034335f136f87ad84b625c8f1"
}
}
}
}
上面的 APISIX_SERVER_HOST、APISIX_SERVER_PORT、APISIX_ADMIN_API_PORT、APISIX_ADMIN_API_PREFIX 和 APISIX_ADMIN_KEY 均使用默认值。如果 APISIX 安装也使用这些默认值,可以省略 env 配置。
保存配置后,AI 客户端应启动 APISIX-MCP 并提供其工具。
可用的 MCP 工具
APISIX-MCP 将 APISIX 操作作为 MCP 工具公开。AI 客户端或 Agent 可以根据你的指令选择和调用这些工具。运行中的服务器通过 MCP tools/list 请求公布的工具列表是权威依据。