JinDaGe - redis-mcp-server MCP Details

article

README

🚀 Redis 管理控制协议 (MCP) 服务器

本项目是一个借助 Spring Boot 和 Spring AI 实现的 Redis 管理和控制协议（MCP）服务器，为 Redis 操作提供了一套实用工具，能有效提升 Redis 管理与控制的效率。

🚀 快速开始

本项目实现了一个 Redis MCP 服务器，提供了一组用于 Redis 操作的工具。它使用 spring-ai-mcp-server-webmvc-spring-boot-starter 来实现基于 SSE 的 MCP 功能。

✨ 主要特性

Redis 键值操作：支持 Redis 键值的设置、获取和删除操作。
基于模式的键列出：可根据指定模式列出 Redis 中的键。
可选的键过期时间：在设置键值时，可选择为键设置过期时间。
基于 SSE 的 MCP 实现：利用 spring-ai-mcp-server-webmvc-spring-boot-starter 实现基于 SSE 的 MCP 功能。

📦 安装指南

先决条件

JDK 17 或更高版本
Maven 3.6 或更高版本
Redis 服务器

构建项目

mvn clean package

运行项目

java -jar target/redis-mcp-server-{version}.jar

💻 使用示例

基础用法

服务器配置

Redis 连接可以通过 redis.url 系统属性进行配置。默认值为 redis://localhost:6379。

java -Dredis.url=redis://your-redis-host:6379 -jar your-app.jar

Cursor 工具配置

要在 Cursor 中使用此 MCP 服务器，将以下配置添加到您的 Cursor 设置中：

{
  "redis-mcp-server": {
    "url": "http://localhost:8080/sse",
    "enabled": true
  }
}

📚 详细文档

API 端点

该服务器暴露了以下 MCP 工具：

set：设置 Redis 键值对，可选过期时间
get：通过键获取 Redis 值
delete：删除一个或多个键
list：列出与模式匹配的 Redis 键

组件信息

| 属性 | 详情 | |------|------| | 模型类型 | 无 | | 训练数据 | 无 | | 使用框架 | Spring Boot、Spring AI、Spring Data Redis、Lettuce Redis 客户端、Jackson、spring-ai-mcp-server-webmvc-spring-boot-starter |

📄 许可证

该项目在 MIT License 下 licensed。

redis-mcp-server