基本能力
产品定位
APISIX MCP Server 是一个中间件服务,用于连接 AI 客户端与 APISIX 的管理 API,实现通过自然语言交互来管理 APISIX 资源。
核心功能
- 资源管理:
- 获取、删除资源(如路由、服务、上游等)
- 发送请求到 APISIX 网关
- API 资源操作:
- 创建/更新/删除路由、服务、上游、SSL 证书、protobuf 定义、流路由
- 插件操作:
- 获取所有插件名称
- 获取插件信息、配置和模式
- 管理插件配置、全局规则和元数据
- 安全配置:
- 管理密钥、消费者、消费者凭证和消费者组
适用场景
- 通过自然语言交互管理 APISIX 资源
- 自动化 APISIX 配置和管理
- 集成 AI 客户端与 APISIX 管理功能
使用教程
使用依赖
- 按照 APISIX 入门指南 设置并运行 APISIX。
安装教程
- 通过 Smithery 安装:
bash
npx -y @smithery/cli install @api7/apisix-mcp --client claude - 通过 npm 使用:
在 AI 客户端配置中添加以下设置:
json
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
],
"env": {
"APISIX_SERVER_HOST": "your-apisix-server-host",
"APISIX_SERVER_PORT": "your-apisix-server-port",
"APISIX_ADMIN_API_PORT": "your-apisix-admin-api-port",
"APISIX_ADMIN_API_PREFIX": "your-apisix-admin-api-prefix",
"APISIX_ADMIN_KEY": "your-apisix-api-key"
}
}
}
} - 通过源代码安装:
bash
git clone https://github.com/api7/apisix-mcp.git
cd apisix-mcp
pnpm install
pnpm build
然后在 AI 客户端配置中添加相应设置。
调试方式
- 确保环境变量正确设置:
APISIX_SERVER_HOST
APISIX_SERVER_PORT
APISIX_ADMIN_API_PORT
APISIX_ADMIN_API_PREFIX
APISIX_ADMIN_KEY
- 参考 Admin API 文档 查看或修改 Admin API 配置。