Release 0.4.0 (#45)

* Update README.md to enhance command formatting and clarify troubleshooting notes

- Reformatted command examples for starting the MCP server to improve readability.
- Updated troubleshooting instructions regarding log locations and the `uv` package manager.
- Ensured consistent use of environment variable names throughout the document.

* Add Docker.md for Couchbase MCP Server documentation on Dockerhub

- Introduced a new documentation file, Docker.md, detailing the Couchbase MCP Server, its features, usage, and environment variable configurations.
- Updated GitHub Actions workflow to reference the new Docker.md for the README file path instead of README.md.

* Update version in pyproject.toml from "0.4.0rc1" to "0.4.0" for final release.

* Update environment variable names in Docker.md and README.md for consistency

- Changed `CB_READ_ONLY_QUERY_MODE` to `CB_MCP_READ_ONLY_QUERY_MODE` in Docker.md to align with recent naming conventions.
- Improved formatting in README.md for the MCP server command example for better readability.

* Enhance Docker.md with improved command options and environment variable descriptions

- Added the `--rm` option to the Docker run command for automatic container removal after execution.
- Updated the formatting of the environment variable table for better clarity and consistency, including bolding required fields and refining descriptions.

Author: nithishr

.github/workflows/docker.yml

@@ -68,4 +68,4 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
           repository: ${{ env.IMAGE_NAME }}
-          readme-filepath: ./README.md
+          readme-filepath: ./DOCKER.md

DOCKER.md

@@ -0,0 +1,72 @@
+# Couchbase MCP Server
+
+Pre-built images for the [Couchbase](https://www.couchbase.com/) MCP Server.
+
+A Model Context Protocol (MCP) server that allows AI agents to interact with Couchbase databases.
+
+Github Repo: https://github.com/Couchbase-Ecosystem/mcp-server-couchbase
+
+Dockerfile: https://github.com/Couchbase-Ecosystem/mcp-server-couchbase/blob/main/Dockerfile
+
+## Features
+
+- Get a list of all the scopes and collections in the specified bucket
+- Get the structure for a collection
+- Get a document by ID from a specified scope and collection
+- Upsert a document by ID to a specified scope and collection
+- Delete a document by ID from a specified scope and collection
+- Run a [SQL++ query](https://www.couchbase.com/sqlplusplus/) on a specified scope
+  - There is an option in the MCP server, `CB_MCP_READ_ONLY_QUERY_MODE` that is set to true by default to disable running SQL++ queries that change the data or the underlying collection structure. Note that the documents can still be updated by ID.
+- Get the status of the MCP server
+- Check the cluster credentials by connecting to the cluster
+
+## Usage
+
+The Docker images can be used in the supported MCP clients such as Claude Desktop, Cursor, Windsurf, etc in combination with Docker.
+
+### Configuration
+
+Add the configuration specified below to the MCP configuration in your MCP client.
+
+- Claude Desktop: https://modelcontextprotocol.io/quickstart/user
+- Cursor: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers
+- Windsurf: https://docs.windsurf.com/windsurf/cascade/mcp#adding-a-new-mcp-plugin
+
+```json
+{
+  "mcpServers": {
+    "couchbase": {
+      "command": "docker",
+      "args": [
+        "run",
+        "--rm",
+        "-i",
+        "-e",
+        "CB_CONNECTION_STRING=<couchbase_connection_string>",
+        "-e",
+        "CB_USERNAME=<database_username>",
+        "-e",
+        "CB_PASSWORD=<database_password>",
+        "-e",
+        "CB_BUCKET_NAME=<bucket_name>",
+        "couchbaseecosystem/mcp-server-couchbase:latest"
+      ]
+    }
+  }
+}
+```
+
+### Environment Variables
+
+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).
+
+| Variable                      | Description                                 | Default      |
+| ----------------------------- | ------------------------------------------- | ------------ |
+| `CB_CONNECTION_STRING`        | Couchbase Connection string                 | **Required** |
+| `CB_USERNAME`                 | Database username                           | **Required** |
+| `CB_PASSWORD`                 | Database password                           | **Required** |
+| `CB_BUCKET_NAME`              | Bucket to access                            | **Required** |
+| `CB_MCP_READ_ONLY_QUERY_MODE` | Prevent data modification queries via SQL++ | `true`       |
+| `CB_MCP_TRANSPORT`            | Transport mode (stdio/http/sse)             | `stdio`      |
+| `CB_MCP_HOST`                 | Server host (HTTP/SSE modes)                | `127.0.0.1`  |
+| `CB_MCP_PORT`                 | Server port (HTTP/SSE modes)                | `8000`       |

README.md

@@ -204,7 +204,13 @@ Check if your [MCP client](https://modelcontextprotocol.io/clients) supports str
 By default, the MCP server will run on port 8000 but this can be configured using the `--port` or `CB_MCP_PORT` environment variable.
 
 ```bash
-uvx couchbase-mcp-server --connection-string='<couchbase_connection_string>' --username='<database_username>' --password='<database_password>' --bucket-name='<couchbase_bucket_to_use>' --read-only-query-mode=true --transport=streamable-http
+uvx couchbase-mcp-server \
+  --connection-string='<couchbase_connection_string>' \
+  --username='<database_username>' \
+  --password='<database_password>' \
+  --bucket-name='<couchbase_bucket_to_use>' \
+  --read-only-query-mode=true \
+  --transport=http
 ```
 
 The server will be available on http://localhost:8000/mcp. This can be used in MCP clients supporting streamable http transport mode such as Cursor.
@@ -232,7 +238,13 @@ There is an option to run the MCP server in [Server-Sent Events (SSE)](https://m
 By default, the MCP server will run on port 8000 but this can be configured using the `--port` or `CB_MCP_PORT` environment variable.
 
 ```bash
- uvx couchbase-mcp-server --connection-string='<couchbase_connection_string>' --username='<database_username>' --password='<database_password>' --bucket-name='<couchbase_bucket_to_use>' --read-only-query-mode=true --transport=sse
+uvx couchbase-mcp-server \
+  --connection-string='<couchbase_connection_string>' \
+  --username='<database_username>' \
+  --password='<database_password>' \
+  --bucket-name='<couchbase_bucket_to_use>' \
+  --read-only-query-mode=true \
+  --transport=sse
 ```
 
 The server will be available on http://localhost:8000/sse. This can be used in MCP clients supporting SSE transport mode such as Cursor.
@@ -366,8 +378,8 @@ The Couchbase MCP server can also be used as a managed server in your agentic ap
 - Verify that your Couchbase connection string, database username, password and bucket name are correct.
 - If using Couchbase Capella, ensure that the cluster is [accessible](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html) from the machine where the MCP server is running.
 - Check that the database user has proper permissions to access the specified bucket.
-- Confirm that the uv package manager is properly installed and accessible. You may need to provide absolute path to uv/uvx in the `command` field in the configuration.
-- Check the logs for any errors or warnings that may indicate issues with the MCP server. The server logs are under the name, `mcp-server-couchbase.log`.
+- Confirm that the `uv` package manager is properly installed and accessible. You may need to provide absolute path to `uv`/`uvx` in the `command` field in the configuration.
+- Check the logs for any errors or warnings that may indicate issues with the MCP server. The location of the logs depend on your MCP client.
 - If you are observing issues running your MCP server from source after updating your local MCP server repository, try running `uv sync` to update the [dependencies](https://docs.astral.sh/uv/concepts/projects/sync/#syncing-the-environment).
 
 ---

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "couchbase-mcp-server"
-version = "0.4.0rc1"
+version = "0.4.0"
 description = "Couchbase MCP Server - The Developer Data Platform for Critical Applications in Our AI World"
 readme = "README.md"
 requires-python = ">=3.10"