使用说明

项目简介

APISIX MCP Server 作为一个 MCP 服务器，使得用户可以通过兼容 MCP 协议的 AI 客户端，以自然语言的方式查看和管理 APISIX API 网关的各项资源配置。它简化了与 APISIX 的交互，让用户能够更直观地通过 AI 助手进行路由、服务、插件等配置操作。

主要功能点

资源管理: 提供对 APISIX 核心资源（如路由、服务、上游、SSL 证书等）的CRUD操作工具。
插件管理: 支持 APISIX 插件的查询、配置和管理，包括全局插件、插件配置和插件元数据。
安全配置管理: 允许管理消费者、凭据、消费者组和密钥等安全相关的配置。
通用操作: 提供通用的资源获取和删除工具，方便快捷地操作各类 APISIX 资源。
基于 MCP 协议: 遵循 MCP 协议标准，能够与任何兼容 MCP 协议的 AI 客户端进行通信。
Stdio 传输: 使用 Stdio 作为默认传输协议，易于部署和集成。

安装步骤

克隆仓库

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

安装依赖
```
pnpm install
```
构建项目
```
pnpm build
```

服务器配置

在你的 MCP 客户端（例如 Cursor, Claude, Copilot 等）中，配置 MCP 服务器连接信息。以下是使用 'node' 启动构建后服务器的配置示例：

{
  "mcpServers": {
    "apisix-mcp": {
      "command": "node",
      "args": [
        "your-apisix-mcp-path/build/index.js" // 请替换为实际的 build/index.js 文件路径
      ],
      "env": {
        "APISIX_SERVER_HOST": "your-apisix-server-host", // 你的 APISIX 服务器 Host，例如：http://127.0.0.1
        "APISIX_ADMIN_API_PORT": "your-apisix-admin-api-port", // APISIX Admin API 端口，默认为 9180
        "APISIX_ADMIN_API_PREFIX": "your-apisix-admin-api-prefix", // APISIX Admin API 前缀，默认为 /apisix/admin
        "APISIX_ADMIN_KEY": "your-apisix-api-key" // APISIX Admin API Key，用于鉴权
      }
    }
  }
}

配置参数说明:

'command': 启动 MCP 服务器的命令，这里使用 'node' 运行 JavaScript 文件。
'args': 命令参数，指向编译后的 'build/index.js' 文件。请务必替换 'your-apisix-mcp-path' 为你本地仓库的实际路径。
'env': 环境变量配置，用于连接到你的 APISIX Admin API。
- 'APISIX_SERVER_HOST': APISIX 服务器的地址。
- 'APISIX_ADMIN_API_PORT': APISIX Admin API 的端口。
- 'APISIX_ADMIN_API_PREFIX': APISIX Admin API 的路径前缀。
- 'APISIX_ADMIN_KEY': APISIX Admin API 的访问密钥。

基本使用方法

配置完成后，在你的 AI 客户端中，即可使用自然语言指令来操作 APISIX 资源。例如，你可以尝试：

“创建一个名为 example-route 的路由，路径为 /example，上游服务地址为 http://example.com:8080”
“获取所有服务列表”
“删除 ID 为 123 的上游服务”

AI 客户端会将你的自然语言指令转换为 MCP 请求发送到 APISIX MCP Server，服务器解析请求并调用相应的 APISIX Admin API 进行操作，最终将结果返回给 AI 客户端。

关键词