APISIX-MCP

O servidor APISIX Model Context Protocol (MCP) é usado para conectar grandes modelos de linguagem (LLMs) à API Admin do APISIX, permitindo consultar e gerenciar todos os recursos no Apache APISIX.

GitHub

Experimente este MCPPatrocinado

Documentação

Servidor APISIX Model Context Protocol (MCP)

O servidor APISIX Model Context Protocol (MCP) é usado para conectar grandes modelos de linguagem (LLMs) à API Admin do APISIX. Ele tem como objetivo permitir interação baseada em linguagem natural para visualizar e gerenciar recursos no APISIX por meio de clientes de IA compatíveis com MCP.

mcp-demo.mp4

Operações Suportadas

Operações Comuns

get_resource: Recuperar recursos por tipo (rotas, serviços, upstreams, etc.)
delete_resource: Remover recursos por ID
send_request_to_gateway: Enviar uma ou múltiplas requisições ao gateway APISIX

Operações de Recursos da API

create_route / update_route / delete_route: Gerenciar rotas
create_service / update_service / delete_service: Gerenciar serviços
create_upstream / update_upstream / delete_upstream: Gerenciar upstream
create_ssl / update_ssl / delete_ssl: Gerenciar certificados SSL
create_or_update_proto: Gerenciar definições de protobuf
create_or_update_stream_route: Gerenciar rotas de stream

Operações de Plugins

get_all_plugin_names: Obter todos os nomes de plugins disponíveis
get_plugin_info / get_plugins_by_type / get_plugin_schema: Recuperar configurações de plugins
create_plugin_config / update_plugin_config: Gerenciar configurações de plugins
create_global_rule / update_global_rule: Gerenciar regras globais de plugins
get_plugin_metadata / create_or_update_plugin_metadata / delete_plugin_metadata: Gerenciar metadados de plugins

Configuração de Segurança

get_secret_by_id / create_secret / update_secret: Gerenciar segredos
create_or_update_consumer / delete_consumer: Gerenciar consumidores
get_credential / create_or_update_credential / delete_credential /: Gerenciar credenciais de consumidores
create_consumer_group / delete_consumer_group: Gerenciar grupos de consumidores

Configuração no cliente de IA

Pré-requisito

Siga o guia Getting Started do APISIX para configurar e executar o APISIX.

Instalação via Smithery

Para instalar o Servidor APISIX Model Context Protocol para Claude Desktop automaticamente via Smithery:

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

Usando npm

Configure seu cliente de IA (Cursor, Claude, Copilot, etc.) com as seguintes configurações:

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

Primeiro, clone o repositório apisix-mcp:

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

Instale as dependências e compile o projeto:

pnpm install
pnpm build

Configure seu cliente de IA (Cursor, Claude, Copilot, etc.) com as seguintes configurações:

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

Variáveis de Ambiente

Variável	Descrição	Valor Padrão
`APISIX_SERVER_HOST`	Host que tem acesso ao seu servidor APISIX	`http://127.0.0.1`
`APISIX_SERVER_PORT`	Porta do servidor APISIX	`9080`
`APISIX_ADMIN_API_PORT`	Porta da API Admin	`9180`
`APISIX_ADMIN_API_PREFIX`	Prefixo da API Admin	`/apisix/admin`
`APISIX_ADMIN_KEY`	Chave de autenticação da API Admin	`edd1c9f034335f136f87ad84b625c8f1`

Para visualizar ou modificar as configurações da API Admin no APISIX, consulte a documentação da Admin API.

Recursos

Suporte à API do Open MCP Marketplace

| GitHub | Doc | MCP Marketplace

Permite que Apps/Agentes/LLMs de IA encontrem este Servidor MCP por meio de APIs comuns em python/typescript, pesquisando e explorando servidores e ferramentas relevantes

Exemplo: Pesquisar Servidor e Ferramentas

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=[])