Skip to content

Commit 54df571

Browse files
authored
Enhance Docker.md with new features and updated environment variable … (#55)
* Enhance Docker.md with new features and updated environment variable descriptions - Added new features for retrieving a list of all buckets, scopes, and collections in the cluster. - Updated the environment variable table to include new mTLS-related variables and clarified requirements for existing variables. - Improved formatting for better readability and consistency. * Fix formatting inconsistencies in Docker.md environment variable table - Corrected the description formatting for `CB_PASSWORD` and `CB_CA_CERT_PATH` to ensure clarity and consistency in the documentation. - Enhanced readability of the environment variable requirements for mTLS authentication.
1 parent 86ea916 commit 54df571

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

DOCKER.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ Dockerfile: https://github.com/Couchbase-Ecosystem/mcp-server-couchbase/blob/mai
1010

1111
## Features
1212

13+
- Get a list of all the buckets in the cluster
1314
- Get a list of all the scopes and collections in the specified bucket
15+
- Get a list of all the scopes in the specified bucket
16+
- Get a list of all the collections in a specified scope and bucket. Note that this tool requires the cluster to have Query service.
1417
- Get the structure for a collection
1518
- Get a document by ID from a specified scope and collection
1619
- Upsert a document by ID to a specified scope and collection
@@ -47,8 +50,6 @@ Add the configuration specified below to the MCP configuration in your MCP clien
4750
"CB_USERNAME=<database_username>",
4851
"-e",
4952
"CB_PASSWORD=<database_password>",
50-
"-e",
51-
"CB_BUCKET_NAME=<bucket_name>",
5253
"couchbaseecosystem/mcp-server-couchbase:latest"
5354
]
5455
}
@@ -60,13 +61,15 @@ Add the configuration specified below to the MCP configuration in your MCP clien
6061

6162
The detailed explanation for the environment variables can be found on the [Github Repo](https://github.com/Couchbase-Ecosystem/mcp-server-couchbase?tab=readme-ov-file#additional-configuration-for-mcp-server).
6263

63-
| Variable | Description | Default |
64-
| ----------------------------- | ------------------------------------------- | ------------ |
65-
| `CB_CONNECTION_STRING` | Couchbase Connection string | **Required** |
66-
| `CB_USERNAME` | Database username | **Required** |
67-
| `CB_PASSWORD` | Database password | **Required** |
68-
| `CB_BUCKET_NAME` | Bucket to access | **Required** |
69-
| `CB_MCP_READ_ONLY_QUERY_MODE` | Prevent data modification queries via SQL++ | `true` |
70-
| `CB_MCP_TRANSPORT` | Transport mode (stdio/http/sse) | `stdio` |
71-
| `CB_MCP_HOST` | Server host (HTTP/SSE modes) | `127.0.0.1` |
72-
| `CB_MCP_PORT` | Server port (HTTP/SSE modes) | `8000` |
64+
| Variable | Description | Default |
65+
| ----------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
66+
| `CB_CONNECTION_STRING` | Couchbase Connection string | **Required** |
67+
| `CB_USERNAME` | Database username | **Required (or Client Certificate and Key needed for mTLS)** |
68+
| `CB_PASSWORD` | Database password | **Required (or Client Certificate and Key needed for mTLS)** |
69+
| `CB_CLIENT_CERT_PATH` | Path to the client certificate file for mTLS authentication | **Required if using mTLS (or Username and Password required)** |
70+
| `CB_CLIENT_KEY_PATH` | Path to the client key file for mTLS authentication | **Required if using mTLS (or Username and Password required)** |
71+
| `CB_CA_CERT_PATH` | Path to server root certificate for TLS if server is configured with a self-signed/untrusted certificate. | |
72+
| `CB_MCP_READ_ONLY_QUERY_MODE` | Prevent data modification queries via SQL++ | `true` |
73+
| `CB_MCP_TRANSPORT` | Transport mode (stdio/http/sse) | `stdio` |
74+
| `CB_MCP_HOST` | Server host (HTTP/SSE modes) | `127.0.0.1` |
75+
| `CB_MCP_PORT` | Server port (HTTP/SSE modes) | `8000` |

0 commit comments

Comments
 (0)