Couchbase MCP Server

An MCP server implementation of Couchbase that allows LLMs to directly interact with Couchbase clusters.

Features/Tools

Cluster setup & health tools

Tool Name	Description
`get_server_configuration_status`	Get the status of the MCP server
`test_cluster_connection`	Check the cluster credentials by connecting to the cluster
`get_cluster_health_and_services`	Get cluster health status and list of all running services

Data model & schema discovery tools

Tool Name	Description
`get_buckets_in_cluster`	Get a list of all the buckets in the cluster
`get_scopes_in_bucket`	Get a list of all the scopes in the specified bucket
`get_collections_in_scope`	Get a list of all the collections in a specified scope and bucket. Note that this tool requires the cluster to have Query service.
`get_scopes_and_collections_in_bucket`	Get a list of all the scopes and collections in the specified bucket
`get_schema_for_collection`	Get the structure for a collection

Document KV operations tools

Tool Name	Description
`get_document_by_id`	Get a document by ID from a specified scope and collection
`upsert_document_by_id`	Upsert a document by ID to a specified scope and collection. Disabled by default when `CB_MCP_READ_ONLY_MODE=true`.
`insert_document_by_id`	Insert a new document by ID (fails if document exists). Disabled by default when `CB_MCP_READ_ONLY_MODE=true`.
`replace_document_by_id`	Replace an existing document by ID (fails if document doesn't exist). Disabled by default when `CB_MCP_READ_ONLY_MODE=true`.
`delete_document_by_id`	Delete a document by ID from a specified scope and collection. Disabled by default when `CB_MCP_READ_ONLY_MODE=true`.

Query and indexing tools

Tool Name	Description
`list_indexes`	List all indexes in the cluster with their definitions, with optional filtering by bucket, scope, collection and index name.
`get_index_advisor_recommendations`	Get index recommendations from Couchbase Index Advisor for a given SQL++ query to optimize query performance
`run_sql_plus_plus_query`	Run a SQL++ query on a specified scope.Queries are automatically scoped to the specified bucket and scope, so use collection names directly (e.g., `SELECT * FROM users` instead of `SELECT * FROM bucket.scope.users`).`CB_MCP_READ_ONLY_MODE` is `true` by default, which means that all write operations (KV and Query) are disabled. When enabled, KV write tools are not loaded and SQL++ queries that modify data are blocked.

Query performance analysis tools

Tool Name	Description
`get_longest_running_queries`	Get longest running queries by average service time
`get_most_frequent_queries`	Get most frequently executed queries
`get_queries_with_largest_response_sizes`	Get queries with the largest response sizes
`get_queries_with_large_result_count`	Get queries with the largest result counts
`get_queries_using_primary_index`	Get queries that use a primary index (potential performance concern)
`get_queries_not_using_covering_index`	Get queries that don't use a covering index
`get_queries_not_selective`	Get queries that are not selective (index scans return many more documents than final result)

Prerequisites

Python 3.10 or higher.
A running Couchbase cluster. The easiest way to get started is to use Capella free tier, which is fully managed version of Couchbase server. You can follow instructions to import one of the sample datasets or import your own.
uv installed to run the server.
An MCP client such as Claude Desktop installed to connect the server to Claude. The instructions are provided for Claude Desktop and Cursor. Other MCP clients could be used as well.

Configuration

The MCP server can be run either from the prebuilt PyPI package or the source using uv.

Running from PyPI

We publish a pre built PyPI package for the MCP server.

Server Configuration using Pre built Package for MCP Clients

Basic Authentication

json

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password"
      }
    }
  }
}

mTLS

json

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_CLIENT_CERT_PATH": "/path/to/client-certificate.pem",
        "CB_CLIENT_KEY_PATH": "/path/to/client.key"
      }
    }
  }
}

Note: If you have other MCP servers in use in the client, you can add it to the existing mcpServers object.

Running from Source

The MCP server can be run from the source using this repository.

Clone the repository to your local machine.

bash

git clone https://github.com/Couchbase-Ecosystem/mcp-server-couchbase.git

Server Configuration using Source for MCP Clients

This is the common configuration for the MCP clients such as Claude Desktop, Cursor, Windsurf Editor.

json

{
  "mcpServers": {
    "couchbase": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/cloned/repo/mcp-server-couchbase/",
        "run",
        "src/mcp_server.py"
      ],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password"
      }
    }
  }
}

Note: path/to/cloned/repo/mcp-server-couchbase/ should be the path to the cloned repository on your local machine. Don't forget the trailing slash at the end!

Note: If you have other MCP servers in use in the client, you can add it to the existing mcpServers object.

Additional Configuration for MCP Server

The server can be configured using environment variables or command line arguments:

Environment Variable	CLI Argument	Description	Default
`CB_CONNECTION_STRING`	`--connection-string`	Connection string to the Couchbase cluster	Required
`CB_USERNAME`	`--username`	Username with access to required buckets for basic authentication	Required (or Client Certificate and Key needed for mTLS)
`CB_PASSWORD`	`--password`	Password for basic authentication	Required (or Client Certificate and Key needed for mTLS)
`CB_CLIENT_CERT_PATH`	`--client-cert-path`	Path to the client certificate file for mTLS authentication	Required if using mTLS (or Username and Password required)
`CB_CLIENT_KEY_PATH`	`--client-key-path`	Path to the client key file for mTLS authentication	Required if using mTLS (or Username and Password required)
`CB_CA_CERT_PATH`	`--ca-cert-path`	Path to server root certificate for TLS if server is configured with a self-signed/untrusted certificate. This will not be required if you are connecting to Capella
`CB_MCP_READ_ONLY_MODE`	`--read-only-mode`	Prevent all data modifications (KV and Query). When enabled, KV write tools are not loaded.	`true`
`CB_MCP_READ_ONLY_QUERY_MODE`	`--read-only-query-mode`	[DEPRECATED] Prevent queries that modify data. Note that data modification would still be possible via document operations tools. Use `CB_MCP_READ_ONLY_MODE` instead.	`true`
`CB_MCP_TRANSPORT`	`--transport`	Transport mode: `stdio`, `http`, `sse`	`stdio`
`CB_MCP_HOST`	`--host`	Host for HTTP/SSE transport modes	`127.0.0.1`
`CB_MCP_PORT`	`--port`	Port for HTTP/SSE transport modes	`8000`
`CB_MCP_DISABLED_TOOLS`	`--disabled-tools`	Tools to disable (see Disabling Tools)	None

Read-Only Mode Configuration

The MCP server provides two configuration options for controlling write operations:

**CB_MCP_READ_ONLY_MODE** (Recommended)

When true (default): All write operations are disabled. KV write tools (upsert, insert, replace, delete) are not loaded and will not be available to the LLM.
When false: KV write tools are loaded and available.

**CB_MCP_READ_ONLY_QUERY_MODE** (Deprecated)

This option only controls SQL++ query-based writes but does not prevent KV write operations.
Deprecated: Use CB_MCP_READ_ONLY_MODE instead for comprehensive protection.

Mode Behavior Truth Table:

`READ_ONLY_MODE`	`READ_ONLY_QUERY_MODE`	Result
`true`	`true`	Read-only KV and Query operations. All writes disabled.
`true`	`false`	Read-only KV and Query operations. All writes disabled.
`false`	`true`	Only Query writes disabled. KV writes allowed.
`false`	`false`	All KV and Query operations allowed.

Important: When READ_ONLY_MODE is true, it takes precedence and disables all write operations regardless of READ_ONLY_QUERY_MODE setting. This is the recommended safe default to prevent inadvertent data modifications by LLMs.

Note: For authentication, you need either the Username and Password or the Client Certificate and key paths. Optionally, you can specify the CA root certificate path that will be used to validate the server certificates.
If both the Client Certificate & key path and the username and password are specified, the client certificates will be used for authentication.

Disabling Tools

You can disable specific tools to prevent them from being loaded and exposed to the MCP client. Disabled tools will not appear in the tool discovery and cannot be invoked by the LLM.

Supported Formats

Comma-separated list:

bash

# Environment variable
CB_MCP_DISABLED_TOOLS="upsert_document_by_id, delete_document_by_id"

# Command line
uvx couchbase-mcp-server --disabled-tools upsert_document_by_id, delete_document_by_id

File path (one tool name per line):

bash

# Environment variable
CB_MCP_DISABLED_TOOLS=disabled_tools.txt

# Command line
uvx couchbase-mcp-server --disabled-tools disabled_tools.txt

**File format (e.g., disabled_tools.txt):**

text

# Write operations
upsert_document_by_id
delete_document_by_id

# Index advisor
get_index_advisor_recommendations

Lines starting with # are treated as comments and ignored.

MCP Client Configuration Examples

Using comma-separated list:

json

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password",
        "CB_MCP_DISABLED_TOOLS": "upsert_document_by_id,delete_document_by_id"
      }
    }
  }
}

Using file path (recommended for many tools):

json

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password",
        "CB_MCP_DISABLED_TOOLS": "/path/to/disabled_tools.txt"
      }
    }
  }
}

Important Security Note

Warning: Disabling tools alone does not guarantee that certain operations cannot be performed. The underlying database user's RBAC (Role-Based Access Control) permissions are the authoritative security control.
For example, even if you disable upsert_document_by_id and delete_document_by_id, data modifications can still occur via the run_sql_plus_plus_query tool using SQL++ DML statements (INSERT, UPDATE, DELETE, MERGE) unless:
- The CB_MCP_READ_ONLY_MODE is set to true (default), OR
- The database user lacks the necessary RBAC permissions for data modification
Best Practice: Always configure appropriate RBAC permissions on your Couchbase user credentials as the primary security measure. Use tool disabling as an additional layer to guide LLM behavior and reduce the attack surface, not as the sole security control.

You can also check the version of the server using:

bash

uvx couchbase-mcp-server --version

Client Specific Configuration

Claude Desktop

Follow the steps below to use Couchbase MCP server with Claude Desktop MCP client

1. The MCP server can now be added to Claude Desktop by editing the configuration file. More detailed instructions can be found on the MCP quickstart guide.

On Mac, the configuration file is located at ~/Library/Application Support/Claude/claude_desktop_config.json
On Windows, the configuration file is located at %APPDATA%\Claude\claude_desktop_config.json

Open the configuration file and add the configuration to the mcpServers section.

2. Restart Claude Desktop to apply the changes.

3. You can now use the server in Claude Desktop to run queries on the Couchbase cluster using natural language and perform CRUD operations on documents.

Logs

The logs for Claude Desktop can be found in the following locations:

MacOS: ~/Library/Logs/Claude
Windows: %APPDATA%\Claude\Logs

The logs can be used to diagnose connection issues or other problems with your MCP server configuration. For more details, refer to the official documentation.

Cursor

Follow steps below to use Couchbase MCP server with Cursor:

1. Install Cursor on your machine.

2. In Cursor, go to Cursor > Cursor Settings > Tools & Integrations > MCP Tools. Also, checkout the docs on setting up MCP server configuration from Cursor.

3. Specify the same configuration. You may need to add the server configuration under a parent key of mcpServers.

4. Save the configuration.

5. You will see couchbase as an added server in MCP servers list. Refresh to see if server is enabled.

6. You can now use the Couchbase MCP server in Cursor to query your Couchbase cluster using natural language and perform CRUD operations on documents.

For more details about MCP integration with Cursor, refer to the official Cursor MCP documentation.

Logs

In the bottom panel of Cursor, click on "Output" and select "Cursor MCP" from the dropdown menu to view server logs. This can help diagnose connection issues or other problems with your MCP server configuration.

Windsurf Editor

Follow the steps below to use the Couchbase MCP server with Windsurf Editor.

1. Install Windsurf Editor on your machine.

2. In Windsurf Editor, navigate to Command Palette > Windsurf MCP Configuration Panel or Windsurf - Settings > Advanced > Cascade > Model Context Protocol (MCP) Servers. For more details on the configuration, please refer to the official documentation.

3. Click on Add Server and then Add custom server. On the configuration that opens in the editor, add the Couchbase MCP Server configuration from above.

4. Save the configuration.

5. You will see couchbase as an added server in MCP Servers list under Advanced Settings. Refresh to see if server is enabled.

6. You can now use the Couchbase MCP server in Windsurf Editor to query your Couchbase cluster using natural language and perform CRUD operations on documents.

For more details about MCP integration with Windsurf Editor, refer to the official Windsurf MCP documentation.

VS Code

Follow the steps below to use the Couchbase MCP server with VS Code.

1. Install VS Code

2. Following are a couple of ways to configure the MCP server.

For a Workspace server configuration
Create a new file in workspace as .vscode/mcp.json.
Add the configuration and save the file.
For the Global server configuration:
Run MCP: Open User Configuration in the Command Pallete(Ctrl+Shift+P or Cmd+Shift+P)
Add the configuration and save the file.
Note: VS Code uses servers as the top-level JSON property in mcp.json files to define MCP (Model Context Protocol) servers, while Cursor uses mcpServers for the equivalent configuration. Check the VS Code client configurations for any further changes or details. An example VS Code configuration is provided below.

json

{
          "servers": {
            "couchbase": {
              "command": "uvx",
              "args": ["couchbase-mcp-server"],
              "env": {
                "CB_CONNECTION_STRING": "couchbases://connection-string",
                "CB_USERNAME": "username",
                "CB_PASSWORD": "password"
              }
            }
          }
        }

3. Once you save the file, the server starts and a small action list appears with Running|Stop|n Tools|More...

4. Click on the options from the option list to Start/Stop/manage the server.

5. You can now use the Couchbase MCP server in VS Code to query your Couchbase cluster using natural language and perform CRUD operations on documents.

Logs:

In the Command Palette (Ctrl+Shift+P or Cmd+Shift+P),

run MCP: List Servers command and pick the couchbase server
choose “Show Output” to see its logs in the Output tab.

JetBrains IDEs

Follow the steps below to use the Couchbase MCP server with JetBrains IDEs

1. Install any one of the JetBrains IDEs

2. Install any one of the JetBrains plugins - AI Assistant or Junie

3. Navigate to Settings > Tools > AI Assistant or Junie > MCP Server

4. Click "+" to add the Couchbase MCP configuration and click Save.

5. You will see the Couchbase MCP server added to the list of servers. Once you click Apply, the Couchbase MCP server starts and on-hover of status, it shows all the tools available.

6. You can now use the Couchbase MCP server in JetBrains IDEs to query your Couchbase cluster using natural language and perform CRUD operations on documents.

Logs:

The log file can be explored at Help > Show Log in Finder (Explorer) > mcp > couchbase

Streamable HTTP Transport Mode

The MCP Server can be run in Streamable HTTP transport mode which allows multiple clients to connect to the same server instance via HTTP.

Check if your MCP client supports streamable http transport before attempting to connect to MCP server in this mode.

Note: This mode does not include authorization support.

Usage

By default, the MCP server will run on port 8000 but this can be configured using the --port or CB_MCP_PORT environment variable.

bash

uvx couchbase-mcp-server \
  --connection-string='' \
  --username='' \
  --password='' \
  --read-only-mode=true \
  --transport=http

The server will be available on http://localhost:8000/mcp. This can be used in MCP clients supporting streamable http transport mode such as Cursor.

MCP Client Configuration

json

{
  "mcpServers": {
    "couchbase-http": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

SSE Transport Mode

There is an option to run the MCP server in Server-Sent Events (SSE) transport mode.

Note: SSE mode has been deprecated by MCP. We have support for Streamable HTTP.

Usage

By default, the MCP server will run on port 8000 but this can be configured using the --port or CB_MCP_PORT environment variable.

bash

uvx couchbase-mcp-server \
  --connection-string='' \
  --username='' \
  --password='' \
  --read-only-mode=true \
  --transport=sse

The server will be available on http://localhost:8000/sse. This can be used in MCP clients supporting SSE transport mode such as Cursor.

MCP Client Configuration

json

{
  "mcpServers": {
    "couchbase-sse": {
      "url": "http://localhost:8000/sse"
    }
  }
}

Docker Image

The MCP server can also be built and run as a Docker container. Prebuilt images can be found on DockerHub or pulled via docker pull couchbase.docker.scarf.sh/couchbaseecosystem/mcp-server-couchbase.

Alternatively, we are part of the Docker MCP Catalog.

Building Image

bash

docker build -t mcp/couchbase .

Building with Arguments

If you want to build with the build arguments for commit hash and the build time, you can build using:

bash

docker build --build-arg GIT_COMMIT_HASH=$(git rev-parse HEAD) \
  --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') \
  -t mcp/couchbase .

Alternatively, use the provided build script:

bash

./build.sh

This script automatically:

Generates git commit hash and build timestamp
Creates multiple useful tags (latest, ``)
Shows build information and results
Uses the same arguments as CI/CD builds

Verify image labels:

bash

# View git commit hash in image
docker inspect --format='{{index .Config.Labels "org.opencontainers.image.revision"}}' mcp/couchbase:latest

# View all metadata labels
docker inspect --format='{{json .Config.Labels}}' mcp/couchbase:latest

Running

The MCP server can be run with the environment variables being used to configure the Couchbase settings. The environment variables are the same as described in the Configuration section.

Independent Docker Container

bash

docker run --rm -i \
  -e CB_CONNECTION_STRING='' \
  -e CB_USERNAME='' \
  -e CB_PASSWORD='' \
  -e CB_MCP_TRANSPORT='' \
  -e CB_MCP_READ_ONLY_QUERY_MODE='' \
  -e CB_MCP_PORT=9001 \
  -p 9001:9001 \
  mcp/couchbase

The CB_MCP_PORT environment variable is only applicable in the case of HTTP transport modes like http and sse.

MCP Client Configuration

The Docker image can be used in stdio transport mode with the following configuration.

json

{
  "mcpServers": {
    "couchbase-mcp-docker": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CB_CONNECTION_STRING=",
        "-e",
        "CB_USERNAME=",
        "-e",
        "CB_PASSWORD=",
        "mcp/couchbase"
      ]
    }
  }
}

Notes

The couchbase_connection_string value depends on whether the Couchbase server is running on the same host machine, in another Docker container, or on a remote host. If your Couchbase server is running on your host machine, your connection string would likely be of the form couchbase://host.docker.internal. For details refer to the docker documentation.
You can specify the container's networking using the --network= option. The network you choose depends on your environment; the default is bridge. For details, refer to network drivers in docker.

Risks Associated with LLMs

The use of large language models and similar technology involves risks, including the potential for inaccurate or harmful outputs.
Couchbase does not review or evaluate the quality or accuracy of such outputs, and such outputs may not reflect Couchbase's views.
You are solely responsible for determining whether to use large language models and related technology, and for complying with any license terms, terms of use, and your organization's policies governing your use of the same.

Managed MCP Server

The Couchbase MCP server can also be used as a managed server in your agentic applications via Smithery.ai.

Troubleshooting Tips

Ensure the path to your MCP server repository is correct in the configuration if running from source.
Verify that your Couchbase connection string, database username, password or the path to the certificates are correct.
If using Couchbase Capella, ensure that the cluster is accessible from the machine where the MCP server is running.
Check that the database user has proper permissions to access at least one bucket.
Confirm that the uv package manager is properly installed and accessible. You may need to provide absolute path to uv/uvx in the command field in the configuration.
Check the logs for any errors or warnings that may indicate issues with the MCP server. The location of the logs depend on your MCP client.
If you are observing issues running your MCP server from source after updating your local MCP server repository, try running uv sync to update the dependencies.

Integration testing

We provide high-level MCP integration tests to verify that the server exposes the expected tools and that they can be invoked against a demo Couchbase cluster.

1. Export demo cluster credentials:

CB_CONNECTION_STRING
CB_USERNAME
CB_PASSWORD
Optional: CB_MCP_TEST_BUCKET (a bucket to probe during the tests)

2. Run the tests:

bash

uv run pytest tests/ -v

---

👩‍💻 Contributing

We welcome contributions from the community! Whether you want to fix bugs, add features, or improve documentation, your help is appreciated.

If you need help, have found a bug, or want to contribute improvements, the best place to do that is right here — by opening a GitHub issue.

For Developers

If you're interested in contributing code or setting up a development environment:

📖 **See CONTRIBUTING.md** for comprehensive developer setup instructions, including:

Development environment setup with uv
Code linting and formatting with Ruff
Pre-commit hooks installation
Project structure overview
Development workflow and practices

Quick Start for Contributors

bash

# Clone and setup
git clone https://github.com/Couchbase-Ecosystem/mcp-server-couchbase.git
cd mcp-server-couchbase

# Install with development dependencies
uv sync --extra dev

# Install pre-commit hooks
uv run pre-commit install

# Run linting
./scripts/lint.sh

---

📢 Support Policy

We truly appreciate your interest in this project!

This project is Couchbase community-maintained, which means it's not officially supported by our support team. However, our engineers are actively monitoring and maintaining this repo and will try to resolve issues on a best-effort basis.

Our support portal is unable to assist with requests related to this project, so we kindly ask that all inquiries stay within GitHub.

Your collaboration helps us all move forward together — thank you!

Mcp Server Couchbase

Documentation

Couchbase MCP Server

Features/Tools

Cluster setup & health tools

Data model & schema discovery tools

Document KV operations tools

Query and indexing tools

Query performance analysis tools

Prerequisites

Configuration

Running from PyPI

Server Configuration using Pre built Package for MCP Clients

Basic Authentication

mTLS

Running from Source

Clone the repository to your local machine.

Server Configuration using Source for MCP Clients

Additional Configuration for MCP Server

Read-Only Mode Configuration

Disabling Tools

Supported Formats

MCP Client Configuration Examples

Important Security Note

Client Specific Configuration

Streamable HTTP Transport Mode

Usage

MCP Client Configuration

SSE Transport Mode

Usage

MCP Client Configuration

Docker Image

Building Image

Running

Independent Docker Container

MCP Client Configuration

Risks Associated with LLMs

Managed MCP Server

Troubleshooting Tips

Integration testing

👩‍💻 Contributing

For Developers

Quick Start for Contributors

📢 Support Policy

Similar MCP

Mcp Aoai Web Browsing

Fal Mcp Server

Davinci Resolve Mcp

Fhir Mcp Server

Trending MCP

Playwright Mcp

Serena

Mcp Playwright

Mcp Server Cloudflare

Mcp Aoai Web Browsing

Fal Mcp Server

Davinci Resolve Mcp

Fhir Mcp Server

Playwright Mcp

Serena

Mcp Playwright

Mcp Server Cloudflare