The APISIX Model Context Protocol (MCP) server is used to establish a bridge between large language models (LLMs) and the APISIX Admin API, with the goal of allowing users to view and manage resources in APISIX through natural language via MCP-compatible AI clients.
Purpose This project targets Apache APISIX operations and management scenarios. By using the MCP protocol to connect LLMs with the APISIX Admin API, it enables AI clients to perform query and change operations on APISIX resources.
Main capabilities The supported operations are divided into the following categories:
- General operations: get_resource (get resources by type, such as routes, services, upstreams, etc.), delete_resource (delete resources by ID), send_request_to_gateway (send one or more requests to the APISIX gateway).
- API resource operations: create/update/delete routes (create_route / update_route / delete_route); create/update/delete services (create_service / update_service / delete_service); create/update/delete upstreams (create_upstream / update_upstream / delete_upstream); create/update/delete SSL certificates (create_ssl / update_ssl / delete_ssl); create or update Protobuf definitions (create_or_update_proto); create or update stream routes (create_or_update_stream_route).
- Plugin operations: get all available plugin names (get_all_plugin_names); get plugin configuration (get_plugin_info / get_plugins_by_type / get_plugin_schema); create/update plugin configuration (create_plugin_config / update_plugin_config); create/update plugin global rules (create_global_rule / update_global_rule); manage plugin metadata (get_plugin_metadata / create_or_update_plugin_metadata / delete_plugin_metadata).
- Security configuration: get/create/update secrets (get_secret_by_id / create_secret / update_secret); create or update consumers, delete consumers (create_or_update_consumer / delete_consumer); get/create or update/delete consumer credentials (get_credential / create_or_update_credential / delete_credential); create or delete consumer groups (create_consumer_group / delete_consumer_group).
How to use Configure and use it in an AI client. You first need to install and run APISIX according to the APISIX Getting Started guide. You can automatically install the APISIX Model Context Protocol Server for Claude Desktop via Smithery, or use the source code method: first clone the apisix-mcp repository, then install dependencies and build the project. After that, configure it accordingly in an AI client (Cursor, Claude, Copilot, etc.). If you need to view or modify the Admin API configuration in APISIX, refer to the Admin API documentation.
Use cases Suitable for developers and operations personnel who need to view and manage APISIX resources (routes, services, upstreams, SSL, plugin configuration, consumers, credentials, etc.) through an AI client in natural language, and also suitable for scenarios where AI applications/agents/LLMs are expected to discover this MCP server through common Python/TypeScript APIs and search for and explore related servers and tools.
Limitations The materials do not provide explanations regarding fees, pricing, platform limitations, or performance guarantees. Before use, you need to deploy and run APISIX yourself, and refer to the Admin API documentation to complete the configuration.
