MCP Server Redis

🚀 mcp-server-redis

このプロジェクトは、Redisとの接続や操作を管理するサーバーです。Redisの基本操作や、リスト、ハッシュ表、集合、発行/購読などの操作を提供し、エラーハンドリングも備えています。

🚀 クイックスタート

プロジェクト構造

mcp-server-redis/
├── src/
│   ├── __init__.py
│   ├── main.py           # 主プログラムのエントリーポイント
│   ├── config.py         # 設定ファイル
│   ├── connection.py     # Redis接続管理
│   ├── resources/        # リソースの実装
│   │   ├── __init__.py
│   │   ├── status.py     # 接続状態リソース
│   │   └── keys.py       # キーワード関連リソース
│   └── tools/           # ツールの実装
│       ├── __init__.py
│       ├── basic.py     # 基本的なRedis操作
│       ├── lists.py     # リスト操作
│       ├── hashes.py    # ハッシュ表操作
│       ├── sets.py      # 集合操作
│       └── pubsub.py    # 発行/購読操作
├── tests/              # テストディレクトリ
│   └── __init__.py
├── README.md
└── pyproject.toml

サーバーの使用方法

依存関係のインストール

[まだインストールされていない場合] https://docs.astral.sh/uv/

uv venv
source .venv/bin/activate
uv sync

Redis接続の設定

.env.exampleファイルを参考に、Redis接続を設定し、必要な変数を追加します。

サーバーの起動

python src/server.py

✨ 主な機能

リソース

• redis://status - 現在の接続状態
• redis://info - Redisサーバー情報
• redis://keys/{pattern} - パターンに一致するキーのリスト

ツール

• 基本操作:
  • get_value - 値を取得する
  • set_value - 値を設定し、オプションで有効期限を指定する
  • delete_key - キーを削除する
  • increment - 数値を増やす
• リスト操作:
  • list_push - 値をリストに追加する
  • list_range - リスト内の範囲の値を取得する
• ハッシュ表操作:
  • hash_set - ハッシュフィールドを設定する
  • hash_get - ハッシュフィールドを取得する
• 集合操作:
  • set_add - 集合に要素を追加する
  • set_members - 集合のメンバーを取得する
• 発行/購読:
  • publish_message - メッセージを発行する

各ツールにはエラーハンドリングが含まれており、意味のある応答を返します。接続が失われた場合、サーバーは自動的に再接続します。

テスト方法

MCP Inspectorを使用したテスト

mcp dev src/server.py

Claude Desktopでのインストール

mcp install src/server.py

💻 使用例

基本的な使用法

ユーザー：Redisの現在の接続状態はどうですか？
LLM：Redisの接続状態を確認します。

[リソース redis://status を読み取る]

Redisサーバーは現在localhost:6379で実行中で、データベース0に接続されています。

ユーザー：私の名前「アリス」をRedisに保存できますか？
LLM：set_valueツールを使用して、あなたの名前を保存します。

[set_valueを呼び出し、キー="name"、値="Alice"]
キー'nam'を"Alice"に設定しました。

私はあなたの名前「Alice」をRedisの"name"キーに保存しました。保存が正しいか確認しますか？

ユーザー：確認してください
LLM：get_valueツールを使用して確認します。

[get_valueを呼び出し、キー="name"]
Alice

はい、「Alice」がRedisに正常に保存され、正しく取得できることを確認できます。保存された値と取得された値は完全に一致します。

📚 ドキュメント

この実装はRedis統合のための堅固な基盤を提供しています。具体的なニーズに応じて、より多くのRedisコマンドを追加して機能を拡張することができます。