Couchbase MCP Server for LLMs

by Aniket310101
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Supports configuration through environment variables in a .env file, enabling secure storage of Couchbase credentials.

  • Enables interaction with Couchbase databases, allowing querying buckets, performing CRUD operations on documents, managing scopes and collections, executing N1QL queries, and handling index operations.

  • Uses Git for version control and installation through the git clone command.

🗄️ LLM을 위한 Couchbase MCP 서버

LLM이 Capella 클러스터에서 Couchbase 데이터베이스와 직접 상호 작용할 수 있도록 하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 버킷 쿼리, CRUD 작업 수행, N1QL 쿼리 실행, 자연어를 통한 원활한 데이터 관리가 가능합니다.

🚀 빠른 시작

  1. 필수 조건
    • Node.js 16 이상
    • Capella에서 실행 중인 Couchbase 인스턴스
    • 클로드 데스크톱 애플리케이션
  2. 설치Couchbase MCP 서버는 두 가지 방법으로 설치할 수 있습니다.

옵션 1: NPX 사용(권장)

가장 빠르게 시작하는 방법은 NPX를 사용하는 것입니다.

지엑스피1

옵션 2: 수동 설치

프로젝트를 수동으로 복제하고 실행하려면 다음을 수행하세요.

# Clone the repository git clone https://github.com/Aniket310101/MCP-Server-Couchbase.git cd MCP-Server-Couchbase # Install dependencies npm install # Build the project npm run build
  1. Claude 데스크톱 통합Claude Desktop 구성 파일에 다음 구성을 추가하세요.윈도우 : %APPDATA%/Claude/claude_desktop_config.json
    MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json

옵션 1: 패키지 설치 포함

{ "mcpServers": { "couchbase": { "command": "npx", "args": ["-y", "@couchbasedatabase/couchbase-mcp"], "env": { "COUCHBASE_URL": "<COUCHBASE CONNECTION STRING>", "COUCHBASE_BUCKET": "<BUCKET NAME>", "COUCHBASE_USERNAME": "<COUCHBASE USERNAME>", "COUCHBASE_PASSWORD": "<COUCHBASE PASSWORD>" } } } }

옵션 2: 수동 설치

{ "mcpServers": { "couchbase": { "command": "node", "args": ["path/to/MCP-Server-Couchbase/dist/index.js"], "env": { "COUCHBASE_URL": "<COUCHBASE CONNECTION STRING>", "COUCHBASE_BUCKET": "<BUCKET NAME>", "COUCHBASE_USERNAME": "<COUCHBASE USERNAME>", "COUCHBASE_PASSWORD": "<COUCHBASE PASSWORD>" } } } }
  1. 연결 확인
    • Claude Desktop을 다시 시작하세요
    • 이제 Couchbase MCP 서버 도구를 대화에서 사용할 수 있습니다.

📝 사용 가능한 도구

기본 작업

  • query : N1QL 쿼리 실행
  • listBuckets : 사용 가능한 버킷을 나열합니다.

범위 관리

  • createScope : 버킷에 새로운 범위를 생성합니다.
  • deleteScope : 기존 범위 삭제
  • listScopes : 버킷의 모든 범위를 나열합니다.

컬렉션 관리

  • createCollection : 범위 내에 새 컬렉션을 만듭니다.
  • dropCollection : 범위에서 컬렉션을 삭제합니다.

문서 작업

  • createDocument : 새 문서를 만듭니다
  • getDocument : ID로 문서 검색
  • updateDocument : 기존 문서 업데이트
  • deleteDocument : ID로 문서 삭제
  • bulkCreateDocuments : 여러 문서를 한 번에 만듭니다.

인덱스 관리

  • createIndex : 지정된 필드에 새 인덱스를 생성합니다.
  • createPrimaryIndex : 컬렉션에 기본 인덱스를 생성합니다.
  • listIndexes : 버킷의 모든 인덱스를 나열합니다.
  • dropIndex : 기존 인덱스 삭제

각 도구는 특정 데이터 컨테이너를 타겟팅하기 위한 선택적 collectionscope 매개변수를 지원합니다.

🔒 보안 고려 사항

  • 항상 중요한 자격 증명에 환경 변수를 사용하세요
  • 프로덕션 사용을 위해 역방향 프록시 뒤에서 서버를 실행하는 것을 고려하세요.
  • 필요에 따라 적절한 액세스 제어 및 인증을 구현합니다.

📚 예시

다음은 MCP 서버를 사용하여 Claude와 상호작용하는 몇 가지 예입니다.

  1. 모든 버킷을 나열하세요:
    Could you show me all available buckets in the database?
  2. 범위와 컬렉션을 만듭니다.
    Create a new scope called "users" and a collection called "profiles" in it
  3. 쿼리 문서:
    Find all users who signed up in the last 30 days
  4. 문서 만들기:
    Create a new user document with name "John Doe" and email "john@example.com"

🤝 기여

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요.

-
security - not tested
F
license - not found
-
quality - not tested

자연어를 통해 대규모 언어 모델이 Couchbase 데이터베이스와 직접 상호 작용할 수 있도록 하는 모델 컨텍스트 프로토콜 서버로, 버킷 쿼리, CRUD 작업 수행, N1QL 쿼리 실행과 같은 작업을 지원합니다.

  1. 🚀 Quick Start
    1. Option 1: Using NPX (Recommended)
    2. Option 2: Manual Installation
    3. Option 1: With Package Installation
    4. Option 2: With Manual Installation
  2. 📝 Available Tools
    1. Basic Operations
    2. Scope Management
    3. Collection Management
    4. Document Operations
    5. Index Management
  3. 🔒 Security Considerations
    1. 📚 Examples
      1. 🤝 Contribution
        ID: 6dmabx5n90