🚀 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 命令，根据具体需求进一步扩展该项目的功能。