Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CB_PASSWORD | Yes | The password for the username to connect | |
| CB_USERNAME | Yes | The username with access to the bucket to use to connect | |
| MCP_TRANSPORT | No | Transport mode for the MCP server (stdio or sse) | |
| CB_BUCKET_NAME | Yes | The name of the bucket that the server will access | |
| CB_CONNECTION_STRING | Yes | The connection string to the Couchbase cluster | |
| READ_ONLY_QUERY_MODE | No | Setting to configure whether SQL++ queries that allow data to be modified are allowed | true |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_server_configuration_status | Get the server status and configuration without establishing connections. This tool can be used to verify the server is running and check configuration. |
| test_connection | Test the connection to Couchbase cluster and bucket. 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_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 schema returned by running INFER 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. |