Customredis

🚀 Redis MCP サーバー

このプロジェクトは、MCP（モデル制御プロトコル）を統合した専用の Redis サーバーを提供し、Docker コンテナ化されています。

✨ 主な機能

• 永続化機能付きの Redis サーバー
• Redis 操作を行うための MCP サーバーが統合されている
• 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  # 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