APISIX Model Context Protocol (MCP) Server

APISIX Model Context Protocol (MCP) Server

site icon
2025.04.10 16
TypeScriptAPI 管理自然语言交互开发效率
APISIX Model Context Protocol (MCP) Server 是一个用于桥接大型语言模型(LLMs)与 APISIX Admin API 的服务。它旨在通过 MCP 兼容的 AI 客户端实现自然语言交互,以查看和管理 APISIX 中的资源。
View on GitHub

Overview

基本能力

产品定位

APISIX MCP Server 是一个中间件服务,用于连接 AI 客户端与 APISIX 的管理 API,实现通过自然语言交互来管理 APISIX 资源。

核心功能

  1. 资源管理
  2. 获取、删除资源(如路由、服务、上游等)
  3. 发送请求到 APISIX 网关
  4. API 资源操作
  5. 创建/更新/删除路由、服务、上游、SSL 证书、protobuf 定义、流路由
  6. 插件操作
  7. 获取所有插件名称
  8. 获取插件信息、配置和模式
  9. 管理插件配置、全局规则和元数据
  10. 安全配置
  11. 管理密钥、消费者、消费者凭证和消费者组

适用场景

  • 通过自然语言交互管理 APISIX 资源
  • 自动化 APISIX 配置和管理
  • 集成 AI 客户端与 APISIX 管理功能

使用教程

使用依赖

  1. 按照 APISIX 入门指南 设置并运行 APISIX。

安装教程

  1. 通过 Smithery 安装bash npx -y @smithery/cli install @api7/apisix-mcp --client claude
  2. 通过 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" } } } }
  3. 通过源代码安装bash git clone https://github.com/api7/apisix-mcp.git cd apisix-mcp pnpm install pnpm build 然后在 AI 客户端配置中添加相应设置。

调试方式

  1. 确保环境变量正确设置:
  2. APISIX_SERVER_HOST
  3. APISIX_SERVER_PORT
  4. APISIX_ADMIN_API_PORT
  5. APISIX_ADMIN_API_PREFIX
  6. APISIX_ADMIN_KEY
  7. 参考 Admin API 文档 查看或修改 Admin API 配置。

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。