mcp-confluent

mcp-confluent

AI 어시스턴트가 Confluent Cloud REST API와 상호 작용할 수 있도록 하는 MCP 서버 구현입니다. 이 서버를 통해 Claude Desktop 및 Goose CLI와 같은 AI 도구가 자연어 상호 작용을 통해 Kafka 토픽, 커넥터 및 Flink SQL 문을 관리할 수 있습니다.

데모

구스 CLI

클로드 데스크탑

목차

• mcp-confluent
  • 데모
    • 구스 CLI
    • 클로드 데스크탑
  • 목차
  • 사용자 가이드
    • 시작하기
    • 구성
    • 환경 변수 참조
    • 용법
    • Claude Desktop 구성
    • Goose CLI 구성
  • 개발자 가이드
    • 프로젝트 구조
    • 건물과 운영
    • 테스트
      • MCP 검사관
    • 새 도구 추가
    • 유형 생성
    • 기여하다

사용자 가이드

시작하기

1. .env 파일을 만듭니다. 아래에 표시된 예제 .env 파일 구조를 프로젝트 루트에 있는 .env 라는 새 파일에 복사합니다.
2. .env 파일을 채웁니다. Confluent Cloud 환경에 필요한 값을 입력합니다. 각 변수에 대한 자세한 내용은 구성 섹션을 참조하세요.
3. Node.js를 설치하세요 (아직 설치되지 않은 경우)
   • Node.js 버전을 관리하려면 NVM (Node Version Manager)을 사용하는 것이 좋습니다.
   • Node.js를 설치하고 사용하세요.

   지엑스피1

구성

다음 구성으로 프로젝트의 루트 디렉토리에 .env 파일을 만듭니다.

환경 변수 참조

용법

이 MCP 서버는 Claude Desktop이나 Goose CLI/Desktop 등 다양한 MCP 클라이언트와 함께 사용하도록 설계되었습니다. 구체적인 구성 및 상호작용은 사용 중인 클라이언트에 따라 다릅니다. 일반적인 단계는 다음과 같습니다.

1. 빌드: 개발자 가이드 의 지침에 따라 소스에서 서버를 빌드하고 실행하세요. 일반적으로 다음이 포함됩니다.
   • 종속성 설치( npm install )
   • 프로젝트 빌드( npm run build 또는 npm run dev )
2. MCP 클라이언트 구성: 각 클라이언트는 MCP 서버 주소와 필요한 자격 증명을 지정하는 고유한 방식을 가지고 있습니다. 클라이언트(예: Claude, Goose)가 해당 서버가 실행 중인 주소(특정 포트를 사용하는 localhost 등)에 연결되도록 구성해야 합니다. 서버가 실행되는 포트는 환경 변수를 통해 설정할 수 있습니다.
3. MCP 클라이언트 시작: 클라이언트가 MCP 서버에 연결되도록 구성되면 MCP 클라이언트를 시작할 수 있습니다. 시작 시 로컬에 이 MCP 서버 인스턴스가 생성됩니다. 이 인스턴스는 데이터 스키마를 관리하고 사용자를 대신하여 Confluent Cloud와 상호 작용하는 역할을 합니다.
4. 클라이언트를 통해 Confluent와 상호 작용: 클라이언트가 연결되면 클라이언트 인터페이스를 사용하여 Confluent Cloud 리소스와 상호 작용할 수 있습니다. 클라이언트가 이 MCP 서버로 요청을 보내면 MCP 서버가 사용자를 대신하여 Confluent Cloud와 상호 작용합니다.

Claude Desktop 구성

Claude Desktop 및 MCP 서버 설치에 대한 자세한 내용은 여기를 참조하세요.

이 MCP 서버를 사용하도록 Claude Desktop을 구성하려면:

1. Open Claude Desktop 구성
   • Mac의 경우: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows의 경우: %APPDATA%\Claude\claude_desktop_config.json
2. 구성 파일 편집
   • 원하는 텍스트 편집기에서 구성 파일을 엽니다.
   • 다음 방법 중 하나를 사용하여 구성을 추가하거나 수정하세요.
   { "mcpServers": { "confluent": { "command": "node", "args": [ "/path/to/confluent-mcp-server/dist/index.js", "--env-file", "/path/to/confluent-mcp-server/.env", ] } } }
   { "mcpServers": { "confluent": { "command": "npx", "args": [ "-y" "@confluentinc/mcp-confluent", "-e", "/path/to/confluent-mcp-server/.env" ] } } }

   /path/to/confluent-mcp-server/ 이 MCP 서버를 설치한 실제 경로로 바꾸세요.

3. Claude Desktop을 다시 시작하세요
   • 변경 사항을 적용하려면 Claude Desktop을 닫았다가 다시 여세요.
   • Claude Desktop이 실행되면 MCP 서버가 자동으로 시작됩니다.

이제 Claude Desktop은 Confluent 상호 작용을 위해 로컬 MCP 서버를 사용하도록 구성됩니다.

Goose CLI 구성

Goose CLI를 설치하는 방법에 대한 자세한 지침은 여기를 참조하세요.

설치가 완료되면 다음 단계를 따르세요.

1. 구성 명령을 실행합니다.
   goose configure
2. 대화형 프롬프트를 따르세요:
   • Add extension 선택하세요
   • Command-line Extension 선택
   • 확장자 이름으로 mcp-confluent 입력하세요.
   • 다음 구성 방법 중 하나를 선택하세요.
   node /path/to/confluent-mcp-server/dist/index.js --env-file /path/to/confluent-mcp-server/.env
   npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

/path/to/confluent-mcp-server/ 이 MCP 서버를 설치한 실제 경로로 바꾸세요.

개발자 가이드

프로젝트 구조

건물과 운영

1. 종속성 설치:
   npm install
2. 개발 모드(변경 사항을 살펴보세요):
   npm run dev
   이 명령은 TypeScript 코드를 JavaScript로 컴파일하고 src/ 디렉토리에서 변경 사항이 감지되면 자동으로 다시 빌드합니다.
3. 프로덕션 빌드(일회성 컴파일):
   npm run build
4. 서버를 시작합니다:
   npm run start

테스트

MCP 검사관

MCP 서버를 테스트하려면 MCP 서버를 테스트하고 디버깅하는 대화형 개발자 도구인 MCP Inspector를 사용할 수 있습니다.

새 도구 추가

1. 열거형 클래스 ToolName 에 새로운 열거형을 추가합니다.
2. ToolFactory 클래스의 핸들러 맵에 새 도구를 추가합니다.
3. BaseToolHandler 확장하는 클래스를 내보내는 새 파일을 만듭니다.
   1. 기본 클래스의 handle 메서드를 구현합니다.
   2. 기본 클래스의 getToolConfig 메서드를 구현합니다.
4. 만족스러우면 index.ts 의 enabledTools 세트에 추가합니다.

유형 생성

기여하다

Github Issues 형식으로 버그 리포트와 피드백을 보내주시면 감사하겠습니다. 기여 관련 지침은 CONTRIBUTING.md를 참조하세요.