Customredis

🚀 Redis MCP 服务器

Redis MCP 服务器是一个专业的实现方案，它集成了 MCP（模型控制协议），并采用 Docker 进行容器化。该服务器能有效解决 Redis 操作管理难题，为用户提供便捷、稳定的 Redis 服务。

🚀 快速开始

1. 克隆仓库：

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

2. 启动服务：

docker-compose up -d

3. 查看日志：

docker-compose logs -f

✨ 主要特性

• 具备持久化功能的 Redis 服务器，保障数据安全。
• 集成 MCP 服务器，可进行 Redis 操作。
• 支持 Docker 和 Docker Compose，方便部署。
• 拥有全面的错误处理和日志记录机制。
• 支持通过环境变量进行配置。
• 提供 Redis 服务健康检查功能。

📦 安装指南

先决条件

• Docker
• Docker Compose

💻 使用示例

可用的 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 = '*'): 列出匹配模式的所有键

📚 详细文档

配置

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

开发

本地开发

1. 创建虚拟环境：

python -m venv .venv
source .venv/bin/activate  # 在 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      # 主服务器实现文件
├── Dockerfile         # Docker 配置文件
├── docker-compose.yml # Docker Compose 配置文件
├── requirements.txt   # Python 依赖项
├── .env              # 环境变量文件
└── README.md         # 本文件

错误处理

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

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

日志记录

应用程序使用 Python 的 logging 模块，具有以下功能：

• 带时间戳的日志条目
• 不同日志级别（INFO, WARNING, ERROR）
• 详细错误信息
• 操作成功/失败日志

使用与 Claude Desktop 集成

要将此 Redis MCP 服务器与 Claude Desktop 一起使用，请在您的 Claude Desktop 设置中添加以下配置：

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

此配置：

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

⚠️ 重要提示

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

📄 许可证

MIT License