Prajwalnayak7 MCP Server Redis

🚀 MCP Server Redis

This project provides a Redis integration for the MCP framework, offering various Redis operations and resource management.

🚀 Quick Start

Project Structure

mcp-server-redis/
├── src/
│   ├── __init__.py
│   ├── main.py           # Main program entry point
│   ├── config.py         # Configuration management
│   ├── 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

Usage

Install Dependencies:

If not already installed, please install the following dependencies first:

[If not installed] Refer to https://docs.astral.sh/uv/

uv venv
source .venv/bin/activate
uv sync

Configure the Redis connection by referring to the .env.example file and add the corresponding variables.

Start the Server:

python src/server.py

✨ Features

Resources:

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

Tools:

Basic Operations:

• get_value - Get a value
• set_value - Set a value, optionally set an 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 values within a list range

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 Operations:

• publish_message - Publish a message

Each tool includes error handling and returns meaningful responses. The server will automatically reconnect to Redis after a connection loss.

You can test it via MCP Inspector:

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 connected and running at localhost:6379, database 0.

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

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

I've stored your name "Alice" in the key "name" 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

Indeed, I can confirm that your name "Alice" has been successfully stored in Redis and can be retrieved correctly. The stored value matches what we set.

📚 Documentation

This implementation provides a solid foundation for Redis integration in the MCP framework. You can further expand the project's functionality by adding more Redis commands according to your specific needs.