Apisix MCP

What the api7/apisix-mcp MCP server does

The api7/apisix-mcp MCP server bridges MCP-compatible AI clients with Apache APISIX. It uses the APISIX Admin API to let an agent inspect gateway resources, modify configurations, and send requests to the APISIX gateway. APISIX must already be installed and running before this server can provide useful operations.

Supported resource areas include routes, services, upstreams, SSL certificates, protobuf definitions, stream routes, plugin configurations, global plugin rules, plugin metadata, secrets, consumers, consumer credentials, and consumer groups. The server also provides general resource retrieval and deletion operations, along with a way to send one or more requests to the gateway.

How it works

An MCP client starts the server locally, and the server communicates with the configured APISIX instance through its Admin API. The client supplies tool calls based on the agent's request; those calls map to operations such as creating a route, updating an upstream, retrieving plugin information, or deleting a consumer.

The api7/apisix-mcp MCP server includes separate operations for creating, updating, and deleting several APISIX resource types. Plugin-related tools can list available plugin names, return plugin information or schemas, and manage plugin configurations, global rules, and metadata. Security-focused tools cover secrets, consumers, credentials, and consumer groups.

Setup and configuration

First set up and run APISIX using the project's getting-started guidance. When using the published npm package, configure the MCP client to launch npx with -y apisix-mcp. A source-based setup instead clones the repository, runs pnpm install, builds with pnpm build, and launches the resulting dist/index.js with Node.

Configuration is supplied through environment variables:

• APISIX_SERVER_HOST identifies the host that can access APISIX; the documented default is http://127.0.0.1.
• APISIX_SERVER_PORT sets the APISIX server port; the documented default is 9080.
• APISIX_ADMIN_API_PORT sets the Admin API port; the documented default is 9180.
• APISIX_ADMIN_API_PREFIX sets the Admin API path prefix; the documented default is /apisix/admin.
• APISIX_ADMIN_KEY provides the Admin API authentication key.

The client examples mention Claude Desktop, Cursor, and Copilot configurations. The server needs network access to the APISIX host and valid Admin API authentication.

Tools and capabilities

The api7/apisix-mcp MCP server supports these capability groups:

• Retrieve resources by type and delete resources by ID.
• Create, update, and delete routes, services, upstreams, and SSL certificates.
• Create or update protobuf definitions and stream routes.
• Inspect plugin names, information, types, schemas, and metadata.
• Create or update plugin configurations and global rules.
• Manage secrets, consumers, credentials, and consumer groups.
• Send a single request or multiple requests to the APISIX gateway.

The exact resource fields and Admin API behavior remain governed by the APISIX version and its Admin API documentation.

Limitations and notes

This project manages APISIX through the Admin API; it is not an APISIX installation or gateway replacement. The README does not document a hosted endpoint, OAuth flow, or client-specific features beyond local configuration examples. Because the available operations can change gateway state and security configuration, the configured Admin API key should have appropriate access for the intended environment.