couchbase/mcp-server-couchbase

tools

• 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.

• explain_sql_plus_plus_query

  Generate and evaluate an EXPLAIN plan for a SQL++ query. Returns query metadata, extracted plan, and plan evaluation findings.

• get_buckets_in_cluster

  Get a list of all the buckets in the cluster

• get_cluster_health_and_services

  Get cluster health status and list of all running services

• 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_document_by_id

  Get a document by ID from a specified scope and collection

• get_index_advisor_recommendations

  Get index recommendations from Couchbase Index Advisor for a given SQL++ query to optimize query performance

• get_longest_running_queries

  Get longest running queries by average service time

• get_most_frequent_queries

  Get most frequently executed queries

• get_queries_not_selective

  Get queries that are not selective (index scans return many more documents than final result)

• get_queries_not_using_covering_index

  Get queries that don't use a covering index

• get_queries_using_primary_index

  Get queries that use a primary index (potential performance concern)

• get_queries_with_large_result_count

  Get queries with the largest result counts

• get_queries_with_largest_response_sizes

  Get queries with the largest response sizes

• get_schema_for_collection

  Get the structure for a collection

• get_scopes_and_collections_in_bucket

  Get a list of all the scopes and collections in the specified bucket

• get_scopes_in_bucket

  Get a list of all the scopes in the specified bucket

• get_server_configuration_status

  Get the status of the MCP server

• insert_document_by_id

  Insert a new document by ID (fails if document exists). Disabled by default when CB_MCP_READ_ONLY_MODE=true.

• list_indexes

  List all indexes in the cluster with their definitions, with optional filtering by bucket, scope, collection and index name. Set return_raw_index_stats=true to return the unprocessed index information

• 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.

• run_sql_plus_plus_query

  Run a [SQL++ query](https://www.couchbase.com/sqlplusplus/) on a specified scope.<br><br>Queries are automatically scoped to the specified bucket and scope, so use collection names directly (e.g., SEL

• test_cluster_connection

  Check the cluster credentials by connecting to the cluster

• 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.