APISIX-MCP

Official
by api7

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • 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.

Servidor de protocolo de contexto de modelo (MCP) APISIX

El servidor del Protocolo de Contexto de Modelo (MCP) de APISIX se utiliza para conectar los grandes modelos de lenguaje (LLM) con la API de administración de APISIX. Su objetivo es facilitar la interacción basada en lenguaje natural para la visualización y gestión de recursos en APISIX mediante clientes de IA compatibles con MCP.

https://github.com/user-attachments/assets/081e878c-225e-4ff8-a9c5-5813f4784cfe

Operaciones de soporte

Operaciones comunes

  • get_resource : recupera recursos por tipo (rutas, servicios, upstreams, etc.)
  • delete_resource : Eliminar recursos por ID
  • send_request_to_gateway : envía una solicitud o varias solicitudes a la puerta de enlace APISIX

Operaciones de recursos de API

  • create_route / update_route / delete_route : Administrar rutas
  • create_service / update_service / delete_service : Administrar servicios
  • create_upstream / update_upstream / delete_upstream : Administrar upstream
  • create_ssl / update_ssl / delete_ssl : Administrar certificados SSL
  • create_or_update_proto : Administrar definiciones de protobuf
  • create_or_update_stream_route : Administrar rutas de transmisión

Operaciones del complemento

  • get_all_plugin_names : Obtener todos los nombres de complementos disponibles
  • get_plugin_info / get_plugins_by_type / get_plugin_schema : Recuperar la configuración de los complementos
  • create_plugin_config / update_plugin_config : Administrar configuraciones de complementos
  • create_global_rule / update_global_rule : Administrar las reglas globales del complemento
  • get_plugin_metadata / create_or_update_plugin_metadata / delete_plugin_metadata : Administrar metadatos del complemento

Configuración de seguridad

  • get_secret_by_id / create_secret / update_secret : Administrar secretos
  • create_or_update_consumer / delete_consumer : Administrar consumidores
  • get_credential / create_or_update_credential / delete_credential /: Administrar las credenciales del consumidor
  • create_consumer_group / delete_consumer_group : Administrar grupos de consumidores

Configuración en el cliente de IA

Requisito previo

Siga la guía de introducción a APISIX para configurar y ejecutar APISIX.

Instalación mediante herrería

Para instalar automáticamente el servidor de protocolo de contexto de modelo APISIX para Claude Desktop a través de Smithery :

npx -y @smithery/cli install @api7/apisix-mcp --client claude

Usando npm

Configure su cliente de IA (Cursor, Claude, Copilot, etc.) con las siguientes configuraciones:

{ "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" } } } }

Usando código fuente

Primero clona el repositorio apisix-mcp:

git clone https://github.com/api7/apisix-mcp.git cd apisix-mcp

Instalar las dependencias y compilar el proyecto:

pnpm install pnpm build

Configure su cliente de IA (Cursor, Claude, Copilot, etc.) con las siguientes configuraciones:

{ "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" } } } }

Variables de entorno

VariableDescripciónValor predeterminado
APISIX_SERVER_HOSTHost que tiene acceso a su servidor APISIXhttp://127.0.0.1
APISIX_SERVER_PORTPuerto del servidor APISIX9080
APISIX_ADMIN_API_PORTPuerto API de administración9180
APISIX_ADMIN_API_PREFIXPrefijo de API de administración/apisix/admin
APISIX_ADMIN_KEYClave de autenticación de la API de administraciónedd1c9f034335f136f87ad84b625c8f1

Para ver o modificar las configuraciones de la API de administración en APISIX, consulte la documentación de la API de administración .

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

El servidor del Protocolo de contexto de modelo (MCP) de APISIX conecta los modelos de lenguaje grandes (LLM) con la API de administración de APISIX.

  1. Support Operations
    1. Common Operations
    2. API Resources Operations
    3. Plugin Operations
    4. Security Configuration
  2. Configuration in AI client
    1. Prerequisite
    2. Installing via Smithery
    3. Using npm
    4. Using source code
  3. Environment Variables

    Appeared in Searches

    ID: s62o271u37