draft to store vectors in hashes

Author: mortensi

README.md

@@ -29,15 +29,15 @@ To configure the Redis Cloud API MCP Server, consider the following environment
 
 | Name                    | Description                                               | Default Value |
 |-------------------------|-----------------------------------------------------------|---------------|
-| `REDIS_HOST`            | Redis IP or hostname                                      | '127.0.0.1'   |
-| `REDIS_PORT`            | Redis port                                                | 6379          |
-| `REDIS_USERNAME`        | Default database username                                 | 'default'     |
-| `REDIS_PWD`             | Default database password                                 | ''            |
-| `REDIS_SSL`             | Enables or disables SSL/TLS                               | False         |
+| `REDIS_HOST`            | Redis IP or hostname                                      | `"127.0.0.1"` |
+| `REDIS_PORT`            | Redis port                                                | `6379`        |
+| `REDIS_USERNAME`        | Default database username                                 | `"default"`   |
+| `REDIS_PWD`             | Default database password                                 | ""            |
+| `REDIS_SSL`             | Enables or disables SSL/TLS                               | `False`       |
 | `REDIS_CA_PATH`         | CA certificate for verifying server                       | None          |
 | `REDIS_SSL_KEYFILE`     | Client's private key file for client authentication       | None          |
 | `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_CERT_REQS`       | Whether the client should verify the server's certificate | `"required"`  |
 | `REDIS_CA_CERTS`        | Path to the trusted CA certificates file                  | None          |
 
 ## Integration with Claude Desktop

pyproject.toml

@@ -8,4 +8,5 @@ dependencies = [
     "mcp[cli]>=1.5.0",
     "redis>=5.2.1",
     "dotenv>=0.9.9",
+    "numpy>=2.2.4",
 ]

src/common/config.py

@@ -1,3 +1,4 @@
+import urllib
 from dotenv import load_dotenv
 import os
 
@@ -12,4 +13,44 @@
              "ssl_keyfile": os.getenv('REDIS_SSL_KEYFILE', None),
              "ssl_certfile": os.getenv('REDIS_SSL_CERTFILE', None),
              "ssl_cert_reqs": os.getenv('REDIS_SSL_CERT_REQS', 'required'),
-             "ssl_ca_certs": os.getenv('REDIS_SSL_CA_CERTS', None)}
+             "ssl_ca_certs": os.getenv('REDIS_SSL_CA_CERTS', None)}
+
+
+def generate_redis_uri():
+    cfg = REDIS_CFG
+    scheme = "rediss" if cfg.get("ssl") else "redis"
+    host = cfg.get("host", "127.0.0.1")
+    port = cfg.get("port", 6379)
+
+    username = cfg.get("username")
+    password = cfg.get("password")
+
+    # Auth part
+    if username:
+        auth_part = f"{urllib.parse.quote(username)}:{urllib.parse.quote(password)}@"
+    elif password:
+        auth_part = f":{urllib.parse.quote(password)}@"
+    else:
+        auth_part = ""
+
+    # Base URI
+    base_uri = f"{scheme}://{auth_part}{host}:{port}"
+
+    # Additional SSL query parameters if SSL is enabled
+    query_params = {}
+    if cfg.get("ssl"):
+        if cfg.get("ssl_cert_reqs"):
+            query_params["ssl_cert_reqs"] = cfg["ssl_cert_reqs"]
+        if cfg.get("ssl_ca_certs"):
+            query_params["ssl_ca_certs"] = cfg["ssl_ca_certs"]
+        if cfg.get("ssl_keyfile"):
+            query_params["ssl_keyfile"] = cfg["ssl_keyfile"]
+        if cfg.get("ssl_certfile"):
+            query_params["ssl_certfile"] = cfg["ssl_certfile"]
+        if cfg.get("ssl_ca_path"):
+            query_params["ssl_ca_path"] = cfg["ssl_ca_path"]
+
+    if query_params:
+        base_uri += "?" + urllib.parse.urlencode(query_params)
+
+    return base_uri

src/common/connection.py

@@ -5,6 +5,9 @@
 from typing import Optional
 from common.config import REDIS_CFG
 
+from common.config import generate_redis_uri
+
+
 class RedisConnectionManager:
     _instance: Optional[Redis] = None
 

src/common/server.py

@@ -3,6 +3,6 @@
 # Initialize FastMCP server
 mcp = FastMCP(
     "Redis MCP Server",
-    dependencies=["redis", "dotenv"]
+    dependencies=["redis", "dotenv", "numpy"]
 )
 

src/main.py

@@ -15,7 +15,7 @@
 
 class RedisMCPServer:
     def __init__(self):
-        redis_client = RedisConnectionManager.get_connection()
+        redis_client = RedisConnectionManager.get_connection(decode_responses=False)
         print(redis_client.ping())
 
     def run(self):

src/tools/hash.py

@@ -1,6 +1,7 @@
 from common.connection import RedisConnectionManager
 from redis.exceptions import RedisError
 from common.server import mcp
+import numpy as np
 
 
 @mcp.tool()
@@ -97,3 +98,55 @@ async def hexists(name: str, key: str) -> bool:
         return r.hexists(name, key)
     except RedisError as e:
         return f"Error checking existence of field '{key}' in hash '{name}': {str(e)}"
+
+@mcp.tool()
+async def set_vector_in_hash(name: str, key: str, vector: list) -> bool:
+    """Store a vector as a field in a Redis hash.
+
+    Args:
+        name: The Redis hash key.
+        key: The field name inside the hash.
+        vector: The vector (list of numbers) to store in the hash.
+
+    Returns:
+        True if the vector was successfully stored, False otherwise.
+    """
+    try:
+        r = RedisConnectionManager.get_connection()
+
+        # Convert the vector to a NumPy array, then to a binary blob using np.float32
+        vector_array = np.array(vector, dtype=np.float32)
+        binary_blob = vector_array.tobytes()
+
+        r.hset(name, key, binary_blob)
+        return True
+    except RedisError as e:
+        return f"Error storing vector in hash '{name}' with key '{key}': {str(e)}"
+
+
+@mcp.tool()
+async def get_vector_from_hash(name: str, key: str):
+    """Retrieve a vector from a Redis hash and convert it back from binary blob.
+
+    Args:
+        name: The Redis hash key.
+        key: The field name inside the hash.
+
+    Returns:
+        The vector as a list of floats, or an error message if retrieval fails.
+    """
+    try:
+        r = RedisConnectionManager.get_connection(decode_responses=False)
+
+        # Retrieve the binary blob stored in the hash
+        binary_blob = r.hget(name, key)
+
+        if binary_blob:
+            # Convert the binary blob back to a NumPy array (assuming it's stored as float32)
+            vector_array = np.frombuffer(binary_blob, dtype=np.float32)
+            return vector_array.tolist()
+        else:
+            return f"Field '{key}' not found in hash '{name}'."
+
+    except RedisError as e:
+        return f"Error retrieving vector from hash '{name}' with key '{key}': {str(e)}"

src/tools/misc.py

@@ -4,24 +4,6 @@
 from common.server import mcp
 
 
-@mcp.tool()
-async def execute_raw_command(command: str, *args) -> str:
-    """Execute a raw Redis raw command like SET, GET, HSET, HGET, JSON.SET, JSON.GET, FT.SEARCH or FT.AGGREGATE.
-       Every Redis command can be executed using this call
-
-    Args:
-        command (str): The Redis command to execute.
-        *args: Additional arguments for the command.
-
-    Returns:
-        str: The result of the command execution or an error message.
-    """
-    try:
-        r = RedisConnectionManager.get_connection()
-        return r.execute_command(command, *args)
-    except RedisError as e:
-        return f"Error executing command {command}: {str(e)}"
-
 @mcp.tool()  
 async def get_key_info(key: str) -> Dict[str, Any]:
     try:

src/tools/redis_query_engine.py

@@ -34,7 +34,7 @@ async def get_index_info(index_name: str) -> str:
 
 
 @mcp.tool()
-async def get_indexed_keys(index_name: str) -> str:
+async def get_indexed_keys_number(index_name: str) -> str:
     """Retrieve the number of indexed keys by the index
 
     Args:
@@ -48,3 +48,4 @@ async def get_indexed_keys(index_name: str) -> str:
         return r.ft(index_name).search(Query("*")).total
     except RedisError as e:
         return f"Error retrieving number of keys: {str(e)}"
+