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.

APISIX 모델 컨텍스트 프로토콜(MCP) 서버

APISIX 모델 컨텍스트 프로토콜(MCP) 서버는 대규모 언어 모델(LLM)과 APISIX 관리 API를 연결하는 데 사용됩니다. MCP 호환 AI 클라이언트를 통해 APISIX의 리소스를 보고 관리할 수 있는 자연어 기반 상호작용을 지원하는 것을 목표로 합니다.

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

지원 운영

공통 작업

  • get_resource : 유형(경로, 서비스, 업스트림 등)별로 리소스를 검색합니다.
  • delete_resource : ID로 리소스 제거
  • send_request_to_gateway : APISIX 게이트웨이에 하나 또는 여러 개의 요청을 보냅니다.

API 리소스 작업

  • create_route / update_route / delete_route : 경로 관리
  • create_service / update_service / delete_service : 서비스 관리
  • create_upstream / update_upstream / delete_upstream : 업스트림 관리
  • create_ssl / update_ssl / delete_ssl : SSL 인증서 관리
  • create_or_update_proto : protobuf 정의 관리
  • create_or_update_stream_route : 스트림 경로 관리

플러그인 작업

  • get_all_plugin_names : 사용 가능한 모든 플러그인 이름을 가져옵니다.
  • get_plugin_info / get_plugins_by_type / get_plugin_schema : 플러그인 구성 검색
  • create_plugin_config / update_plugin_config : 플러그인 구성 관리
  • create_global_rule / update_global_rule : 플러그인 글로벌 규칙 관리
  • get_plugin_metadata / create_or_update_plugin_metadata / delete_plugin_metadata : 플러그인 메타데이터 관리

보안 구성

  • get_secret_by_id / create_secret / update_secret : 비밀 관리
  • create_or_update_consumer / delete_consumer : 소비자 관리
  • get_credential / create_or_update_credential / delete_credential /: 소비자 자격 증명 관리
  • create_consumer_group / delete_consumer_group : 소비자 그룹 관리

AI 클라이언트 구성

필수 조건

APISIX 시작 가이드에 따라 APISIX를 설정하고 실행하세요.

Smithery를 통해 설치

Smithery를 통해 Claude Desktop용 APISIX Model Context Protocol Server를 자동으로 설치하려면:

지엑스피1

npm 사용하기

다음 설정으로 AI 클라이언트(Cursor, Claude, Copilot 등)를 구성하세요.

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

소스 코드 사용

먼저 apisix-mcp 저장소를 복제합니다.

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

종속성을 설치하고 프로젝트를 빌드합니다.

pnpm install pnpm build

다음 설정으로 AI 클라이언트(Cursor, Claude, Copilot 등)를 구성하세요.

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

환경 변수

변하기 쉬운설명기본값
APISIX_SERVER_HOSTAPISIX 서버에 액세스할 수 있는 호스트http://127.0.0.1
APISIX_SERVER_PORTAPISIX 서버 포트9080
APISIX_ADMIN_API_PORT관리자 API 포트9180
APISIX_ADMIN_API_PREFIX관리자 API 접두사/apisix/admin
APISIX_ADMIN_KEY관리자 API 인증 키edd1c9f034335f136f87ad84b625c8f1

APISIX에서 Admin API 구성을 보거나 수정하려면 Admin API 설명서를 참조하세요.

Appeared in Searches

ID: s62o271u37