Couchbase

by aniket310101

5 stars

31 downloads

Not rated

GitHub

About

Interact directly with Couchbase databases on Capella clusters. Query buckets, perform CRUD operations, execute N1QL queries, and manage data seamlessly through natural language.

Details

Author: aniket310101
Repository: Aniket310101/MCP-Server-Couchbase
GitHub stars: 5
Downloads: 31
Categories: Productivity, Developer Tools, Design, Workplace, File Management, AI, Search, Database, Frontend, Project Management, Other

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below
Plugin Name Couchbase

Command (node, npx, python, etc.) npx
Arguments
- Argument 1 -y
- Argument 2 @couchbasedatabase/couchbase-mcp
Environment
- COUCHBASE_URL <COUCHBASE CONNECTION STRING>
- COUCHBASE_BUCKET <BUCKET NAME>
- COUCHBASE_PASSWORD <COUCHBASE PASSWORD>
- COUCHBASE_USERNAME <COUCHBASE USERNAME>
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

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

JSON

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

JSON

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

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

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

JSON

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

JSON

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

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

From the repository

Install via NPX (npx -y @couchbasedatabase/couchbase-mcp) or manually (clone, install, build). Configure Claude Desktop by adding the server with environment variables COUCHBASE_URL, COUCHBASE_BUCKET, COUCHBASE_USERNAME, and COUCHBASE_PASSWORD. Restart Claude Desktop to make the tools available in conversations.

`query`

Execute N1QL queries.

`listBuckets`

List available buckets.

`createScope`

Create a new scope in a bucket.

`deleteScope`

Delete an existing scope.

`listScopes`

List all scopes in a bucket.

`createCollection`

Create a new collection in a scope.

`dropCollection`

Delete a collection from a scope.

`createDocument`

Create a new document.

`getDocument`

Retrieve a document by ID.

`updateDocument`

Update an existing document.

`deleteDocument`

Delete a document by ID.

`bulkCreateDocuments`

Create multiple documents at once.

`createIndex`

Create a new index on specified fields.

`createPrimaryIndex`

Create a primary index on a collection.

`listIndexes`

List all indexes in a bucket.

`dropIndex`

Drop an existing index.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

Linux

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

Macos

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

Windows

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

🗄️ Couchbase MCP Server for LLMs

A Model Context Protocol (MCP) server that enables LLMs to interact directly with Couchbase databases on Capella clusters. Query buckets, perform CRUD operations, execute N1QL queries, and manage data seamlessly through natural language.

🚀 Quick Start

1. Prerequisites

- Node.js 16 or higher
- A running Couchbase instance on Capella
- Claude Desktop application

2. Installation

Couchbase MCP Server can be installed in two ways:

### Option 1: Using NPX (Recommended)

The quickest way to get started is using NPX:

   npx -y @couchbasedatabase/couchbase-mcp

### Option 2: Manual Installation

If you prefer to clone and run the project 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

3. Claude Desktop Integration

Add this configuration to your Claude Desktop config file:

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

### Option 1: With 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: With 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>"
         }
       }
     }
   }

4. Verify Connection

- Restart Claude Desktop
- The Couchbase MCP server tools should now be available in your conversations

📝 Available Tools

Basic Operations

- query: Execute N1QL queries
- listBuckets: List available buckets

Scope Management

- createScope: Create a new scope in a bucket
- deleteScope: Delete an existing scope
- listScopes: List all scopes in a bucket

Collection Management

- createCollection: Create a new collection in a scope
- dropCollection: Delete a collection from a scope

Document Operations

- createDocument: Create a new document
- getDocument: Retrieve a document by ID
- updateDocument: Update an existing document
- deleteDocument: Delete a document by ID
- bulkCreateDocuments: Create multiple documents at once

Index Management

- createIndex: Create a new index on specified fields
- createPrimaryIndex: Create a primary index on a collection
- listIndexes: List all indexes in a bucket
- dropIndex: Drop an existing index

Each tool supports optional collection and scope parameters for targeting specific data containers.

🔒 Security Considerations

- Always use environment variables for sensitive credentials
- Consider running the server behind a reverse proxy for production use
- Implement appropriate access controls and authentication as needed

📚 Examples

Here are some example interactions with Claude using the MCP server:

1. List all buckets:

   Could you show me all available buckets in the database?

2. Create a scope and collection:

   Create a new scope called "users" and a collection called "profiles" in it

3. Query documents:

   Find all users who signed up in the last 30 days

4. Create a document:

   Create a new user document with name "John Doe" and email "john@example.com"

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

🛡️ Security Assessment Badge (MseeP.ai)

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

query

listBuckets

createScope

deleteScope

listScopes

createCollection

dropCollection

createDocument

getDocument

updateDocument

deleteDocument

bulkCreateDocuments

createIndex

createPrimaryIndex

listIndexes

dropIndex

Claude Desktop / Cursor

Linux

Macos

Windows

🗄️ Couchbase MCP Server for LLMs

🚀 Quick Start

📝 Available Tools

Basic Operations

Scope Management

Collection Management

Document Operations

Index Management

🔒 Security Considerations

📚 Examples

🤝 Contribution

🛡️ Security Assessment Badge (MseeP.ai)

Install

More like this

Time

Sentry

Github

Git

GitLab

Context 7

`query`

`listBuckets`

`createScope`

`deleteScope`

`listScopes`

`createCollection`

`dropCollection`

`createDocument`

`getDocument`

`updateDocument`

`deleteDocument`

`bulkCreateDocuments`

`createIndex`

`createPrimaryIndex`

`listIndexes`

`dropIndex`