Couchbase

by hummusonrails

1 stars

294 downloads

Not rated

GitHub

About

Enables natural language querying of Couchbase databases through SQL++ execution with built-in authentication, connection management, and error handling

Details

Author: hummusonrails
Repository: hummusonrails/couchbase-mcp-server
GitHub stars: 1
Downloads: 294
License: MIT License
Categories: AI, Design, Developer Tools, Search, Frontend, Security, Infrastructure, 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 @highlight/mcp-server
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": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "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": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "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": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "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": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "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": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "/c",
                "npx",
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

From the repository

1. Clone the repository and install dependencies:

git clone git@github.com:hummusonrails/couchbase-mcp-server.git
cd couchbase-mcp-server
npm install

2. Create a .env file in the root directory and add your Couchbase connection string, username, and password:

COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com
COUCHBASE_USERNAME=your_username
COUCHBASE_PASSWORD=your_password

Refer to the .env.sample file for the required environment variables.

3. Build the project:

npm run build

4. Run the server using Stdio transport:

npx couchbase-mcp-server

> [!NOTE] > The MCP server uses the StdioServerTransport, so it communicates over standard input/output. Ensure that your MCP client (e.g., Claude Desktop) is configured to use a local MCP server. > Follow the Claude Desktop documentation to set up the MCP client to connect to the local server.

`query-couchbase`

Executes a SQL++ query statement on your Couchbase Capella cluster. The server will use the Couchbase Node.js SDK to execute the provided SQL++ query and return the results.

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "couchbase": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Macos

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Windows

{
    "env": [],
    "args": [
        "/c",
        "npx",
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "cmd"
}

Couchbase MCP Server

The Model Context Protocol (MCP) is a protocol for handling interactions between large language models (LLMs) and external systems. This repository implements a Couchbase MCP Server using the Couchbase Node.js SDK, enabling MCP clients (e.g., Claude Desktop) to perform natural language queries on Couchbase Capella clusters.

With this server you can use commands like:

Show me the results of SELECT FROM my_bucket LIMIT 10
Execute this query: SELECT name, age FROM users WHERE active = true
Get me the latest 5 documents from my_bucket
Summarize the latest 5 orders from the orders bucket for me

Example

The following screenshot shows the MCP server in action with the Claude Desktop client. The user issues a general request in plain English and the MCP server translates it into a SQL++ query that is executed against the Couchbase Capella cluster. The results are then returned to the user in a readable format.

<p>

</p>

Setup

1. Clone the repository and install dependencies:

git clone git@github.com:hummusonrails/couchbase-mcp-server.git cd couchbase-mcp-server npm install

2. Create a .env file in the root directory and add your Couchbase connection string, username, and password:

COUCHBASE_CONNECTION_STRING=couchbases://your-cluster.cloud.couchbase.com COUCHBASE_USERNAME=your_username COUCHBASE_PASSWORD=your_password

Refer to the .env.sample file for the required environment variables.

3. Build the project:

npm run build

4. Run the server using Stdio transport:

npx couchbase-mcp-server
> [!NOTE] > The MCP server uses the StdioServerTransport, so it communicates over standard input/output. Ensure that your MCP client (e.g., Claude Desktop) is configured to use a local MCP server. > Follow the Claude Desktop documentation to set up the MCP client to connect to the local server.
Features

Couchbase Query Tool

ToolName: query-couchbase
Description: Executes a SQL++ query statement on your Couchbase Capella cluster.
Usage: When invoked, the server will use the Couchbase Node.js SDK to execute the provided SQL++ query and return the results.

Developing

To work on the project locally:

1. Install dependences:

npm install
npm run build

2. Test the server using an MCP client:

Launch your MCP client (e.g., Claude Desktop) configured to connect and invoke the tool using a sample query.

3. Debugging

All logging messages are sent to stderr to ensure that stdout only contains MCP protocol JSON. Check your logs for detailed connection and error messages.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue with your suggestions. For any changes, ensure you follow the project’s code style.

License

This project is licensed under the MIT License. See the LICENSE file for details.29

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-couchbase

Claude Desktop / Cursor

Linux

Macos

Windows

Couchbase MCP Server

Example

Setup

Features

Couchbase Query Tool

Developing

Contributing

License

Install

More like this

Sentry

Github

Git

GitLab

Context 7

1Panel

`query-couchbase`