概览
What is APISIX Mcp?
APISIX Mcp is a Model Context Protocol (MCP) server that bridges large language models (LLMs) with the APISIX Admin API. It enables natural language–based interaction for viewing and managing APISIX resources through MCP‑compatible AI clients.
How to use APISIX Mcp?
Install via Smithery (npx -y @smithery/cli install @api7/apisix-mcp), npm (npx -y apisix-mcp), or from source (clone repo, pnpm install && pnpm build, then run node dist/index.js). Configure your AI client (Cursor, Claude, Copilot, etc.) with the required environment variables (APISIX_SERVER_HOST, APISIX_SERVER_PORT, APISIX_ADMIN_API_PORT, APISIX_ADMIN_API_PREFIX, APISIX_ADMIN_KEY). A running APISIX instance is a prerequisite.
Key features of APISIX Mcp
- Manage routes, services, upstreams, and SSL certificates.
- Create and update plugin configurations and global rules.
- Handle secrets, consumers, and consumer credentials.
- Retrieve plugin names, schemas, and metadata.
- Send test requests to the APISIX gateway.
- Install via Smithery, npm, or source code.
Use cases of APISIX Mcp
- Configure APISIX routes using natural language from an AI assistant.
- Automate plugin settings without manual API calls.
- Query and update upstream definitions through conversational commands.
- Manage consumer credentials and secret stores interactively.
FAQ from APISIX Mcp
What environment variables are required?
APISIX_SERVER_HOST, APISIX_SERVER_PORT, APISIX_ADMIN_API_PORT, APISIX_ADMIN_API_PREFIX, and APISIX_ADMIN_KEY must be set. Defaults: host http://127.0.0.1, port 9080, admin port 9180, prefix /apisix/admin, admin key edd1c9f034335f136f87ad84b625c8f1.
Does APISIX Mcp require a running APISIX instance?
Yes. You must follow the APISIX Getting Started guide to set up and run APISIX before using this server.
How do I install APISIX Mcp?
Use Smithery (npx -y @smithery/cli install @api7/apisix-mcp), npm (npx -y apisix-mcp), or clone the repository and build from source.
What APISIX resources can be managed?
Routes, services, upstreams, SSL certificates, protobuf definitions, stream routes, plugin configurations, global rules, plugin metadata, secrets, consumers, consumer credentials, and consumer groups.
What transport does APISIX Mcp use?
The server communicates via the MCP protocol over standard input/output (stdio) when launched as a subprocess of the AI client.
