Redis MCP Server

Redis MCP Server

site icon
2025.01.09 6
TypeScriptRedis 数据库操作数据存储数据检索数据库
Redis MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,提供对 Redis 数据库操作的访问。它支持多种 Redis 命令,包括字符串、哈希、集合和有序集合等操作,适用于需要高效数据存储和检索的场景。
View on GitHub

Overview

基本能力

产品定位

Redis MCP Server 是一个为 Redis 数据库操作提供接口的 MCP 服务,旨在简化 Redis 数据库的访问和管理。

核心功能

  • 支持多种 Redis 命令,包括字符串、哈希、集合和有序集合操作。
  • 提供工具化的接口,便于集成到 MCP 客户端中。
  • 支持自定义工具扩展,方便开发者根据需求添加新的 Redis 操作。

适用场景

  • 需要高效数据存储和检索的应用。
  • 需要实时数据处理的系统。
  • 需要复杂数据结构(如哈希、集合、有序集合)管理的场景。

工具列表

工具名称 类型 描述
hmset 哈希命令 设置多个哈希字段的值
hget 哈希命令 获取哈希字段的值
hgetall 哈希命令 获取哈希中所有字段和值
scan 键命令 扫描匹配模式的 Redis 键
set 字符串命令 设置字符串值
get 字符串命令 获取字符串值
del 键命令 删除键
zadd 有序集合命令 添加成员到有序集合
zrange 有序集合命令 按索引范围返回有序集合成员
zrangebyscore 有序集合命令 按分数范围返回有序集合成员
zrem 有序集合命令 从有序集合中移除成员
sadd 集合命令 添加成员到集合
smembers 集合命令 获取集合中所有成员

常见问题解答

  • 如何添加新的 Redis 工具?
  • src/tools/ 中创建新工具类,继承 RedisTool
  • src/interfaces/types.ts 中定义工具接口。
  • src/tools/tool_registry.ts 中注册工具。

使用教程

使用依赖

  • 确保已安装 Node.js 和 npm。
  • 确保 Redis 服务已启动并运行在指定主机和端口。

安装教程

  1. 通过 Smithery 自动安装: bash npx -y @smithery/cli install redis-mcp --client claude
  2. 手动配置 MCP 客户端: json { "mcpServers": { "redis": { "command": "npx", "args": ["redis-mcp", "--redis-host", "localhost", "--redis-port", "6379"], "disabled": false } } }

调试方式

  • 确保 Redis 服务运行正常。
  • 检查 MCP 客户端配置是否正确。
  • 使用 Redis 命令行工具验证数据操作是否成功。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。