tools renamed

Author: mortensi

README.md

@@ -147,5 +147,5 @@ npx @modelcontextprotocol/inspector uv run src/main.py
 This project is licensed under the **MIT License**.
 
 ## Contact
-For questions or support, reach out via [GitHub Issues](https://github.com/redis/mcp-redis-server/issues).
+For questions or support, reach out via [GitHub Issues](https://github.com/redis/mcp-redis/issues).
 

examples/redis_assistant.py

@@ -7,14 +7,18 @@
 
 # Set up and create the agent
 async def build_agent():
-    # Redis MCP Server
+    # Redis MCP Server. Pass the environment configuration for the MCP Server in the JSON
     server = MCPServerStdio(
         params={
             "command": "uv",
             "args": [
                 "--directory", "../src/", # change with the path to the MCP server
                 "run", "main.py"
             ],
+        "env": {
+            "REDIS_HOST": "127.0.0.1",
+            "REDIS_PORT": "6379"
+        },
         }
     )
 

src/tools/json.py

@@ -66,21 +66,3 @@ async def json_del(name: str, path: str = '$') -> str:
     except RedisError as e:
         return f"Error deleting JSON value at path '{path}' in '{name}': {str(e)}"
 
-
-@mcp.tool()
-async def json_expire(name: str, expire_seconds: int) -> str:
-    """Set an expiration time for a Redis JSON document.
-
-    Args:
-        name: The Redis key where the JSON document is stored.
-        expire_seconds: Time in seconds after which the key should expire.
-
-    Returns:
-        A success message or an error message.
-    """
-    try:
-        r = RedisConnectionManager.get_connection()
-        success = r.expire(name, expire_seconds)
-        return f"Expiration set to {expire_seconds} seconds for JSON document '{name}'." if success else f"JSON document '{name}' does not exist."
-    except RedisError as e:
-        return f"Error setting expiration for JSON document '{name}': {str(e)}"

src/tools/misc.py

@@ -4,8 +4,34 @@
 from common.server import mcp
 
 
+@mcp.tool()
+async def delete(key: str) -> str:
+    """Delete a Redis key.
+
+    Args:
+        key (str): The key to delete.
+
+    Returns:
+        str: Confirmation message or an error message.
+    """
+    try:
+        r = RedisConnectionManager.get_connection()
+        result = r.delete(key)
+        return f"Successfully deleted {key}" if result else f"Key {key} not found"
+    except RedisError as e:
+        return f"Error deleting key {key}: {str(e)}"
+
+
 @mcp.tool()  
-async def get_key_info(key: str) -> Dict[str, Any]:
+async def type(key: str) -> Dict[str, Any]:
+    """Returns the string representation of the type of the value stored at key
+
+    Args:
+        key (str): The key to check.
+
+    Returns:
+        str: The type of key, or none when key doesn't exist
+    """
     try:
         r = RedisConnectionManager.get_connection()
         key_type = r.type(key).decode('utf-8')
@@ -40,7 +66,7 @@ async def expire(name: str, expire_seconds: int) -> str:
 
 
 @mcp.tool()
-async def rename_key(old_key: str, new_key: str) -> Dict[str, Any]:
+async def rename(old_key: str, new_key: str) -> Dict[str, Any]:
     """
     Renames a Redis key from old_key to new_key.
 

src/tools/server_management.py

@@ -3,7 +3,7 @@
 from common.server import mcp
 
 @mcp.tool()
-async def get_dbsize() -> int:
+async def dbsize() -> int:
     """Get the number of keys stored in the Redis database
     """
     try:
@@ -14,7 +14,7 @@ async def get_dbsize() -> int:
 
 
 @mcp.tool()
-async def get_redis_info(section: str = "default") -> dict:
+async def info(section: str = "default") -> dict:
     """Get Redis server information and statistics.
 
     Args:
@@ -32,7 +32,7 @@ async def get_redis_info(section: str = "default") -> dict:
 
 
 @mcp.tool()
-async def get_client_list() -> list:
+async def client_list() -> list:
     """Get a list of connected clients to the Redis server."""
     try:
         r = RedisConnectionManager.get_connection()

src/tools/sorted_set.py

@@ -4,7 +4,7 @@
 
 
 @mcp.tool()
-async def add_to_sorted_set(key: str, score: float, member: str, expiration: int = None) -> str:
+async def zadd(key: str, score: float, member: str, expiration: int = None) -> str:
     """Add a member to a Redis sorted set with an optional expiration time.
 
     Args:
@@ -28,7 +28,7 @@ async def add_to_sorted_set(key: str, score: float, member: str, expiration: int
 
 
 @mcp.tool()
-async def get_sorted_set_range(key: str, start: int, end: int, with_scores: bool = False) -> str:
+async def zrange(key: str, start: int, end: int, with_scores: bool = False) -> str:
     """Retrieve a range of members from a Redis sorted set.
 
     Args:
@@ -49,7 +49,7 @@ async def get_sorted_set_range(key: str, start: int, end: int, with_scores: bool
 
 
 @mcp.tool()
-async def remove_from_sorted_set(key: str, member: str) -> str:
+async def zrem(key: str, member: str) -> str:
     """Remove a member from a Redis sorted set.
 
     Args:

src/tools/stream.py

@@ -4,7 +4,7 @@
 
 
 @mcp.tool()
-async def add_to_stream(key: str, fields: dict, expiration: int = None) -> str:
+async def xadd(key: str, fields: dict, expiration: int = None) -> str:
     """Add an entry to a Redis stream with an optional expiration time.
 
     Args:
@@ -27,7 +27,7 @@ async def add_to_stream(key: str, fields: dict, expiration: int = None) -> str:
 
 
 @mcp.tool()
-async def read_from_stream(key: str, count: int = 1) -> str:
+async def xrange(key: str, count: int = 1) -> str:
     """Read entries from a Redis stream.
 
     Args:
@@ -46,7 +46,7 @@ async def read_from_stream(key: str, count: int = 1) -> str:
 
 
 @mcp.tool()
-async def delete_from_stream(key: str, entry_id: str) -> str:
+async def xdel(key: str, entry_id: str) -> str:
     """Delete an entry from a Redis stream.
 
     Args:

src/tools/string.py

@@ -4,7 +4,7 @@
 
 
 @mcp.tool()
-async def set_redis_string(key: str, value: str, expiration: int = None) -> str:
+async def set(key: str, value: str, expiration: int = None) -> str:
     """Set a Redis string value with an optional expiration time.
 
     Args:
@@ -27,7 +27,7 @@ async def set_redis_string(key: str, value: str, expiration: int = None) -> str:
 
 
 @mcp.tool()
-async def get_redis_string(key: str) -> str:
+async def get(key: str) -> str:
     """Get a Redis string value.
 
     Args:
@@ -43,20 +43,3 @@ async def get_redis_string(key: str) -> str:
     except RedisError as e:
         return f"Error retrieving key {key}: {str(e)}"
 
-
-@mcp.tool()
-async def delete_redis_key(key: str) -> str:
-    """Delete a Redis key.
-
-    Args:
-        key (str): The key to delete.
-
-    Returns:
-        str: Confirmation message or an error message.
-    """
-    try:
-        r = RedisConnectionManager.get_connection()
-        result = r.delete(key)
-        return f"Successfully deleted {key}" if result else f"Key {key} not found"
-    except RedisError as e:
-        return f"Error deleting key {key}: {str(e)}"