MCP Server Redis

🚀 MCP Server Redis

This project provides a Redis server with various operations and resource management capabilities, facilitating interaction with Redis.

🚀 Quick Start

Project Structure

The project structure is as follows:

mcp-server-redis/
├── src/
│   ├── __init__.py
│   ├── main.py           # Main program entry
│   ├── config.py         # Configuration file
│   ├── connection.py     # Redis connection management
│   ├── resources/        # Resource implementation
│   │   ├── __init__.py
│   │   ├── status.py     # Connection status resource
│   │   └── keys.py       # Keyword-related resources
│   └── tools/           # Tool implementation
│       ├── __init__.py
│       ├── basic.py     # Basic Redis operations
│       ├── lists.py     # List operations
│       ├── hashes.py    # Hash table operations
│       ├── sets.py      # Set operations
│       └── pubsub.py    # Publish/Subscribe operations
├── tests/              # Test directory
│   └── __init__.py
├── README.md
└── pyproject.toml

Installation

Install the required dependencies: [If not already installed] https://docs.astral.sh/uv/

uv venv
source .venv/bin/activate
uv sync

Refer to the .env.example file to configure the Redis connection and add the corresponding variables.

Run the Server

python src/server.py

✨ Features

Resources

• redis://status - Current connection status
• redis://info - Redis server information
• redis://keys/{pattern} - List of keys matching the pattern

Tools

• Basic Operations:
  • get_value - Get a value
  • set_value - Set a value with an optional expiration time
  • delete_key - Delete a key
  • increment - Increment a numeric value
• List Operations:
  • list_push - Push a value to a list
  • list_range - Get a range of values from a list
• Hash Table Operations:
  • hash_set - Set a hash field
  • hash_get - Get a hash field
• Set Operations:
  • set_add - Add to a set
  • set_members - Get set members
• Publish/Subscribe:
  • publish_message - Publish a message

Each tool includes error handling and returns meaningful responses. If the connection is lost, the server will automatically reconnect.

Testing

You can use MCP Inspector for testing:

mcp dev src/server.py

Or install it in Claude Desktop:

mcp install src/server.py

💻 Usage Examples

Basic Usage

User: What is the current Redis connection status?
LLM: Let me check the Redis connection status.

[Read resource redis://status]

The Redis server is currently running on localhost:6379, and database 0 is connected.

User: Can you store my name "Alice" in Redis?
LLM: I'll use the set_value tool to store your name.

[Call set_value, key="name", value="Alice"]
Successfully set key 'name' to "Alice"

I've stored your name "Alice" under the "name" key in Redis. Do you need to confirm if the storage is correct?

User: Please verify it.
LLM: I'll use the get_value tool to verify.

[Call get_value, key="name"]
Alice

Yes, I can confirm that "Alice" has been successfully stored in Redis and can be retrieved correctly. The stored and retrieved values are exactly the same.

📚 Documentation

This implementation provides a solid foundation for Redis integration. You can add more Redis commands according to your specific needs to expand the functionality.