redis-mcp

Redis MCP 服务，支持 standalone、代理入口、Sentinel、Cluster、TLS 和 Unix socket 等 Redis 架构，用于安全读取和受控操作 Redis 数据。

该包面向需要访问 Redis 的 MCP 客户端。连接信息可以通过环境变量传入，也可以通过 JSON 配置文件传入，配置文件支持多个工作区和多个 Redis 源。源码和 npm 包中不包含真实账号、主机、密码、token 或个人本机路径。

文档

• 配置说明
• MCP 工具
• English README

安装

npm install -g @chenyingxian/redis-mcp

也可以不全局安装，直接使用：

npx @chenyingxian/redis-mcp

快速配置

Standalone Redis 或 Redis 代理入口：

REDIS_MCP_MODE=standalone
REDIS_URL=redis://localhost:6379/0
REDIS_MCP_READ_ONLY=true
REDIS_MCP_MAX_SCAN_COUNT=100
REDIS_MCP_MAX_RESULT_BYTES=1048576

MCP 客户端配置示例：

{
  "mcpServers": {
    "redis": {
      "command": "npx",
      "args": ["-y", "@chenyingxian/redis-mcp@latest"],
      "env": {
        "REDIS_MCP_MODE": "standalone",
        "REDIS_URL": "redis://localhost:6379/0",
        "REDIS_MCP_READ_ONLY": "true"
      }
    }
  }
}

配置文件维护工具默认只读。只有在需要 MCP 客户端新增、更新、删除或切换 Redis 源时，才设置 REDIS_MCP_ALLOW_CONFIG_MUTATION=true。

Sentinel、Cluster、TLS、Unix socket 和安全控制配置见 CONFIG.zh-CN.md。

多个 Redis 源可以通过 REDIS_MCP_CONFIG_FILE 指向 JSON 配置文件：

{
  "mcpServers": {
    "redis": {
      "command": "npx",
      "args": ["-y", "@chenyingxian/redis-mcp@latest"],
      "env": {
        "REDIS_MCP_CONFIG_FILE": "/path/to/redis-mcp.config.json"
      }
    }
  }
}

工具

• redis_ping：检查 Redis 连接。
• redis_list_sources：列出已配置的 Redis 工作区和源。
• redis_config_read：读取脱敏后的配置文件内容。
• redis_config_upsert_source：新增或更新一个 Redis 源配置。
• redis_config_remove_source：删除一个 Redis 源配置。
• redis_config_set_default：设置某个工作区的默认源。
• redis_get：读取字符串值。
• redis_set：写入字符串值，可设置过期时间。
• redis_delete：删除一个或多个 key。
• redis_exists：检查 key 是否存在。
• redis_expire：设置 key 过期时间。
• redis_ttl：读取 key TTL。
• redis_type：读取 key 类型。
• redis_scan：按 pattern 扫描 key。
• redis_hgetall：读取 hash 全部字段。
• redis_hset：写入 hash 字段。
• redis_lrange：读取 list 范围。
• redis_smembers：读取 set 成员。
• redis_zrange：读取 sorted set 范围。
• redis_info：读取 Redis INFO，支持原始文本或解析后的 JSON。
• redis_command：执行允许的 Redis 命令。

参数和行为说明见 MCP_TOOLS.zh-CN.md。

安全说明

• 只需要查询时，建议设置 REDIS_MCP_READ_ONLY=true。
• Redis 支持 ACL 时，建议使用最小权限账号。
• 不要发布真实 .env 文件、内部主机、用户名、密码、token 或私有连接串。
• FLUSHALL、FLUSHDB、CONFIG、SHUTDOWN、MODULE、DEBUG 等危险管理命令默认禁止。
• 可以使用 REDIS_MCP_KEY_PREFIX 限制 key 操作范围。