Home
Login
Kong/mcp-konnectPlease refer to the latest official releases for information GitHub Homepage

Kong Konnect API와 상호 작용하기 위한 모델 컨텍스트 프로토콜(MCP) 서버로, AI 어시스턴트가 Kong 게이트웨이 구성, 트래픽 및 분석 데이터를 쿼리하고 분석할 수 있도록 합니다.

Apache-2.0TypeScript 31Kongmcp-konnect Last Updated: 2025-04-08

Kong MCP-Konnect 프로젝트 상세 소개

프로젝트 개요

Kong MCP-Konnect는 모델 컨텍스트 프로토콜(Model Context Protocol, MCP) 기반의 서버 프로젝트로, AI 어시스턴트가 Kong Gateway 구성, 트래픽 및 분석 데이터를 쿼리하고 분석할 수 있도록 합니다. 이 프로젝트를 통해 Claude와 같은 AI 어시스턴트가 자연어를 사용하여 Kong Konnect의 API 게이트웨이와 상호 작용할 수 있습니다.

핵심 기능

  • API 요청 분석 쿼리: 사용자 정의 필터를 지원하는 API 요청 분석
  • 게이트웨이 구성 관리: 게이트웨이 서비스, 라우트, 소비자 및 플러그인 목록 및 검사
  • 제어 평면 관리: 제어 평면 및 제어 평면 그룹 관리
  • AI 어시스턴트 통합: Claude 및 기타 MCP 호환 AI 어시스턴트와 통합

프로젝트 구조

src/
├── index.ts            # 주 진입점
├── api.ts             # Kong API 클라이언트
├── tools.ts           # 도구 정의
├── parameters.ts      # 도구 매개변수의 Zod 스키마
├── prompts.ts         # 상세한 도구 문서
├── operations/
│   ├── analytics.ts   # API 요청 분석 작업
│   ├── configuration.ts # 서비스, 라우트, 소비자, 플러그인
│   └── controlPlanes.ts # 제어 평면 관리
└── types.ts           # 일반 타입 정의

시스템 요구 사항

  • Node.js 20 이상
  • API 액세스 권한이 있는 Kong Konnect 계정
  • MCP 기능을 지원하는 클라이언트 (예: Claude Desktop, Cursor 등)

설치 및 구성

1. 클론 및 설치

# 저장소 클론
git clone https://github.com/Kong/mcp-konnect.git
cd mcp-konnect

# 의존성 설치
npm install

# 프로젝트 빌드
npm run build

2. 환경 구성

다음 환경 변수를 설정하여 MCP 서버를 구성합니다.

# 필수: Kong Konnect API 키
export KONNECT_ACCESS_TOKEN=kpat_api_key_here

# 선택 사항: 사용할 API 지역 (기본값: US)
# 가능한 값: US, EU, AU, ME, IN
export KONNECT_REGION=us

사용 가능한 도구

분석 도구

1. API 요청 분석 (analyze-api-requests)

Kong API 게이트웨이 요청을 쿼리하고 분석하며, 사용자 정의 필터를 지원합니다.

입력 매개변수:

  • timeRange: 데이터 검색 시간 범위 (15M, 1H, 6H, 12H, 24H, 7D)
  • statusCodes: 특정 HTTP 상태 코드로 필터링
  • excludeStatusCodes: 특정 HTTP 상태 코드 제외
  • httpMethods: HTTP 메서드로 필터링
  • consumerIds: 소비자 ID로 필터링
  • serviceIds: 서비스 ID로 필터링
  • routeIds: 라우트 ID로 필터링
  • maxResults: 반환할 최대 결과 수
2. 소비자 요청 분석 (analyze-consumer-requests)

특정 소비자가 보낸 API 요청을 분석합니다.

입력 매개변수:

  • consumerId: 분석할 소비자 ID
  • timeRange: 데이터 검색 시간 범위
  • successOnly: 성공적인 (2xx) 요청만 표시
  • failureOnly: 실패한 (비 2xx) 요청만 표시
  • maxResults: 반환할 최대 결과 수

구성 도구

1. 서비스 목록 (list-services)

제어 평면과 연결된 모든 서비스를 나열합니다.

입력 매개변수:

  • controlPlaneId: 제어 평면 ID
  • size: 반환할 서비스 수
  • offset: 페이지네이션 오프셋 토큰
2. 라우트 목록 (list-routes)

제어 평면과 연결된 모든 라우트를 나열합니다.

3. 소비자 목록 (list-consumers)

제어 평면과 연결된 모든 소비자를 나열합니다.

4. 플러그인 목록 (list-plugins)

제어 평면과 연결된 모든 플러그인을 나열합니다.

제어 평면 관리 도구

1. 제어 평면 목록 (list-control-planes)

조직의 모든 제어 평면을 나열합니다.

입력 매개변수:

  • pageSize: 페이지당 제어 평면 수
  • pageNumber: 검색할 페이지 번호
  • filterName: 이름으로 제어 평면 필터링
  • filterClusterType: 클러스터 유형으로 필터링
  • filterCloudGateway: 클라우드 게이트웨이 기능으로 필터링
  • labels: 레이블로 필터링
  • sort: 정렬 필드 및 방향
2. 제어 평면 가져오기 (get-control-plane)

특정 제어 평면의 세부 정보를 가져옵니다.

3. 제어 평면 그룹 구성원 목록 (list-control-plane-group-members)

특정 그룹의 모든 제어 평면 구성원을 나열합니다.

4. 제어 평면 그룹 멤버십 확인 (check-control-plane-group-membership)

제어 평면이 그룹의 구성원인지 확인합니다.

Claude와 통합 사용

1. Claude for Desktop 설치

Claude 공식 웹사이트에서 Claude for Desktop을 다운로드하여 설치합니다.

2. Claude Desktop 구성

Claude Desktop 구성 파일을 생성하거나 편집합니다.

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

3. 구성 추가

{
  "mcpServers": {
    "kong-konnect": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-konnect/build/index.js"
      ],
      "env": {
        "KONNECT_ACCESS_TOKEN": "kpat_api_key_here",
        "KONNECT_REGION": "us"
      }
    }
  }
}

4. Claude for Desktop 재시작

재시작 후 Kong Konnect 도구를 Claude에서 사용할 수 있습니다.

예제 워크플로우

1. 모든 제어 평면 나열

제 Kong Konnect 조직의 모든 제어 평면을 나열해 주세요.

2. 특정 제어 평면의 서비스 나열

제어 평면 [CONTROL_PLANE_NAME/ID]의 모든 서비스를 나열해 주세요.

3. 특정 서비스의 API 요청 쿼리

서비스 [SERVICE_NAME/ID]에서 지난 1시간 동안 5xx 상태 코드를 가진 모든 API 요청을 보여주세요.

4. 제어 평면의 소비자 나열

제어 평면 [CONTROL_PLANE_NAME/ID]의 모든 소비자를 나열해 주세요.

5. 특정 소비자의 요청 분석

소비자 [CONSUMER_NAME/ID]가 지난 24시간 동안 보낸 모든 요청을 보여주세요.

6. 일반적인 오류 또는 패턴 확인

이 소비자가 겪는 가장 흔한 오류는 무엇인가요?

개발 가이드

새로운 도구를 추가하려면 다음 단계를 따르세요.

  1. parameters.ts에서 매개변수 정의
  2. prompts.ts에 문서 추가
  3. operations/의 적절한 파일에 작업 로직 생성
  4. tools.ts에 도구 등록
  5. index.ts에서 도구 실행 처리

문제 해결

연결 오류

  • API 키가 유효하고 필요한 권한이 있는지 확인
  • API 지역이 올바르게 지정되었는지 확인
  • 네트워크가 Kong Konnect API에 연결할 수 있는지 확인

인증 오류

  • Kong Konnect 포털에서 API 키를 다시 생성
  • 환경 변수가 올바르게 설정되었는지 확인

데이터 찾을 수 없음

  • 요청에 사용된 ID가 올바른지 확인
  • 지정된 제어 평면에 리소스가 존재하는지 확인
  • 분석 쿼리의 시간 범위가 유효한지 확인

요약

Kong MCP-Konnect는 AI 어시스턴트와 Kong API 게이트웨이 관리 간의 간극을 메우는 강력한 도구입니다. API 게이트웨이 구성, 트래픽 및 분석 데이터를 쿼리하고 분석하기 위한 자연어 인터페이스를 제공함으로써 API 관리를 더욱 직관적이고 효율적으로 만듭니다. 이 프로젝트는 기본적인 구성 쿼리부터 고급 트래픽 분석에 이르기까지 풍부한 기능 세트를 제공하며, 현대적인 API 인프라 관리의 중요한 도구입니다.

Star History Chart