Update environment variable for HOST & PORT, Add version cli command (#40)

* Update environment variable names for HOST & PORT

- Changed environment variable from FASTMCP_PORT to MCP_PORT in server, Dockerfile and README.md.

* Add version information to the MCP server

- Implemented version option in mcp_server.py for the couchbase-mcp-server package.
- Added a command to check the server version in README.md.

* Refactor transport handling in MCP server

- Updated environment variable names for transport and query mode to include new prefixes while marking old ones as deprecated.
- Introduced a mapping from user-friendly transport names to SDK transport names for improved compatibility.
- Adjusted the server configuration to utilize the new transport mapping when running the server.

* Update README.md to reflect new environment variable naming conventions

- Changed `READ_ONLY_QUERY_MODE` to `CB_MCP_READ_ONLY_QUERY_MODE` for consistency.
- Updated `MCP_TRANSPORT`, `MCP_HOST`, and `MCP_PORT` to `CB_MCP_TRANSPORT`, `CB_MCP_HOST`, and `CB_MCP_PORT` respectively.

* Update environment variable names in Dockerfile for consistency with recent changes

- Changed `READ_ONLY_QUERY_MODE`, `MCP_TRANSPORT`, and `MCP_PORT` to `CB_MCP_READ_ONLY_QUERY_MODE`, `CB_MCP_TRANSPORT`, and `CB_MCP_PORT` respectively to align with updated naming conventions.

* Update README.md to reflect new environment variable naming conventions and fix typos

- Changed `READ_ONLY_QUERY_MODE` to `CB_MCP_READ_ONLY_QUERY_MODE` for consistency with recent updates.
- Corrected the description of `CB_MCP_PORT` to specify its applicability in HTTP transport modes as `http` and `sse`.

Author: nithishr

Dockerfile

@@ -39,9 +39,9 @@ RUN chown -R mcpuser:mcpuser /app /opt/venv
 USER mcpuser
 
 # Environment variables with defaults
-ENV READ_ONLY_QUERY_MODE="true" \
-    MCP_TRANSPORT="stdio" \
-    FASTMCP_PORT="8000"
+ENV CB_MCP_READ_ONLY_QUERY_MODE="true" \
+    CB_MCP_TRANSPORT="stdio" \
+    CB_MCP_PORT="8000"
 
 # Expose default port for SSE mode
 EXPOSE 8000

README.md

@@ -2,7 +2,7 @@
 
 An [MCP](https://modelcontextprotocol.io/) server implementation of Couchbase that allows LLMs to directly interact with Couchbase clusters.
 
-[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![PyPI version](https://badge.fury.io/py/couchbase-mcp-server.svg)](https://pypi.org/project/couchbase-mcp-server/) [![Verified on MseeP](https://mseep.ai/badge.svg)](https://mseep.ai/app/13fce476-0e74-4b1e-ab82-1df2a3204809) [![smithery badge](https://smithery.ai/badge/@Couchbase-Ecosystem/mcp-server-couchbase)](https://smithery.ai/server/@Couchbase-Ecosystem/mcp-server-couchbase)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![PyPI version](https://badge.fury.io/py/couchbase-mcp-server.svg)](https://pypi.org/project/couchbase-mcp-server/) [![Verified on MseeP](https://mseep.ai/badge.svg)](https://mseep.ai/app/13fce476-0e74-4b1e-ab82-1df2a3204809)
 
 <a href="https://glama.ai/mcp/servers/@Couchbase-Ecosystem/mcp-server-couchbase">
   <img width="380" height="200" src="https://glama.ai/mcp/servers/@Couchbase-Ecosystem/mcp-server-couchbase/badge" alt="Couchbase Server MCP server" />
@@ -16,7 +16,7 @@ An [MCP](https://modelcontextprotocol.io/) server implementation of Couchbase th
 - 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, `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.
+  - 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
 
@@ -100,16 +100,22 @@ This is the common configuration for the MCP clients such as Claude Desktop, Cur
 
 The server can be configured using environment variables or command line arguments:
 
-| Environment Variable   | CLI Argument             | Description                                       | Default      |
-| ---------------------- | ------------------------ | ------------------------------------------------- | ------------ |
-| `CB_CONNECTION_STRING` | `--connection-string`    | Connection string to the Couchbase cluster        | **Required** |
-| `CB_USERNAME`          | `--username`             | Username with bucket access                       | **Required** |
-| `CB_PASSWORD`          | `--password`             | Password for authentication                       | **Required** |
-| `CB_BUCKET_NAME`       | `--bucket-name`          | Name of the bucket to access                      | **Required** |
-| `READ_ONLY_QUERY_MODE` | `--read-only-query-mode` | Prevent data modification queries                 | `true`       |
-| `MCP_TRANSPORT`        | `--transport`            | Transport mode: `stdio`, `streamable-http`, `sse` | `stdio`      |
-| `FASTMCP_HOST`         | `--host`                 | Host for HTTP/SSE transport modes                 | `127.0.0.1`  |
-| `FASTMCP_PORT`         | `--port`                 | Port for HTTP/SSE transport modes                 | `8000`       |
+| Environment Variable          | CLI Argument             | Description                                | Default      |
+| ----------------------------- | ------------------------ | ------------------------------------------ | ------------ |
+| `CB_CONNECTION_STRING`        | `--connection-string`    | Connection string to the Couchbase cluster | **Required** |
+| `CB_USERNAME`                 | `--username`             | Username with bucket access                | **Required** |
+| `CB_PASSWORD`                 | `--password`             | Password for authentication                | **Required** |
+| `CB_BUCKET_NAME`              | `--bucket-name`          | Name of the bucket to access               | **Required** |
+| `CB_MCP_READ_ONLY_QUERY_MODE` | `--read-only-query-mode` | Prevent data modification queries          | `true`       |
+| `CB_MCP_TRANSPORT`            | `--transport`            | Transport mode: `stdio`, `http`, `sse`     | `stdio`      |
+| `CB_MCP_HOST`                 | `--host`                 | Host for HTTP/SSE transport modes          | `127.0.0.1`  |
+| `CB_MCP_PORT`                 | `--port`                 | Port for HTTP/SSE transport modes          | `8000`       |
+
+You can also check the version of the server using:
+
+```bash
+uvx couchbase-mcp-server --version
+```
 
 #### Client Specific Configuration
 
@@ -189,13 +195,13 @@ For more details about MCP integration with Windsurf Editor, refer to the offici
 ## Streamable HTTP Transport Mode
 
 The MCP Server can be run in [Streamable HTTP](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#streamable-http) transport mode which allows multiple clients to connect to the same server instance via HTTP.
-Check if your [MCP client](https://modelcontextprotocol.io/clients) supports streamable-http transport before attempting to connect to MCP server in this mode.
+Check if your [MCP client](https://modelcontextprotocol.io/clients) supports streamable http transport before attempting to connect to MCP server in this mode.
 
 > Note: This mode does not include authorization support.
 
 ### Usage
 
-By default, the MCP server will run on port 8000 but this can be configured using the `--port` or `FASTMCP_PORT` environment variable.
+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
@@ -208,22 +214,22 @@ The server will be available on http://localhost:8000/mcp. This can be used in M
 ```json
 {
   "mcpServers": {
-    "couchbase-streamable-http": {
+    "couchbase-http": {
       "url": "http://localhost:8000/mcp"
     }
   }
 }
 ```
 
-## SSE Transport Mode (Deprecated)
+## SSE Transport Mode
 
 There is an option to run the MCP server in [Server-Sent Events (SSE)](https://modelcontextprotocol.io/specification/2024-11-05/basic/transports#http-with-sse) transport mode.
 
 > Note: SSE mode has been [deprecated](https://modelcontextprotocol.io/docs/concepts/transports#server-sent-events-sse-deprecated) by MCP. We have support for [Streamable HTTP](#streamable-http-transport-mode).
 
 ### Usage
 
-By default, the MCP server will run on port 8000 but this can be configured using the `--port` or `FASTMCP_PORT` environment variable.
+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
@@ -267,14 +273,14 @@ docker run --rm -i \
   -e CB_USERNAME='<database_user>' \
   -e CB_PASSWORD='<database_password>' \
   -e CB_BUCKET_NAME='<bucket_name>' \
-  -e MCP_TRANSPORT='<streamable-http|sse|stdio>' \
-  -e READ_ONLY_QUERY_MODE='<true|false>' \
-  -e FASTMCP_PORT=9001 \
+  -e CB_MCP_TRANSPORT='<http|sse|stdio>' \
+  -e CB_MCP_READ_ONLY_QUERY_MODE='<true|false>' \
+  -e CB_MCP_PORT=9001 \
   -p 9001:9001 \
   mcp/couchbase
 ```
 
-The `FASTMCP_PORT` environment variable is only applicable in the case of HTTP transport modes like streamable-http and sse.
+The `CB_MCP_PORT` environment variable is only applicable in the case of HTTP transport modes like http and sse.
 
 #### MCP Client Configuration
 

src/mcp_server.py

@@ -22,6 +22,7 @@
     DEFAULT_TRANSPORT,
     MCP_SERVER_NAME,
     NETWORK_TRANSPORTS,
+    NETWORK_TRANSPORTS_SDK_MAPPING,
     AppContext,
     get_settings,
 )
@@ -83,30 +84,37 @@ async def app_lifespan(server: FastMCP) -> AsyncIterator[AppContext]:
 )
 @click.option(
     "--read-only-query-mode",
-    envvar="READ_ONLY_QUERY_MODE",
+    envvar=[
+        "CB_MCP_READ_ONLY_QUERY_MODE",
+        "READ_ONLY_QUERY_MODE",  # Deprecated
+    ],
     type=bool,
     default=DEFAULT_READ_ONLY_MODE,
     help="Enable read-only query mode. Set to True (default) to allow only read-only queries. Can be set to False to allow data modification queries.",
 )
 @click.option(
     "--transport",
-    envvar="MCP_TRANSPORT",
+    envvar=[
+        "CB_MCP_TRANSPORT",
+        "MCP_TRANSPORT",  # Deprecated
+    ],
     type=click.Choice(ALLOWED_TRANSPORTS),
     default=DEFAULT_TRANSPORT,
-    help="Transport mode for the server (stdio, streamable-http or sse)",
+    help="Transport mode for the server (stdio, http or sse). Default is stdio",
 )
 @click.option(
     "--host",
-    envvar="FASTMCP_HOST",
+    envvar="CB_MCP_HOST",
     default=DEFAULT_HOST,
     help="Host to run the server on (default: 127.0.0.1)",
 )
 @click.option(
     "--port",
-    envvar="FASTMCP_PORT",
+    envvar="CB_MCP_PORT",
     default=DEFAULT_PORT,
     help="Port to run the server on (default: 8000)",
 )
+@click.version_option(package_name="couchbase-mcp-server")
 @click.pass_context
 def main(
     ctx,
@@ -132,8 +140,19 @@ def main(
         "port": port,
     }
 
+    # Map user-friendly transport names to SDK transport names
+    sdk_transport = NETWORK_TRANSPORTS_SDK_MAPPING.get(transport, transport)
+
     # If the transport is network based, we need to pass the host and port to the MCP server
-    config = {"host": host, "port": port} if transport in NETWORK_TRANSPORTS else {}
+    config = (
+        {
+            "host": host,
+            "port": port,
+            "transport": sdk_transport,
+        }
+        if transport in NETWORK_TRANSPORTS
+        else {}
+    )
 
     mcp = FastMCP(MCP_SERVER_NAME, lifespan=app_lifespan, **config)
 
@@ -142,7 +161,7 @@ def main(
         mcp.add_tool(tool)
 
     # Run the server
-    mcp.run(transport=transport)
+    mcp.run(transport=sdk_transport)  # type: ignore
 
 
 if __name__ == "__main__":

src/utils/__init__.py

@@ -27,6 +27,7 @@
     DEFAULT_TRANSPORT,
     MCP_SERVER_NAME,
     NETWORK_TRANSPORTS,
+    NETWORK_TRANSPORTS_SDK_MAPPING,
 )
 
 # Context utilities
@@ -58,4 +59,5 @@
     "DEFAULT_PORT",
     "ALLOWED_TRANSPORTS",
     "NETWORK_TRANSPORTS",
+    "NETWORK_TRANSPORTS_SDK_MAPPING",
 ]

src/utils/constants.py

@@ -8,8 +8,12 @@
 DEFAULT_PORT = 8000
 
 # Allowed Transport Types
-ALLOWED_TRANSPORTS = ["stdio", "streamable-http", "sse"]
-NETWORK_TRANSPORTS = ["streamable-http", "sse"]
+ALLOWED_TRANSPORTS = ["stdio", "http", "sse"]
+NETWORK_TRANSPORTS = ["http", "sse"]
+NETWORK_TRANSPORTS_SDK_MAPPING = {
+    "http": "streamable-http",
+    "sse": "sse",
+}
 
 # Logging Configuration
 # Change this to DEBUG, WARNING, ERROR as needed