Add Redis Cluster mode support

giladwpx · giladwpx · commit e16ab846ec92 · 2025-04-16T14:56:04.000+03:00
diff --git a/Dockerfile b/Dockerfile
@@ -11,8 +11,14 @@ COPY . /app
 RUN pip install --upgrade pip \
     && pip install .
 
-# Expose necessary port if any (MCP typically uses stdio, but if needed, uncomment below)
-# EXPOSE 8000
+# Default environment variables
+ENV REDIS_HOST=127.0.0.1 \
+    REDIS_PORT=6379 \
+    REDIS_CLUSTER_MODE=false \
+    REDIS_CLUSTER_NODES=""
+
+# Expose the MCP server port
+EXPOSE 3333
 
 # Run the MCP Server
 CMD ["python", "src/main.py"]
diff --git a/README.md b/README.md
@@ -73,6 +73,38 @@ To configure this Redis MCP Server, consider the following environment variables
 | `REDIS_SSL_CERTFILE`    | Client's certificate file for client authentication       | None          |
 | `REDIS_CERT_REQS`       | Whether the client should verify the server's certificate | `"required"`  |
 | `REDIS_CA_CERTS`        | Path to the trusted CA certificates file                  | None          |
+| `REDIS_CLUSTER_MODE`    | Enable Redis Cluster mode                                 | `False`       |
+| `REDIS_CLUSTER_NODES`   | Comma-separated list of cluster nodes (host:port)         | ""            |
+
+## Docker Deployment
+
+You can run the Redis MCP Server in a Docker container:
+
+```bash
+# Build the Docker image
+docker build -t mcp-redis .
+
+# Run in standalone mode
+docker run --rm -it \
+  -e REDIS_HOST=<your-redis-host> \
+  -e REDIS_PORT=<your-redis-port> \
+  -p 3333:3333 \
+  mcp-redis
+
+# Run in cluster mode (only one node needed, others will be auto-discovered)
+docker run --rm -it \
+  -e REDIS_CLUSTER_MODE=true \
+  -e REDIS_HOST=<your-cluster-node-host> \
+  -p 3333:3333 \
+  mcp-redis
+
+# Or specify one or more cluster nodes explicitly
+docker run --rm -it \
+  -e REDIS_CLUSTER_MODE=true \
+  -e REDIS_CLUSTER_NODES="<node1:port>" \
+  -p 3333:3333 \
+  mcp-redis
+```
 
 ## Integration with OpenAI Agents SDK
 
@@ -122,7 +154,9 @@ You can configure Claude Desktop to use this MCP Server.
                 "REDIS_PORT": "<your_redis_database_port>",
                 "REDIS_PSW": "<your_redis_database_password>",
                 "REDIS_SSL": True|False,
-                "REDIS_CA_PATH": "<your_redis_ca_path>"
+                "REDIS_CA_PATH": "<your_redis_ca_path>",
+                "REDIS_CLUSTER_MODE": True|False,
+                "REDIS_CLUSTER_NODES": "<single_node:port>" // Optional, uses REDIS_HOST if not specified
             }
         }
     }
diff --git a/src/common/config.py b/src/common/config.py
@@ -6,6 +6,13 @@
 
 MCP_TRANSPORT = os.getenv('MCP_TRANSPORT', 'stdio')
 
+# Add cluster mode flag
+REDIS_CLUSTER_MODE = os.getenv('REDIS_CLUSTER_MODE', 'false').lower() in ('true', '1', 't')
+
+# Add cluster nodes configuration - only one node is required, others will be auto-discovered
+# If not specified, REDIS_HOST and REDIS_PORT will be used as the initial node
+REDIS_CLUSTER_NODES = os.getenv('REDIS_CLUSTER_NODES', '').split(',') if os.getenv('REDIS_CLUSTER_NODES') else []
+
 REDIS_CFG = {"host": os.getenv('REDIS_HOST', '127.0.0.1'),
              "port": int(os.getenv('REDIS_PORT',6379)),
              "username": os.getenv('REDIS_USERNAME', None),
diff --git a/src/common/connection.py b/src/common/connection.py
@@ -2,34 +2,68 @@
 from version import __version__
 import redis
 from redis import Redis
-from typing import Optional
-from common.config import REDIS_CFG
+from redis.cluster import RedisCluster
+from typing import Optional, Union, List, Dict, Any, Tuple
+from common.config import REDIS_CFG, REDIS_CLUSTER_MODE, REDIS_CLUSTER_NODES
 
 from common.config import generate_redis_uri
 
 
 class RedisConnectionManager:
-    _instance: Optional[Redis] = None
+    _instance: Optional[Union[Redis, RedisCluster]] = None
 
     @classmethod
-    def get_connection(cls, decode_responses=True) -> Redis:
+    def get_connection(cls, decode_responses=True) -> Union[Redis, RedisCluster]:
         if cls._instance is None:
             try:
-                cls._instance = redis.Redis(
-                    host=REDIS_CFG["host"],
-                    port=REDIS_CFG["port"],
-                    username=REDIS_CFG["username"],
-                    password=REDIS_CFG["password"],
-                    ssl=REDIS_CFG["ssl"],
-                    ssl_ca_path=REDIS_CFG["ssl_ca_path"],
-                    ssl_keyfile=REDIS_CFG["ssl_keyfile"],
-                    ssl_certfile=REDIS_CFG["ssl_certfile"],
-                    ssl_cert_reqs=REDIS_CFG["ssl_cert_reqs"],
-                    ssl_ca_certs=REDIS_CFG["ssl_ca_certs"],
-                    decode_responses=decode_responses,
-                    max_connections=10,
-                    lib_name=f"redis-py(mcp-server_v{__version__})"
-                )
+                if REDIS_CLUSTER_MODE:
+                    # In cluster mode, we can connect to one node and the client will discover the rest
+                    # If specific cluster nodes are provided, use the first one as the startup node
+                    if REDIS_CLUSTER_NODES and REDIS_CLUSTER_NODES[0]:
+                        node = REDIS_CLUSTER_NODES[0]
+                        if ':' in node:
+                            host, port = node.split(':')
+                            port = int(port)
+                        else:
+                            # Default to the configured port if only host is provided
+                            host = node
+                            port = REDIS_CFG["port"]
+                    else:
+                        # Use the primary node from REDIS_CFG as the startup node
+                        host = REDIS_CFG["host"]
+                        port = REDIS_CFG["port"]
+                    
+                    cls._instance = RedisCluster(
+                        host=host,
+                        port=port,
+                        username=REDIS_CFG["username"],
+                        password=REDIS_CFG["password"],
+                        ssl=REDIS_CFG["ssl"],
+                        ssl_ca_path=REDIS_CFG["ssl_ca_path"],
+                        ssl_keyfile=REDIS_CFG["ssl_keyfile"],
+                        ssl_certfile=REDIS_CFG["ssl_certfile"],
+                        ssl_cert_reqs=REDIS_CFG["ssl_cert_reqs"],
+                        ssl_ca_certs=REDIS_CFG["ssl_ca_certs"],
+                        decode_responses=decode_responses,
+                        max_connections_per_node=10,
+                        lib_name=f"redis-py(mcp-server_v{__version__})"
+                    )
+                else:
+                    cls._instance = redis.Redis(
+                        host=REDIS_CFG["host"],
+                        port=REDIS_CFG["port"],
+                        username=REDIS_CFG["username"],
+                        password=REDIS_CFG["password"],
+                        ssl=REDIS_CFG["ssl"],
+                        ssl_ca_path=REDIS_CFG["ssl_ca_path"],
+                        ssl_keyfile=REDIS_CFG["ssl_keyfile"],
+                        ssl_certfile=REDIS_CFG["ssl_certfile"],
+                        ssl_cert_reqs=REDIS_CFG["ssl_cert_reqs"],
+                        ssl_ca_certs=REDIS_CFG["ssl_ca_certs"],
+                        decode_responses=decode_responses,
+                        max_connections=10,
+                        lib_name=f"redis-py(mcp-server_v{__version__})"
+                    )
 
             except redis.exceptions.ConnectionError:
                 print("Failed to connect to Redis server", file=sys.stderr)
@@ -46,6 +80,9 @@ def get_connection(cls, decode_responses=True) -> Redis:
             except redis.exceptions.RedisError as e:
                 print(f"Redis error: {e}", file=sys.stderr)
                 raise
+            except redis.exceptions.ClusterError as e:
+                print(f"Redis Cluster error: {e}", file=sys.stderr)
+                raise
             except Exception as e:
                 print(f"Unexpected error: {e}", file=sys.stderr)
                 raise
