APISIX MCP server
Lets AI clients view and manage APISIX gateway resources such as routes, services, upstreams, plugins, and secrets via the Admin API.
Also known as api7/apisix-mcp
- Stars
- 38
- Tools
- —
- Downloads, 30 days
- 6,643
- Latest version
- —
- Last commit
- Jun 16, 2025
- License
- Apache-2.0
What is APISIX MCP?
APISIX lets AI clients view and manage APISIX gateway resources such as routes, services, upstreams, plugins, and secrets via the Admin API.
Summary generated from the project's README
About APISIX MCP server
Managing API gateway resources through natural language is what apisix-mcp enables for developers using AI clients like Claude, Cursor, or Copilot. By connecting large language models to the APISIX Admin API, this server allows users to view and modify complex gateway configurations without writing manual API calls.
Users set up the connection by providing environment variables such as the APISIX server host, port, admin API prefix, and the required admin key. The server provides a wide range of specialized tools to handle different gateway components. You can manage routes, services, upstreams, and SSL certificates, or interact with plugin configurations and global rules.
Beyond standard resource management, the server includes tools for security configuration, such as handling secrets, consumers, and consumer groups. It also supports specialized tasks like managing protobuf definitions or sending requests directly to the gateway to verify connectivity and behavior.
Written from the project's README. Every use case is checked against a quote from it.
How to install APISIX MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall APISIX MCP in Claude Code
$ claude mcp add apisix-mcp -- npx -y apisix-mcpInstall APISIX MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
]
}
}
}Install APISIX MCP in VS Code
.vscode/mcp.json
{
"servers": {
"apisix-mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"apisix-mcp"
]
}
}
}Install APISIX MCP in VS Code CLI
$ code --add-mcp '{"name":"apisix-mcp","type":"stdio","command":"npx","args":["-y","apisix-mcp"]}'Install APISIX MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
]
}
}
}Install APISIX MCP in Codex
$ codex mcp add apisix-mcp -- npx -y apisix-mcpInstall APISIX MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.apisix-mcp] command = "npx" args = ["-y", "apisix-mcp"]
Install APISIX MCP in Gemini CLI
$ gemini mcp add -s user apisix-mcp npx -- -y apisix-mcpInstall APISIX MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
]
}
}
}Configuration
APISIX_ADMIN_API_PORTAPISIX_ADMIN_API_PREFIXAPISIX_ADMIN_KEYAPISIX_SERVER_HOSTAPISIX_SERVER_PORT
Automated checks
Ran Nov 14, 2026Full report →Not verified yet. A server needs a score of 80, no serious finding, and enough data for us to check. How checks work · What to fix for more points
- Source repository linked and reachableapi7/apisix-mcp is public and reachablegithub.com/api7/apisix-mcp ↗Pass
- Package names this repository as its sourceapisix-mcp names api7/apisix-mcp as sourcenpmjs.com/package/apisix-mcp ↗Pass
- Build provenance (Sigstore attestation)No build attestation published for this releaseNot checked
- Open source license (OSI)Apache-2.0spdx.org/licenses/Apache-2.0.html ↗Pass
- Commit or release in the last yearLast commit or release 2025-06-16github.com/api7/apisix-mcp ↗Finding
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNo popular package one edit away from apisix-mcpPass
- No critical advisory in the package or its dependenciesNot checked
- No hidden instructions to the model0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNot checked
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubAPISIX Model Context Protocol (MCP) Server
APISIX Model Context Protocol (MCP) server is used to bridge large language models (LLMs) with the APISIX Admin API. It aims to enable natural language-based interaction for viewing and managing resources in APISIX through MCP-compatible AI clients.
https://github.com/user-attachments/assets/081e878c-225e-4ff8-a9c5-5813f4784cfe
Support Operations
Common Operations
get_resource: Retrieve resources by type (routes, services, upstreams, etc.)delete_resource: Remove resources by IDsend_request_to_gateway: Send a request or multiple requests to the APISIX gateway
API Resources Operations
create_route/update_route/delete_route: Manage routescreate_service/update_service/delete_service: Manage servicescreate_upstream/update_upstream/delete_upstream: Manage upstreamcreate_ssl/update_ssl/delete_ssl: Manage SSL certificatescreate_or_update_proto: Manage protobuf definitionscreate_or_update_stream_route: Manage stream routes
Plugin Operations
get_all_plugin_names: Get all available plugin namesget_plugin_info/get_plugins_by_type/get_plugin_schema: Retrieve plugins configurationcreate_plugin_config/update_plugin_config: Manage plugin configurationscreate_global_rule/update_global_rule: Manage plugin global rulesget_plugin_metadata/create_or_update_plugin_metadata/delete_plugin_metadata: Manage plugin metadata
Security Configuration
get_secret_by_id/create_secret/update_secret: Manage secretscreate_or_update_consumer/delete_consumer: Manage consumersget_credential/create_or_update_credential/delete_credential/: Manage consumer credentialscreate_consumer_group/delete_consumer_group: Manage consumer groups
Configuration in AI client
Prerequisite
Follow the APISIX Getting Started guide to set up and run APISIX.
Installing via Smithery
To install APISIX Model Context Protocol Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @api7/apisix-mcp --client claude
Using npm
Configure your AI client (Cursor, Claude, Copilot, etc.) with following settings:
{
"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"
}
}
}
}
Using source code
First clone the apisix-mcp repository:
git clone https://github.com/api7/apisix-mcp.git
cd apisix-mcp
Install the dependencies and build the project:
pnpm install
pnpm build
Configure your AI client (Cursor, Claude, Copilot, etc.) with following settings:
{
"mcpServers": {
"apisix-mcp": {
"command": "node",
"args": [
"your-apisix-mcp-path/dist/index.js"
],
"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"
}
}
}
}
Environment Variables
| Variable | Description | Default Value |
|---|---|---|
APISIX_SERVER_HOST |
Host that have access to your APISIX server | http://127.0.0.1 |
APISIX_SERVER_PORT |
APISIX server port | 9080 |
APISIX_ADMIN_API_PORT |
Admin API port | 9180 |
APISIX_ADMIN_API_PREFIX |
Admin API prefix | /apisix/admin |
APISIX_ADMIN_KEY |
Admin API authentication key | edd1c9f034335f136f87ad84b625c8f1 |
To view or modify Admin API configurations in APISIX, refer to the Admin API documentation.
Resources
Open MCP Marketplace API Support
- Allow AI App/Agent/LLM to find this MCP Server via common python/typescript API, search and explore relevant servers and tools
Example: Search Server and Tools
import anthropic
import mcp_marketplace as mcpm
result_q = mcpm.search(query="apisix mcp", mode="list", page_id=0, count_per_page=100, config_name="deepnlp") # search server by category choose various endpoint
result_id = mcpm.search(id="api7/apisix-mcp", mode="list", page_id=0, count_per_page=100, config_name="deepnlp") # search server by id choose various endpoint
tools = mcpm.list_tools(id="api7/apisix-mcp", config_name="deepnlp_tool")
# Call Claude to Choose Tools Function Calls
client = anthropic.Anthropic()
response = client.messages.create(model="claude-3-7-sonnet-20250219", max_tokens=1024, tools=tools, messages=[])
APISIX MCP questions
How do I add APISIX MCP to Claude Code?
Run claude mcp add apisix-mcp -- npx -y apisix-mcp in your terminal. Add --scope user to make it available in every project.
How do I add APISIX MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What is the APISIX MCP server used for?
It bridges large language models with the APISIX Admin API so MCP-compatible AI clients can view and manage APISIX resources in natural language.
How do I configure the APISIX MCP server in my AI client?
Add an mcpServers entry using npx -y apisix-mcp and set environment variables for the APISIX host, ports, prefix, and admin key.
What environment variables does apisix-mcp require?
It uses APISIX_SERVER_HOST, APISIX_SERVER_PORT, APISIX_ADMIN_API_PORT, APISIX_ADMIN_API_PREFIX, and APISIX_ADMIN_KEY.
Can it manage APISIX routes and services?
Yes, it provides tools to create, update, and delete routes, services, upstreams, SSL certificates, and stream routes.
Does apisix-mcp support managing plugins?
Yes, it can list plugin names and retrieve plugin info, schemas, configs, global rules, and metadata.
