Redis MCP服务器

一个集成了MCP(模型控制协议)的Redis服务器实现,支持Docker容器化部署,提供Redis操作、错误处理和日志记录等功能。

  • by cbuitragoh
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 cbuitragoh/customredis

使用说明

Redis MCP服务器

Redis服务器与MCP(模型控制协议)集成的专业实现,用Docker容器化。

特性

  • 具有持久性的Redis服务器
  • Redis操作的MCP服务器集成
  • Docker和Docker Compose支持
  • 全面的错误处理和记录
  • 基于环境的配置
  • Redis服务的健康检查

先决条件

  • 码头工人
  • Docker Compose

快速开始

  1. 克隆存储库:
git clone https://github.com/cbuitragoh/customRedis.git
cd customredis
  1. 启动服务:
docker-compose up -d
  1. 检查日志:
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
  1. 安装依赖项:
pip install -r requirements.txt
  1. 运行服务器:
python src/server.py

Docker开发

  1. 塑造形象:
docker-compose build
  1. 运行服务:
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的日志模块,具有以下功能:

  • 基于时间戳的日志条目
  • 不同的日志级别(信息、警告、错误)
  • 详细的错误消息
  • 操作成功/失败记录

与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)
  • 将MCP服务器连接到Redis容器的同一网络

确保:

  1. Redis正在docker compose Redis服务的容器中运行
  2. Redis端口(6379)可访问
  3. Docker正在您的系统上运行

许可证

MIT许可证