APISIX Mcp
@api7
About APISIX Mcp
APISIX Model Context Protocol (MCP) server is used to bridge large language models (LLMs) with the APISIX Admin API.
Basic information
Config
Add this server to your MCP-compatible client using the configuration below.
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
],
"env": {
"APISIX_SERVER_HOST": "your-apisix-server-host",
"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"
}
}
}
}Tools
32Get resource details by ID or list all resources
Delete a resource by ID
Send a request or multiple requests to the APISIX gateway
Create a route
Update specific attributes of an existing route
Create a service
Update specific attributes of an existing service
Create an upstream service with load balancing settings
Update specific attributes of an existing upstream
Create a consumer, if the consumer already exists, it will be updated
Get all credentials or a specific credential for a consumer
Create or update a credential for a consumer
Delete a credential for a consumer
Create an SSL certificate
Update specific attributes of an existing SSL certificate
Create a global rule
Update specific attributes of an existing global rule
Create a consumer group
Update specific attributes of an existing consumer group
Get all plugin names
Get all plugins schema or a specific plugin schema by name
Get metadata for a specific plugin
Create a new plugin config
Update a plugin config
Create or update plugin metadata
Delete plugin metadata
Create a stream route, if the stream route already exists, it will be updated
Get a secret by ID
Create a secret
Update specific attributes of an existing secret
Delete a secret by ID
Create a proto, if the proto already exists, it will be updated
Overview
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.
More Other MCP servers
Nginx UI
0xJackyYet another WebUI for Nginx
🚀 Model Context Protocol (MCP) Curriculum for Beginners
microsoftThis open-source curriculum introduces the fundamentals of Model Context Protocol (MCP) through real-world, cross-language examples in .NET, Java, TypeScript, JavaScript, Rust and Python. Designed for developers, it focuses on practical techniques for building modular, scalable,
Inbox Zero AI MCP
elie222The world's best AI personal assistant for email. Open source app to help you reach inbox zero fast.
Awesome Mcp Servers
punkpeyeA collection of MCP servers.
Awesome-MCP-ZH
yzflyMCP 资源精选, MCP指南,Claude MCP,MCP Servers, MCP Clients
Comments