Redis MCP Server

io.github.YawLabs由 GitHub 账号 YawLabs 发布v0.5.6更新于 Oct 31, 2026

Read-first Redis MCP: SCAN key explorer, keyspace/TTL/memory/slowlog stats, DBA advisor

已验证STDIO仅桌面数据库安全与监控

概览

AI 生成的概览

以只读为先的 Redis MCP 服务器,让助手通过基于 SCAN 的工具安全地浏览键、查看值并诊断实例健康状况。

可以做什么
  • 用基于游标的 SCAN 枚举键,可按 glob 模式或值类型过滤,并支持续传游标
  • 查看单个键的类型、TTL、编码、内存占用和空闲时间,而不读取其值
  • 按类型读取值(字符串、哈希、列表、集合、有序集合、流),集合读取有窗口上限
  • 通过安全网关执行单条 Redis 命令,仅在显式开启时才允许写操作
  • 基于 INFO、DBSIZE 和 SLOWLOG 获取健康快照,并查看最近的慢日志条目
  • 运行顾问检查,标记大键、缺少 TTL、淘汰压力和 fork 延迟风险
适用场景
适合让助手回答“这个实例里有什么、是否健康、该关注什么”这类问题,包括面对拥有数百万键的生产实例。它是浏览与诊断工具,而非用于发布订阅、脚本、集群或复制控制的通用管理控制台。
运行要求
通过 npx(Node.js)或 oam 运行时以 stdio 在本地运行。需要 REDIS_URL 连接字符串,实例要求认证时需包含凭据;TLS 使用 rediss://。可选变量控制写操作(ALLOW_WRITES)、超时、扫描与取值上限、TLS 校验和沙箱。支持 Redis 6+ 与 Valkey。
安装前请注意
REDIS_URL 通常内嵌 Redis 密码,应存入密钥保管库而非明文配置。写操作默认关闭,但 ALLOW_WRITES=1 会允许 SET、DEL、EXPIRE 等变更命令,应仅用于开发/测试环境,并优先使用最小权限的 Redis ACL 用户。将 REDIS_TLS_REJECT_UNAUTHORIZED 设为 false 会关闭证书校验。键值和统计信息会发送给模型。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Redis MCP Server,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@yawlabs/redis-mcp

[Add to Yaw MCP]

One click adds this to your local Yaw MCP config so it's available in every Yaw Terminal session. Or install manually below.

Then give it your REDIS_URL. The button deliberately carries no connection string, and Yaw MCP will not prompt for one: it asks only for variables whose names look like credentials, and REDIS_URL does not. Until it is set, the server exits at startup with REDIS_URL is not set. Store it in Yaw MCP's encrypted vault in one step:

bash
yaw-mcp set redis env.REDIS_URL --secret

The value is read from a no-echo prompt (or piped stdin), never from the command line; the vault entry is named redis_redis_url and the server's entry gets "REDIS_URL": "${secret:redis_redis_url}". Yaw MCP reads the vault when it starts the server, so after changing the value run mcp_connect_deactivate redis (or start a new session) for the new one to take effect.

[npm version] [License: MIT]

Explore and diagnose a Redis instance from Claude Code, Cursor, and any MCP client. Read-only by default - writes opt in via a single env var - and key enumeration always uses SCAN, never the O(N) KEYS, so it is safe to point at a production instance with millions of keys.

Built and maintained by Yaw Labs.

Why this one?

  • SCAN, never KEYS. Every key-enumeration path uses cursor-based SCAN with a bounded COUNT and an iteration cap. KEYS * is O(N) over the entire keyspace and blocks Redis's single-threaded event loop for the full scan - a self-inflicted outage on a large instance. SCAN yields between batches. See Security.
  • Read-first command gate. Tools run a curated read-only command allowlist by default. Mutating commands (SET, DEL, EXPIRE, HSET, ...) require ALLOW_WRITES=1. Arbitrary-execution commands (EVAL, FUNCTION, SCRIPT, MULTI, MONITOR, SHUTDOWN, CLUSTER, ...) are never exposed, even with writes on - the gate is a curated allowlist, not "anything when writes are enabled".
  • Type-aware reads without surprises. redis_get dispatches by value type (string / hash / list / set / zset / stream) and windows collection reads to a cap, so a million-element list can't blow out the model context. redis_key_info reads type / TTL / encoding / memory footprint without pulling the value at all.
  • Health in one call. redis_health rolls up INFO + DBSIZE + recent SLOWLOG into memory pressure, eviction policy, hit rate, ops/sec, persistence status, replication role, per-database key counts (and how many lack a TTL), and the most recent slow commands.
  • A real advisor. redis_advisor is the "what should I be looking at?" lint pass: big keys, missing TTLs, eviction pressure (including the dangerous noeviction + no-TTL combination), and fork-latency risk - each with a severity and an actionable fix. Keys are SCAN-sampled, so it is safe on a large instance.
  • Instant startup. Ships as a single bundled file with zero runtime dependencies. No multi-minute node_modules install on every npx cold start.

Scope

This server is a read-first explorer and diagnostician, not a general Redis admin console. It deliberately does not expose EVAL/FUNCTION/SCRIPT, pub/sub, MONITOR, cluster management, or replication control. For those, use redis-cli directly. The goal here is the safe, common 90%: "what's in this instance, is it healthy, and what should I worry about?" - the questions an agent should be able to answer against a production Redis without risk.

Works against Redis 6+ and Valkey. A few redis_health fields (latest_fork_usec, aof_enabled) depend on the running server exposing them in INFO; missing fields surface as null rather than erroring.

Quick start

1. Create .mcp.json in your project root

macOS / Linux / WSL:

json
{  "mcpServers": {    "redis": {      "command": "npx",      "args": ["-y", "@yawlabs/redis-mcp@latest"],      "env": {        "REDIS_URL": "redis://:password@host:6379/0"      }    }  }}

Windows:

json
{  "mcpServers": {    "redis": {      "command": "cmd",      "args": ["/c", "npx", "-y", "@yawlabs/redis-mcp@latest"],      "env": {        "REDIS_URL": "redis://:password@host:6379/0"      }    }  }}

Why the extra step on Windows? Since Node 20, child_process.spawn cannot directly execute .cmd files (that's what npx is on Windows). Wrapping with cmd /c is the standard workaround.

2. Restart and approve

Restart Claude Code (or your MCP client) and approve the redis MCP server when prompted.

3. (Optional) Enable writes

Read-only is the default. To let the agent run mutating commands (SET, DEL, EXPIRE, HSET, ...) via redis_command, add ALLOW_WRITES=1:

json
"env": {  "REDIS_URL": "redis://...",  "ALLOW_WRITES": "1"}

Prefer scoping this to dev/test instances. Even with writes on, arbitrary-execution commands stay blocked.

Security

SCAN, not KEYS - this is the load-bearing choice. Redis is single-threaded. KEYS pattern walks the entire keyspace in one uninterruptible operation; on an instance with millions of keys it blocks every other client for the duration - effectively a denial of service you triggered yourself. Every key-enumeration path in this server (redis_scan, the advisor's key sampling, redis_get's set reads) uses cursor-based SCAN/SSCAN with a bounded COUNT and a hard iteration cap, which yields the event loop between batches. KEYS is explicitly rejected by the command gate with a nudge to redis_scan.

Read-only by default. Without ALLOW_WRITES=1, only commands on the read-only allowlist run; everything else is rejected before it reaches Redis. With ALLOW_WRITES=1, a curated set of mutating commands is additionally permitted - but arbitrary-execution commands (EVAL, FUNCTION, SCRIPT, MULTI/EXEC, MONITOR, SHUTDOWN, REPLICAOF, CLUSTER, MIGRATE, ...) remain blocked in all modes. The gate is fail-closed: a command on neither allowlist is rejected, so a command we never anticipated can't slip through.

Use Redis ACLs as the primary control. As with a database role, the cleanest posture is a least-privileged Redis user (ACL SETUSER mcp on >pass ~* +@read) in REDIS_URL. Redis then enforces the boundary server-side, independent of this server's gate. ALLOW_WRITES is defense-in-depth on top of that.

See SECURITY.md for vulnerability reporting.

Tools

ToolDescription
redis_scanEnumerate keys with cursor-based SCAN (never KEYS). Optional glob match, value-type filter, and resumable cursor. Capped at REDIS_MAX_KEYS.
redis_key_infoInspect one key without reading its value: type, TTL (s/ms), encoding, memory footprint, idle time. The big-key / missing-TTL probe.
redis_getRead a key's value, dispatching by type (string / hash / list / set / zset / stream). Collection reads windowed by limit. Always read-only.
redis_commandRun a single Redis command through the safety gate. Reads always run; writes need ALLOW_WRITES=1; KEYS and arbitrary-execution commands are blocked. The escape hatch for commands without a dedicated tool.
redis_healthOne-call health snapshot from INFO + DBSIZE + SLOWLOG: memory pressure, eviction policy, hit rate, ops/sec, persistence, replication role, per-db key counts, recent slow commands.
redis_slowlogRecent entries from the Redis slow log - command, microseconds, timestamp, client. Read-only (SLOWLOG GET).
redis_advisorRolled-up health lints in one call: big keys, missing TTLs, eviction pressure, fork-latency risk. Each finding has a severity and a fix. SCAN-sampled, safe on large instances.

Configuration

All env vars are read from the MCP server's environment. The last three are read by the redis-mcp launcher rather than the server, so they have no effect when a host runs dist/index.js directly - and neither does the launcher's oam version check (see Runtime):

VariableDefaultPurpose
REDIS_URL(required)Redis connection string, e.g. redis://:pass@host:6379/0 or rediss://... for TLS.
ALLOW_WRITESunsetSet to 1 or true to permit curated mutating commands via redis_command. Arbitrary-execution commands stay blocked regardless.
REDIS_COMMAND_TIMEOUT_MS10000Per-command timeout. A command that runs longer is aborted so a wedged call can't hang the agent.
REDIS_CONNECT_TIMEOUT_MS10000TCP connect timeout. Without this, a dead host hangs until the OS gives up (~2 minutes).
REDIS_MAX_KEYS1000Cap on keys returned by a single scan, and on collection elements returned by redis_get. Clamped to 1000000; a fraction is rounded down, and a value below 1 or a non-numeric one falls back to the default.
REDIS_MAX_VALUE_BYTES262144Cap, in bytes, on a string value returned by redis_get (256 KiB). A longer string comes back as its first REDIS_MAX_VALUE_BYTES bytes, with truncated: true and its full length. Clamped to 64000000 (64 MB); a fraction is rounded down, and a value below 1 or a non-numeric one falls back to the default. A host may cap a whole tool result below this - Yaw MCP keeps the first 100,000 bytes by default (YAW_MCP_MAX_RESULT_BYTES) - so redis_get puts length and truncated (and a collection's size) before the value: a cut there drops payload, never the fields that say the value was cut.
REDIS_SCAN_COUNT100COUNT hint per SCAN iteration. Higher = fewer round-trips but more work per iteration. Clamped to 1000000; a fraction is rounded down, and a value below 1 or a non-numeric one falls back to the default.
REDIS_TLS_REJECT_UNAUTHORIZEDunsetSet to false to skip TLS certificate verification - the chain and the hostname check. The connection is still encrypted, but no longer authenticated. A last resort for a private CA: prefer NODE_EXTRA_CA_CERTS, see Connecting to managed Redis.
REDIS_MCP_RUNTIMEautoWhich JS runtime executes the server: auto (the newest oam it can find at 0.19.1 or newer, else Node), oam (the same, but exit with an error instead of falling back), node (always Node - in-process under npx, handed off to Node on PATH when a client launches the command with oam run). Case-insensitive; any other value - a typo like nodejs, or one with surrounding spaces - behaves as auto without a warning. See Runtime.
OAM_BINunsetPath to an oam binary to use in preference to discovery, when it is 0.19.1 or newer. If it does not exist, is older, or will not run, the launcher says so on stderr and carries on with discovery. Ignored under REDIS_MCP_RUNTIME=node, and when the launcher is already running under oam 0.19.1+ unless REDIS_MCP_SANDBOX=1.
REDIS_MCP_SANDBOXunset1 or true (any case, surrounding spaces ignored) runs the server under oam's --permission sandbox: filesystem and child processes denied, network limited to the host and port in REDIS_URL (port 6379 if the URL names none). An IPv6 literal (redis://[::1]:6379) is pinned like any other host. The host and port are read the way ioredis reads them, so a scheme-less REDIS_URL (127.0.0.1:6379), a bare port number, a host or port in the query string, and a URL with no host (localhost) are pinned too. An absolute unix socket path (/run/redis.sock, a scheme-less host/path, or a path in the query string) is pinned as that exact path, plus filesystem read and write on that one path, which is what oam 0.18.0 requires to dial a socket under --permission; a relative socket path cannot be granted at all, and the launcher says the sandbox will refuse it. (oam 0.18.0 is the first oam that dials a unix socket at all; its changelog calls the Unix side of that untested off Windows so far, and so is this grant.) If REDIS_URL names no single endpoint the grant can spell - a URL that does not parse, an empty host, a host containing a comma, or a port outside 1-65535 - the network grant is left open, and the launcher says so on stderr. Any other non-empty value leaves the sandbox off and says so on stderr. It has no effect unless a fresh oam is actually spawned. Every fallback that runs the server without it says so on stderr, but a host may not show stderr, so pair it with REDIS_MCP_RUNTIME=oam, which exits instead of falling back. The launcher only spawns oam 0.19.1 or newer, which has every fix the sandbox depends on: per oam's changelog, --permission did not cover all of fs and child_process until 0.9.1, and the port grant was not exact until 0.15.0.

Connecting to managed Redis (Upstash, ElastiCache, Redis Cloud, etc.)

Use a rediss:// URL for TLS. It works the same on Node and on oam, sandbox included.

If the provider serves a cert signed by a private CA that the runtime's trust store doesn't recognize (symptoms on stderr: self-signed certificate in certificate chain, unable to verify the first certificate, or self-signed certificate, the same on Node and oam), the best fix is to trust that CA: point NODE_EXTRA_CA_CERTS at its PEM file. Node and oam 0.15.3+ both read it, and the connection stays fully verified:

json
"env": {  "REDIS_URL": "rediss://default:pass@host:6379",  "NODE_EXTRA_CA_CERTS": "/path/to/provider-ca.pem"}

If you cannot get the CA certificate, add REDIS_TLS_REJECT_UNAUTHORIZED=false instead:

json
"env": {  "REDIS_URL": "rediss://default:pass@host:6379",  "REDIS_TLS_REJECT_UNAUTHORIZED": "false"}

This turns certificate verification off entirely - the chain and the hostname check - so the connection is still TLS-encrypted end-to-end, but no longer authenticated. Prefer NODE_EXTRA_CA_CERTS wherever you can.

Runtime

The published redis-mcp command is a small launcher that prefers the newest oam JavaScript runtime it can find and falls back to Node. It only uses the latest oam release, currently 0.19.1, and never serves on an older one. If you do not have oam, nothing changes: the fallback is automatic, and because npm has already started Node to run the launcher, it is an in-process import() of the server with no extra spawn.

Why 0.19.1. It is the latest oam release, and the one this server is verified on; the launcher moves its floor up as oam releases, so an oam that works but is older is still passed over. The floor first mattered at 0.15.3. Before that release, oam's TLS socket lacked some of the net.Socket methods ioredis calls and did not close itself when the server hung up, so rediss:// crashed the server on its first tool call (YawLabs/oam#132), and oam ignored NODE_EXTRA_CA_CERTS (YawLabs/oam#136). 0.15.3 fixes both, so from it on TLS behaves as it does on Node. With only an oam older than 0.19.1 available, the launcher runs the server on Node instead - in its own process under npx, or handed off to Node on PATH when a host launches it with an old oam run - and says to run oam self-update (oam's native, signature-verified updater; from an oam older than 0.18.0 it runs the new installer, which needs ssh-keygen 8.1 or later to verify the release). Only when no oam was found at all does it point at oamjs.org. It exits instead when that old oam run host has no Node on PATH, or under REDIS_MCP_RUNTIME=oam. A host that bundles its own oam needs the host's update. A host that runs dist/index.js directly under oam skips all of this; on an oam below 0.15.3 the server then answers every rediss:// tool call with an error naming the version to update to, rather than crashing.

How the runtime is chosen:

  • Already on oam. If the launcher itself is running under oam 0.19.1+ (a host that runs oam run on the bin), the server is imported into that process: nothing is discovered or spawned, OAM_BIN is ignored, and REDIS_MCP_RUNTIME=oam is satisfied. REDIS_MCP_SANDBOX=1 skips this step, because only a freshly spawned oam can apply --permission: the launcher relaunches the oam it is running on with the sandbox, even when that oam is in no install location and not on PATH (a usable OAM_BIN still takes precedence).
  • Otherwise, discovery. The launcher uses OAM_BIN if it is 0.19.1 or newer. Otherwise it asks every oam it can find - OAM_INSTALL_DIR when set, the default install locations (%LOCALAPPDATA%\oam\bin then ~/.oam/bin on Windows, ~/.oam/bin elsewhere), then PATH - for its version, and spawns the newest one at 0.19.1 or newer; on a tie the installed copy wins. On Windows only oam.exe counts. An OAM_BIN that does not exist, is older, or will not run is named on stderr and discovery carries on.
  • No usable oam. Under auto the server runs in the launcher's own process instead (an old oam host hands off, see below). The launcher says so on stderr when it passed over an OAM_BIN, a found oam that was too old or would not run, or (on Windows) an oam.cmd / oam.bat on PATH, when the chosen oam failed to launch, and whenever REDIS_MCP_SANDBOX=1 was set. A note that passed over a working oam that is only too old says to update it. With no oam found at all and no sandbox asked for, it falls back silently; the handoff from an old oam host is always noted, in one message written once the launcher knows whether a Node was found. Once oam has started, a failure while running the server is a startup failure, not a fallback.
  • An old oam host never serves. If the launcher is running under an oam older than 0.19.1, it hands the server off to the newest usable oam, else to Node on PATH, and exits with an error when there is neither.
  • Overrides. REDIS_MCP_RUNTIME=oam turns every fallback into a startup failure. REDIS_MCP_RUNTIME=node skips discovery and always runs Node: in the launcher's own process under Node, handed off to Node on PATH under oam.

A child the launcher starts from an oam host gets its NODE_OPTIONS with any inherited --permission / --allow-* removed: oam (since 0.18.0) appends its own permission flags to every child's NODE_OPTIONS, and the sandbox this launcher applies is passed on the spawned oam's command line, never through the environment.

No fallback carries --permission - not in-process, and not a handoff to Node - so with REDIS_MCP_SANDBOX=1 under auto the server can end up unsandboxed. Every such fallback says so on stderr (without --permission), but a host may not show stderr. Set REDIS_MCP_RUNTIME=oam alongside it when an unsandboxed server is not acceptable.

Troubleshooting

REDIS_URL is not set - Your MCP client is launching the server without the env var. On Windows especially, env vars set in bash / PowerShell profiles are not inherited by MCP servers launched via cmd. Put REDIS_URL directly in the env block of .mcp.json. Under Yaw MCP, set it with yaw-mcp set redis env.REDIS_URL --secret (see the top of this page).

NOAUTH Authentication required - The instance requires a password and the URL has none. Add it: redis://:yourpassword@host:6379 (note the leading colon - the username is empty for the default user).

<COMMAND> mutates state and is blocked: ALLOW_WRITES is not set - You asked for a write through redis_command in read-only mode. Add ALLOW_WRITES=1 to the env block (dev/test), or - cleaner - use a Redis ACL user scoped to the access you want.

KEYS is blocked - Intentional. Use redis_scan (cursor-based) to enumerate keys; it is safe on a large keyspace where KEYS is not.

First command is slow, subsequent commands are fast - Expected. The client connects lazily on the first command; later commands reuse the connection.

Development

bash
npm installnpm test          # build + unit tests (no live Redis needed)npm run check:compliance   # @yawlabs/mcp-compliance, on Node and on oam, against a local RESP stubnpm run check:oam-floor    # OAM_MIN agrees with the docs and tests, and is the latest oam release

The unit suite covers the pure logic - command allowlist enforcement, SCAN cursor paging, INFO/SLOWLOG parsing, and the advisor heuristics - and runs without a Redis instance. Integration tests that exercise live paths (npm run test:integration) require a disposable Redis at REDIS_URL.

License

MIT © 2026 YawLabs

[Follow @YawLabs on X]

来源:README.md,提交 4a8594d

工具

0
SourceWeft 曾在隔离沙箱中以无凭据方式启动该软件包一次,以列出其工具,但未能完成:服务器未能启动。

版本历史

5
  1. v0.5.6最新Oct 31, 2026
  2. v0.5.5Oct 11, 2026
  3. v0.5.3Oct 6, 2026
  4. v0.5.2Sep 29, 2026
  5. v0.5.1Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分