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