Prajwalnayak7 MCP Server Redis

🚀 MCP Server Redis

本項目是一個基於 MCP 框架的 Redis 集成服務，提供了對 Redis 各種操作的封裝，包括連接管理、資源獲取和常用工具操作，方便開發者快速與 Redis 進行交互。

🚀 快速開始

安裝依賴項

如果尚未安裝，請先安裝以下依賴項： [如果沒有安裝]請參考 https://docs.astral.sh/uv/

uv venv
source .venv/bin/activate
uv sync

參考 .env.example 文件配置 Redis 連接，添加相應的變量。

啟動服務器

python src/server.py

📦 安裝指南

依賴安裝

若未安裝相關依賴，可參考 uv 文檔 進行安裝。安裝命令如下：

uv venv
source .venv/bin/activate
uv sync

配置 Redis 連接

參考 .env.example 文件，添加相應的變量以配置 Redis 連接。

💻 使用示例

基礎用法

以下是一個使用示例，展示瞭如何查詢 Redis 連接狀態和存儲數據：

用戶: 現在 Redis 的連接狀態如何？
LLM: 讓我查看一下 Redis 連接狀態。

[讀取資源 redis://status]

Redis 服務器當前正常連接，運行於 localhost:6379，數據庫 0。

用戶: 能否將我的名字 "Alice" 存入 Redis？
LLM: 我會使用 set_value 工具幫助您存儲名字。

[調用 set_value，鍵="name"，值="Alice"]
成功設置鍵 'name'

我已經在 Redis 下的鍵 "name" 中為您存儲了名字 "Alice"。是否需要確認存儲是否正確？

用戶: 請驗證一下
LLM: 我會使用 get_value 工具進行驗證。

[調用 get_value，鍵="name"]
Alice

確實，我可以確認您的名字 "Alice" 已經成功存儲在 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    # Hash 表操作
│       ├── sets.py      # 集合操作
│       └── pubsub.py    # 發佈/訂閱操作
├── tests/              # 測試目錄
│   └── __init__.py
├── README.md
└── pyproject.toml

服務器功能

資源

• redis://status - 當前連接狀態
• redis://info - Redis 服務器信息
• redis://keys/{pattern} - 列出匹配指定模式的鍵

工具

基本操作

• get_value - 獲取值
• set_value - 設置值，可選設置過期時間
• delete_key - 刪除鍵
• increment - 自增數值

列表操作

• list_push - 向列表推入值
• list_range - 獲取列表範圍內的值

Hash 表操作

• hash_set - 設置 Hash 字段
• hash_get - 獲取 Hash 字段

集合操作

• set_add - 添加到集合
• set_members - 獲取集合成員

發佈/訂閱操作

• publish_message - 發佈消息

每個工具均包含錯誤處理，並返回有意義的響應。服務器會在連接丟失後自動重新連接 Redis。

測試與安裝

您可以通過 MCP Inspector 測試它：

mcp dev src/server.py

或在 Claude Desktop 中安裝：

mcp install src/server.py

項目擴展

此實現為 MCP 框架中的 Redis 集成提供了一個堅實的基礎。您可以通過添加更多 Redis 命令，根據具體需求進一步擴展該項目的功能。