Loading...
The Couchbase MCP Server enables LLMs to interact with Couchbase clusters, offering tools for cluster management, schema discovery, data operations, query execution, and performance analysis, with configurable read-only modes for safety.
Boost this tool
Subscribe to listing upgrades or segmented pushes.
The Couchbase MCP Server enables LLMs to interact with Couchbase clusters, offering tools for cluster management, schema discovery, data operations, query execution, and performance analysis, with configurable read-only modes for safety.
The Couchbase MCP Server is relatively safe in its default read-only configuration. Enabling write operations increases the risk, requiring careful consideration of the LLM's capabilities and access controls. Secure credential management and tool disabling are crucial for mitigating potential risks.
Performance depends on the complexity of queries and the size of the dataset. Indexing is crucial for optimizing query performance.
Cost depends on the resources consumed by the Couchbase cluster and the frequency of queries.
uvx couchbase-mcp-server --version{
"mcpServers": {
"couchbase": {
"command": "uvx",
"args": ["couchbase-mcp-server"],
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_USERNAME": "username",
"CB_PASSWORD": "password"
}
}
}
}CB_CONNECTION_STRINGCB_USERNAMECB_PASSWORDCB_BUCKET_NAMEMCP_TRANSPORTREAD_ONLY_QUERY_MODEget_server_configuration_statusRetrieves the status of the MCP server.
Read-only operation with no side effects.
test_cluster_connectionTests the connection to the Couchbase cluster using provided credentials.
Read-only operation that only validates connectivity.
get_cluster_health_and_servicesRetrieves the health status and list of running services in the Couchbase cluster.
Read-only operation providing cluster information.
get_buckets_in_clusterLists all buckets within the Couchbase cluster.
Read-only operation listing available buckets.
get_scopes_in_bucketLists all scopes within a specified bucket.
Read-only operation listing scopes in a bucket.
get_collections_in_scopeLists all collections within a specified scope and bucket.
Read-only operation listing collections.
get_scopes_and_collections_in_bucketLists all scopes and collections within a specified bucket.
Read-only operation listing scopes and collections.
get_schema_for_collectionRetrieves the schema structure for a specified collection.
Read-only operation retrieving schema information.
get_document_by_idRetrieves a document by its ID from a specified scope and collection.
Read-only operation retrieving a single document.
upsert_document_by_idUpserts (inserts or updates) a document by ID to a specified scope and collection.
Modifies data by inserting or updating a document; disabled by default in read-only mode.
insert_document_by_idInserts a new document by ID into a specified scope and collection (fails if the document already exists).
Modifies data by inserting a new document; disabled by default in read-only mode.
replace_document_by_idReplaces an existing document by ID in a specified scope and collection (fails if the document does not exist).
Modifies data by replacing an existing document; disabled by default in read-only mode.
delete_document_by_idDeletes a document by ID from a specified scope and collection.
Destructive operation that permanently removes a document; disabled by default in read-only mode.
list_indexesLists all indexes in the cluster with their definitions, optionally filtered by bucket, scope, collection, and index name.
Read-only operation listing index information.
get_index_advisor_recommendationsProvides index recommendations from Couchbase Index Advisor for a given SQL++ query to optimize query performance.
Read-only operation providing index optimization suggestions.
run_sql_plus_plus_queryExecutes a SQL++ query on a specified scope.
Can potentially modify data depending on the query; write operations are blocked in read-only mode.
get_longest_running_queriesRetrieves the longest running queries by average service time.
Read-only operation for performance analysis.
get_most_frequent_queriesRetrieves the most frequently executed queries.
Read-only operation for performance analysis.
get_queries_with_largest_response_sizesRetrieves queries with the largest response sizes.
Read-only operation for performance analysis.
get_queries_with_large_result_countRetrieves queries with the largest result counts.
Read-only operation for performance analysis.
get_queries_using_primary_indexRetrieves queries that use a primary index.
Read-only operation for performance analysis.
get_queries_not_using_covering_indexRetrieves queries that do not use a covering index.
Read-only operation for performance analysis.
get_queries_not_selectiveRetrieves queries that are not selective.
Read-only operation for performance analysis.
Environment Variable
hybrid
The Couchbase MCP Server is relatively safe in its default read-only configuration. Enabling write operations increases the risk, requiring careful consideration of the LLM's capabilities and access controls. Secure credential management and tool disabling are crucial for mitigating potential risks.
Autonomy should be carefully managed, especially when write operations are enabled. Ensure proper access controls and monitoring are in place.
Production Tip
Always start with read-only mode and carefully evaluate the need for write operations before enabling them.
The MCP server defaults to read-only mode to prevent accidental data modification.
Set the `CB_MCP_READ_ONLY_MODE` environment variable to `false`.
The server supports basic authentication (username/password) and mTLS (client certificate and key).
Use the `CB_MCP_DISABLED_TOOLS` environment variable or the `--disabled-tools` command-line argument, providing a comma-separated list of tool names or a path to a file containing tool names.
It specifies the path to the server root certificate for TLS if the server is configured with a self-signed/untrusted certificate.
No, the server is single-threaded.
The query will be blocked, and an error will be returned.