The APISIX-MCP server bridges large language models (LLMs) with the APISIX Admin API, enabling natural language-based interaction for managing APISIX resources and configurations. You can:
- Manage API resources: Create, update or delete routes, services, upstreams, SSL certificates, protobuf definitions, and stream routes
- Handle plugins: Retrieve plugin information, manage configurations, create global rules, and control plugin metadata
- Configure security: Manage secrets (Vault, AWS, GCP), consumers, consumer credentials, and consumer groups
- Perform operations: List and retrieve resources by type, delete resources by ID, and send requests directly to the APISIX gateway
- Integrate with AI clients: Configure AI clients like Claude, Copilot, and Cursor for natural language interactions
Integrates with Apache APISIX to enable natural language-based interaction for viewing and managing API gateway resources including routes, services, upstreams, SSL certificates, plugins, and security configurations through the APISIX Admin API.
Provides installation and deployment through npm, allowing users to easily set up the MCP server using 'npx -y apisix-mcp' with configurable environment variables.
Supports installation and build processes using pnpm package manager when deploying from source code, with commands for dependency installation and project building.
APISIX 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:
Using npm
Configure your AI client (Cursor, Claude, Copilot, etc.) with following settings:
Using source code
First clone the apisix-mcp repository:
Install the dependencies and build the project:
Configure your AI client (Cursor, Claude, Copilot, etc.) with following settings:
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.
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Tools
The APISIX Model Context Protocol (MCP) server bridges large language models (LLMs) with the APISIX Admin API.
Related Resources
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.Last updated -12,4131,751TypeScriptMIT License
- -securityAlicense-qualityMCP Server provides a simpler API to interact with the Model Context Protocol by allowing users to define custom tools and services to streamline workflows and processes.Last updated -132TypeScriptMIT License
Upstash MCP Serverofficial
AsecurityAlicenseAqualityModel Context Protocol (MCP) is a new, standardized protocol for managing context between large language models (LLMs) and external systems. In this repository, we provide an installer as well as an MCP Server for Upstash Developer API's.Last updated -165827TypeScriptMIT License- -securityAlicense-qualityA Model Context Protocol (MCP) server designed to easily dump your codebase context into Large Language Models (LLMs).Last updated -21JavaScriptApache 2.0