Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CB_MCP_HOST | No | Host for HTTP/SSE transport modes | 127.0.0.1 |
| CB_MCP_PORT | No | Port for HTTP/SSE transport modes | 8000 |
| CB_PASSWORD | Yes | Password for authentication | |
| CB_USERNAME | Yes | Username with bucket access | |
| CB_BUCKET_NAME | Yes | Name of the bucket to access | |
| CB_MCP_TRANSPORT | No | Transport mode: stdio, http, sse | stdio |
| CB_CONNECTION_STRING | Yes | Connection string to the Couchbase cluster | |
| CB_MCP_READ_ONLY_QUERY_MODE | No | Prevent data modification queries | true |
Capabilities
Server capabilities have not been inspected yet.
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_buckets_in_cluster | Get the names of all the accessible buckets in the cluster. |
| get_server_configuration_status | Get the server status and configuration without establishing connection. This tool can be used to verify if the server is running and check the configuration. |
| test_cluster_connection | Test the connection to Couchbase cluster and optionally to a bucket. This tool verifies the connection to the Couchbase cluster and bucket by establishing the connection if it is not already established. If bucket name is not provided, it will not try to connect to the bucket specified in the MCP server settings. Returns connection status and basic cluster information. |
| get_scopes_and_collections_in_bucket | Get the names of all scopes and collections in the bucket. Returns a dictionary with scope names as keys and lists of collection names as values. |
| get_collections_in_scope | Get the names of all collections in the given scope and bucket. |
| get_scopes_in_bucket | Get the names of all scopes in the given bucket. |
| get_document_by_id | Get a document by its ID from the specified scope and collection. If the document is not found, it will raise an exception. |
| upsert_document_by_id | Insert or update a document by its ID. Returns True on success, False on failure. |
| delete_document_by_id | Delete a document by its ID. Returns True on success, False on failure. |
| get_schema_for_collection | Get the schema for a collection in the specified scope. Returns a dictionary with the collection name and the schema returned by running INFER query on the Couchbase collection. |
| run_sql_plus_plus_query | Run a SQL++ query on a scope and return the results as a list of JSON objects. |
| get_index_advisor_recommendations | Get index recommendations from Couchbase Index Advisor for a given SQL++ query. |
| list_indexes | List all indexes in the cluster with optional filtering by bucket, scope, collection, and index name. Returns a list of indexes with their names and CREATE INDEX definitions. Uses the Index Service REST API (/getIndexStatus) to retrieve index information directly. |
| get_cluster_health_and_services | Get cluster health status and list of all running services. |
| get_queries_not_selective | Get queries that are not very selective from the system:completed_requests catalog. |
| get_queries_not_using_covering_index | Get queries that don't use a covering index from the system:completed_requests catalog. |
| get_queries_using_primary_index | Get queries that use a primary index from the system:completed_requests catalog. |
| get_queries_with_large_result_count | Get queries with the largest result counts from the system:completed_requests catalog. |
| get_queries_with_largest_response_sizes | Get queries with the largest response sizes from the system:completed_requests catalog. |
| get_longest_running_queries | Get the N longest running queries from the system:completed_requests catalog. |
| get_most_frequent_queries | Get the N most frequent queries from the system:completed_requests catalog. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |