MCP Server Couchbase

🚀 Couchbase MCP Server for LLMs

A Model Context Protocol (MCP) server that enables LLMs to directly interact with a Couchbase database on a Capella cluster. Querying buckets, performing CRUD operations, running N1QL queries, and managing data can be achieved through natural language.

🚀 Quick Start

Prerequisites

• Node.js version 16 or higher.
• A running Couchbase instance (Capella-based).
• Claude Desktop application.

Installation

There are two ways to install the Couchbase MCP server:

Option 1: Using NPX (Recommended)

The quickest way is to install via NPX:

npx -y @couchbasedatabase/couchbase-mcp

Option 2: Manual Installation

If you prefer to clone the project and run it manually:

# 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

Claude Desktop Integration

Add the following configuration to your Claude Desktop configuration file:

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

Option 1: Using Package Installation

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

Option 2: Using Manual Installation

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

Verify the Connection

• Restart the Claude Desktop.
• Now, the Couchbase MCP server should be successfully integrated.

✨ Features

Here are some operations you can perform:

• list buckets: List all buckets.
• describe bucket <name>: Describe the details of a specified bucket.
• create bucket <name> <type>: Create a new bucket.
• delete bucket <name>: Delete a specified bucket.
• query <sql-query>: Execute an N1QL query.

🔧 Technical Details

Security Considerations

• Environment Variables: Sensitive information such as passwords should be provided via environment variables rather than hard-coded.
• Reverse Proxy: In a production environment, it is recommended to use a reverse proxy (e.g., Nginx) to handle HTTPS requests and restrict access to the MCP server.

💻 Usage Examples

Here are some usage examples:

# List all buckets
list buckets

# Describe a specified bucket
describe bucket my_bucket

# Create a new bucket
create bucket my_new_bucket Couchbase

# Delete a bucket
delete bucket old_bucket

# Execute an N1QL query
query SELECT * FROM my_bucket LIMIT 10

🤝 Contribution

We welcome contributions from the community! If you find any issues or have any suggestions for improvement, please visit our GitHub repository: MCP-Server-Couchbase.

Thank you for your support and help in making this project even better!