Customredis

🚀 Redis MCP Server

A professional Redis server implementation with MCP (Model Control Protocol) integration, containerized using Docker.

✨ Features

• A Redis server with persistence.
• Integration of an MCP server for Redis operations.
• Support for Docker and Docker Compose.
• Comprehensive error handling and logging.
• Configuration via environment variables.
• Health checks for the Redis service.

📦 Prerequisites

• Docker
• Docker Compose

🚀 Quick Start

1. Clone the repository:

git clone https://github.com/cbuitragoh/customRedis.git
cd customredis

2. Start the service:

docker-compose up -d

3. View the logs:

docker-compose logs -f

💻 Usage Examples

Basic Usage

The MCP server provides the following Redis operations:

• set_redis_key(key: str, value: str): Set a key - value pair.
• get_redis_key(key: str): Get the value by key.
• delete_redis_key(key: str): Delete a key.
• list_redis_keys(pattern: str = '*'): List all keys matching the pattern.

📚 Documentation

Configuration

The application can be configured via environment variables:

Development

Local Development

1. Create a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

2. Install the dependencies:

pip install -r requirements.txt

3. Start the server:

python src/server.py

Docker Development

1. Build the image:

docker-compose build

2. Run the service:

docker-compose up

Project Structure

.
├── src/
│   └── server.py      # Main server implementation file
├── Dockerfile         # Docker configuration file
├── docker-compose.yml # Docker Compose configuration file
├── requirements.txt   # Python dependencies
├── .env              # Environment variable file
└── README.md         # This file

Error Handling

The application includes comprehensive error handling:

• Connection errors.
• Redis operation errors.
• Server startup/shutdown errors.
• Graceful shutdown when receiving a keyboard interrupt.

Logging

The application uses Python's logging module with the following features:

• Timestamped log entries.
• Different log levels (INFO, WARNING, ERROR).
• Detailed error information.
• Logs for successful/failed operations.

Integration with Claude Desktop

To use this Redis MCP server with Claude Desktop, add the following configuration to your Claude Desktop settings:

{
  "mcpServers": {
    "redis": {
            "command": "docker",
            "args": [
                "run", 
                "-i",
                "--rm",
                "--network",
                "customredis_redis-network",
                "customredis-mcp-server"
            ]
    }
  }
}

This configuration:

• Runs the Redis MCP server using Docker.
• Connects to the Redis instance using the same network as the Redis container.
• Runs in interactive mode (-i).
• Removes the container after use (--rm).

⚠️ Important Note

1. Ensure that the Redis container is running (the redis service from docker - compose).
2. Ensure that the Redis port (6379) is accessible.
3. Ensure that Docker is running properly on your system.

📄 License

MIT License