mcpField
R
redis-mcp

redis-mcp

Local
github.com/upstashDatabases0Updated 16w ago

About redis-mcp

redis-mcp is a lightweight MCP server for developers who need AI clients to run Redis commands or look up Upstash documentation. It supports HTTP/REST or TCP, multiple database configurations, pipelines, and atomic transactions.

Key features

  1. 01Run commands over HTTP/REST or TCP
  2. 02Support pipelines and atomic transactions
  3. 03Configure and select multiple databases
  4. 04Search Upstash Redis documentation
  5. 05Optionally reject write commands

Use cases

  1. 01Read or modify Redis data from an AI client
  2. 02Run batches of independent Redis commands
  3. 03Execute a group of Redis operations atomically
  4. 04Look up Redis commands and Upstash features

MCP support

The MCP server provides redis_run_commands and redis_search_docs for clients to run Redis operations and search Upstash Redis documentation.

Configuration

Local server config is the same for every client. Copy it into your client’s MCP config file.

mcp.json · Universal config
{
"mcpServers": {
"upstash-redis": {
"command": "npx",
"args": [
"-y",
"@upstash/redis-mcp"
],
"env": {
"UPSTASH_REDIS_REST_URL": "<UPSTASH_REDIS_REST_URL>",
"UPSTASH_REDIS_REST_TOKEN": "<UPSTASH_REDIS_REST_TOKEN>",
"UPSTASH_REDIS_TCP_URL": "<UPSTASH_REDIS_TCP_URL>"
}
}
}
}
Run commandnpx -y @upstash/redis-mcp
Environment variables to set
UPSTASH_REDIS_REST_URLUpstash Redis REST URL (HTTP transport).
UPSTASH_REDIS_REST_TOKENSecretUpstash Redis REST token (HTTP transport).
UPSTASH_REDIS_TCP_URLSecretUpstash Redis rediss:// connection string (TCP transport).

Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.

Packages
npm@upstash/redis-mcp0.1.1

Tools

2

Saved tool list · updated 2w ago

ParameterTypeRequiredDescription
commandsarrayYesRedis commands; each is an array of args. Single: [["SET","foo","bar"]]. Multiple: [["SET","foo","bar"],["GET","foo"]]. Numbers are accepted and coerced to strings, so ["EXPIRE","k",60], ["ZADD","z",80,"bob"] and Lua numkeys ["EVAL",script,1,key] all work.
rest_urlstringNoRaw HTTP credential override: Upstash REST URL (must be paired with rest_token).
rest_tokenstringNoRaw HTTP credential override: Upstash REST token (must be paired with rest_url).
transactionbooleanNoRun all commands in one MULTI/EXEC transaction (queued, executed together, no interleaving). Like standard Redis, a runtime error in one command does NOT roll back the others. Default false (pipeline).
connection_stringstringNoRaw TCP credential override: rediss:// connection string.

Details

From the project README

Upstash Redis MCP

Add to Cursor

Lightweight MCP server for Redis with only two tools:

  • 🧪 redis_run_commands: run one or more Redis commands over HTTP/REST or TCP, as a pipeline or an atomic transaction.
  • 📚 redis_search_docs: search the Redis docs using Context7 public api.

One server can hold multiple named databases. Configuration is pure environment variables and CLI flags.

🔌 Quickstart

Claude Code

Run this in your terminal. See the Claude Code MCP docs for more.

claude mcp add upstash-redis \
  -e UPSTASH_REDIS_REST_URL=https://<your-db>.upstash.io \
  -e UPSTASH_REDIS_REST_TOKEN=<your-rest-token> \
  -- npx -y @upstash/redis-mcp
Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (per-project), or go to Settings → MCP → Add new MCP server. See the Cursor MCP docs.

{
  "mcpServers": {
    "upstash-redis": {
      "command": "npx",
      "args": ["-y", "@upstash/redis-mcp"],
      "env": {
        "UPSTASH_REDIS_REST_URL": "https://<your-db>.upstash.io",
        "UPSTASH_REDIS_REST_TOKEN": "<your-rest-token>"
      }
    }
  }
}
VS Code

Add to .vscode/mcp.json (per-project) or your user mcp settings. See the VS Code MCP docs.

{
  "servers": {
    "upstash-redis": {
      "command": "npx",
      "args": ["-y", "@upstash/redis-mcp"],
      "env": {
        "UPSTASH_REDIS_REST_URL": "https://<your-db>.upstash.io",
        "UPSTASH_REDIS_REST_TOKEN": "<your-rest-token>"
      }
    }
  }
}
Codex

Add to ~/.codex/config.toml (or a project-level .codex/config.toml). See the Codex MCP docs.

[mcp_servers.upstash-redis]
command = "npx"
args = ["-y", "@upstash/redis-mcp"]
env = { UPSTASH_REDIS_REST_URL = "https://<your-db>.upstash.io", UPSTASH_REDIS_REST_TOKEN = "<your-rest-token>" }
OpenCode

Add to opencode.json (project) or ~/.config/opencode/opencode.json (global). See the OpenCode MCP docs.

{
  "mcp": {
    "upstash-redis": {
      "type": "local",
      "command": ["npx", "-y", "@upstash/redis-mcp"],
      "environment": {
        "UPSTASH_REDIS_REST_URL": "https://<your-db>.upstash.io",
        "UPSTASH_REDIS_REST_TOKEN": "<your-rest-token>"
      }
    }
  }
}

Tip

Any MCP-compatible client works. If yours isn't listed, add a stdio server that runs npx -y @upstash/redis-mcp with the two env vars above.

🧰 Tools

🧪 redis_run_commands

Run any Redis command: GET, SET, SCAN, ZADD, EVAL, the SEARCH.* family, and everything else. Each command is an array of args (numbers are accepted and coerced to strings). By default multiple commands run as a pipeline: each returns its own result/error, aligned to the input, and one failure doesn't abort the rest. Set transaction: true for an atomic MULTI/EXEC.

{
  "commands": [
    ["SET", "visits", 0],
    ["INCR", "visits"],
    ["GET", "visits"],
  ],
  "transaction": false, // optional: true => atomic MULTI/EXEC
  // "database": "prod"       // only when more than one database is configured
  // raw credential overrides (optional):
  // "rest_url", "rest_token" // HTTP
  // "connection_string"      // TCP, rediss://
}

The transport (HTTP vs TCP) is determined by how the target database is configured; the agent never picks it.

📚 redis_search_docs

Searches the Upstash Redis documentation live and returns the most relevant pages. Reach for it whenever you're unsure about a command or feature, especially Upstash-specific ones like the SEARCH.* full-text search family. It's powered by Context7's free tier, so no API key or extra setup is required.

{ "query": "SEARCH.AGGREGATE date histogram" }

⚙️ Configuration

Everything is set through environment variables and CLI flags; there are no config files.

Single database
TransportEnvironmentCLI
HTTPUPSTASH_REDIS_REST_URL + UPSTASH_REDIS_REST_TOKEN--rest-url <url> --rest-token <token>
TCPUPSTASH_REDIS_TCP_URL (or REDIS_URL)--url <rediss://…>
Multiple databases

Give each database a name. The name becomes a selectable database value in redis_run_commands.

Environment: insert a <NAME> segment:

UPSTASH_REDIS_PROD_REST_URL="https://prod-db.upstash.io"
UPSTASH_REDIS_PROD_REST_TOKEN="<prod-rest-token>"
UPSTASH_REDIS_CACHE_TCP_URL="rediss://default:<password>@cache-db.upstash.io:6379"

CLI: repeat --database to start each group:

npx -y @upstash/redis-mcp \
  --database prod  --rest-url https://prod-db.upstash.io --rest-token <prod-rest-token> \
  --database cache --url rediss://default:<password>@cache-db.upstash.io:6379

Note

Raw credentials per call. A redis_run_commands call may also pass rest_url + rest_token (HTTP) or connection_string (TCP) inline; these override the registry and work even with no configured database. They flow through the model's context, so prefer env/CLI for anything sensitive.

Flags & options
FlagEnvDefaultPurpose
--transport <stdio|http>stdioServer transport
--port <n>3000Port for the http transport
--readonlyUPSTASH_REDIS_READONLYoffBest-effort: reject write commands on both transports. Server-side read-only REST tokens remain the robust option.
--disable-telemetryUPSTASH_DISABLE_TELEMETRYoffStop sending Upstash-Telemetry-* headers on HTTP requests
--debugoffVerbose logging to stderr + redis-mcp-debug.log

📡 Telemetry

HTTP/REST requests carry Upstash-Telemetry-{Sdk,Platform,Runtime} headers. Disable with --disable-telemetry or UPSTASH_DISABLE_TELEMETRY=true.

🏃 Run it locally

bun install
bun run build                 # emits dist/index.js
cp .env.example .env          # add UPSTASH_REDIS_REST_URL + UPSTASH_REDIS_REST_TOKEN

node dist/index.js                          # stdio (what clients spawn)
node dist/index.js --transport http --port 3000   # HTTP: endpoint /mcp, health /ping

The server auto-loads .env. To point a client at your local build, swap npx -y @upstash/redis-mcp in any Quickstart config for node /absolute/path/to/redis-mcp/dist/index.js.

🛠️ Development

bun install
bun run build
bun test
bun run lint

📄 License

MIT © Upstash

Comments

Markdown supported

New to MCP?

From what the protocol is to installing your first server, these answers cover most first questions.

An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.