APISIX Model Context Protocol (MCP) Server
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
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 ID
- send_request_to_gateway: Send a request or multiple requests to the APISIX gateway
API Resources Operations
- create_route/update_route/delete_route: Manage routes
- create_service/update_service/delete_service: Manage services
- create_upstream/update_upstream/delete_upstream: Manage upstream
- create_ssl/update_ssl/delete_ssl: Manage SSL certificates
- create_or_update_proto: Manage protobuf definitions
- create_or_update_stream_route: Manage stream routes
Plugin Operations
- get_all_plugin_names: Get all available plugin names
- get_plugin_info/get_plugins_by_type/get_plugin_schema: Retrieve plugins configuration
- create_plugin_config/update_plugin_config: Manage plugin configurations
- create_global_rule/update_global_rule: Manage plugin global rules
- get_plugin_metadata/create_or_update_plugin_metadata/delete_plugin_metadata: Manage plugin metadata
Security Configuration
- get_secret_by_id/create_secret/update_secret: Manage secrets
- create_or_update_consumer/delete_consumer: Manage consumers
- get_credential/create_or_update_credential/delete_credential/: Manage consumer credentials
- create_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 |