Elasticsearch MCP 서버

Model Context Protocol(MCP)을 사용하여 모든 MCP 클라이언트(예: Claude Desktop)에서 Elasticsearch 데이터에 직접 연결합니다.

이 서버는 모델 컨텍스트 프로토콜(Model Context Protocol)을 사용하여 에이전트를 Elasticsearch 데이터에 연결합니다. 자연어 대화를 통해 Elasticsearch 인덱스와 상호 작용할 수 있습니다.

사용 가능한 도구

• list_indices : 사용 가능한 모든 Elasticsearch 인덱스를 나열합니다.
• get_mappings : 특정 Elasticsearch 인덱스에 대한 필드 매핑을 가져옵니다.
• search : 제공된 쿼리 DSL로 Elasticsearch 검색을 수행합니다.
• get_shards : 모든 인덱스 또는 특정 인덱스에 대한 샤드 정보를 가져옵니다.

필수 조건

• Elasticsearch 인스턴스
• Elasticsearch 인증 자격 증명(API 키 또는 사용자 이름/비밀번호)
• MCP 클라이언트(예: Claude Desktop)

데모

https://github.com/user-attachments/assets/5dd292e1-a728-4ca7-8f01-1380d1bebe0c

설치 및 설정

게시된 NPM 패키지 사용

[!TIP] Elasticsearch MCP 서버를 사용하는 가장 쉬운 방법은 게시된 npm 패키지를 사용하는 것입니다.

1. MCP 클라이언트 구성
   • MCP 클라이언트를 엽니다. MCP 클라이언트 목록을 확인하세요. 여기서는 Claude Desktop을 구성하고 있습니다.
   • 설정 > 개발자 > MCP 서버 로 이동하세요.
   • Edit Config 클릭하고 다음 구성으로 새 MCP 서버를 추가합니다.

   지엑스피1

2. 대화 시작하기
   • MCP 클라이언트에서 새 대화를 엽니다.
   • MCP 서버는 자동으로 연결되어야 합니다.
   • 이제 Elasticsearch 데이터에 대해 질문할 수 있습니다.

구성 옵션

Elasticsearch MCP 서버는 Elasticsearch에 연결하기 위한 구성 옵션을 지원합니다.

[!NOTE] 인증을 위해서는 API 키 또는 사용자 이름과 비밀번호를 모두 제공해야 합니다.

지역적으로 개발하다

[!NOTE] MCP 서버를 수정하거나 확장하려면 다음 로컬 개발 단계를 따르세요.

1. 올바른 Node.js 버전을 사용하세요
   nvm use
2. 종속성 설치
   npm install
3. 프로젝트 빌드
   npm run build
4. Claude Desktop App에서 로컬로 실행
   • 클로드 데스크톱 앱 열기
   • 설정 > 개발자 > MCP 서버 로 이동하세요.
   • Edit Config 클릭하고 다음 구성으로 새 MCP 서버를 추가합니다.
   { "mcpServers": { "elasticsearch-mcp-server-local": { "command": "node", "args": [ "/path/to/your/project/dist/index.js" ], "env": { "ES_URL": "your-elasticsearch-url", "ES_API_KEY": "your-api-key" } } } }
5. MCP Inspector를 사용한 디버깅
   ES_URL=your-elasticsearch-url ES_API_KEY=your-api-key npm run inspector
   그러면 MCP Inspector가 시작되어 요청을 디버깅하고 분석할 수 있습니다. 다음이 표시됩니다.
   Starting MCP inspector... Proxy server listening on port 3000 🔍 MCP Inspector is up and running at http://localhost:5173 🚀

기여하다

커뮤니티 여러분의 참여를 환영합니다! 참여 방법에 대한 자세한 내용은 '참여 가이드라인'을 참조하세요.

예시 질문

[!TIP] MCP 클라이언트에서 시도할 수 있는 자연어 쿼리는 다음과 같습니다.

• "Elasticsearch 클러스터에는 어떤 인덱스가 있나요?"
• '제품' 인덱스에 대한 필드 매핑을 보여주세요.
• "지난달 500달러 이상 주문한 모든 주문을 찾으세요."
• "어떤 제품이 5점 만점에 가장 많은 리뷰를 받았나요?"

작동 원리

1. MCP 클라이언트는 귀하의 요청을 분석하고 어떤 Elasticsearch 작업이 필요한지 결정합니다.
2. MCP 서버는 다음과 같은 작업(인덱스 나열, 매핑 가져오기, 검색 수행)을 수행합니다.
3. MCP 클라이언트는 결과를 처리하여 사용자 친화적인 형식으로 표시합니다.

보안 모범 사례

[!경고] 클러스터 관리자 권한 사용을 피하세요. 제한된 범위의 전용 API 키를 생성하고 인덱스 수준에서 세분화된 액세스 제어를 적용하여 무단 데이터 액세스를 방지하세요.

최소한의 권한으로 전용 Elasticsearch API 키를 만들어 데이터 액세스를 제어할 수 있습니다.

특허

이 프로젝트는 Apache License 2.0에 따라 라이선스가 부여되었습니다.

문제 해결

• MCP 구성이 올바른지 확인하세요.
• 귀하의 컴퓨터에서 Elasticsearch URL에 접근할 수 있는지 확인하세요.
• 인증 자격 증명(API 키 또는 사용자 이름/비밀번호)에 필요한 권한이 있는지 확인하세요.
• 사용자 지정 CA와 함께 SSL/TLS를 사용하는 경우 인증서 경로가 올바르고 파일을 읽을 수 있는지 확인하세요.
• 오류 메시지는 터미널 출력을 확인하세요.

문제가 발생하면 GitHub 저장소에서 문제를 제기해 주시기 바랍니다.