Redis MCP Server

Redis MCP 服务

一个专业的 Redis 服务实现，集成 MCP（Model Control Protocol），并使用 Docker 容器化。

功能

• 支持持久化的 Redis 服务
• 集成 MCP 服务以执行 Redis 操作
• 支持 Docker 和 Docker Compose
• 全面的错误处理和日志记录
• 基于环境变量的配置
• Redis 服务健康检查

前置条件

• Docker
• Docker Compose

快速开始

1. 克隆仓库：

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

2. 启动服务：

docker-compose up -d

3. 查看日志：

docker-compose logs -f

可用的 Redis 操作

MCP 服务提供以下 Redis 操作：

• set_redis_key(key: str, value: str)：设置键值对
• get_redis_key(key: str)：根据键获取值
• delete_redis_key(key: str)：删除键
• list_redis_keys(pattern: str = '*')：列出所有匹配模式的键

配置

可通过环境变量配置应用：

• REDIS_HOST：Redis 服务主机（默认值：redis）
• REDIS_PORT：Redis 服务端口（默认值：6379）
• REDIS_DB：Redis 数据库编号（默认值：0）
• LOG_LEVEL：日志级别（默认值：INFO）

开发

本地开发

1. 创建虚拟环境：

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

2. 安装依赖：

pip install -r requirements.txt

3. 运行服务：

python src/server.py

Docker 开发

1. 构建镜像：

docker-compose build

2. 运行服务：

docker-compose up

项目结构

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

错误处理

应用包含全面的错误处理：

• 连接错误
• Redis 操作错误
• 服务启动／关闭错误
• 键盘中断时优雅关闭

日志记录

应用使用 Python 的 logging 模块，并具备以下功能：

• 基于时间戳的日志条目
• 不同的日志级别（INFO、WARNING、ERROR）
• 详细的错误消息
• 操作成功／失败日志

在 Claude Desktop 中使用

若要在 Claude Desktop 中使用此 Redis MCP 服务，请将以下配置添加到 Claude Desktop 设置中：

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

此配置：

• 使用 Docker 运行 Redis MCP 服务
• 使用主机的 Redis 实例连接 Redis
• 以交互模式运行（-i）
• 使用后移除容器（--rm）
• 将 MCP 服务连接到与 Redis 容器相同的网络

请确保：

1. Redis 正在 docker-compose 的 redis 服务容器中运行
2. Redis 端口（6379）可访问
3. Docker 正在系统上运行

许可证

MIT 许可证