You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: rewrite README with per-client install guides
Restructure the README around per-client install instructions (Claude
Code, Cursor, Windsurf, OpenCode, Codex, VS Code, Antigravity, Claude
Desktop, Gemini CLI), document the optional Upstash Box API key wiring,
and expand the debugging/telemetry sections.
Fix the Cursor one-click install deeplink — the previous payload used a
single `command` string, but Cursor expects `command` + `args` split.
Also drop the Smithery badge, drop the redundant `--transport stdio`
flag from the Claude Code install command, and add `--scope user` so
the install lands in the user-level config by default.
[<imgalt="Install in VS Code"src="https://img.shields.io/badge/Install%20in%20VS%20Code-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white">](https://insiders.vscode.dev/redirect/mcp/install?name=upstash&inputs=%5B%7B%22id%22%3A%22email%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20email%22%7D%2C%7B%22id%22%3A%22apiKey%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20API%20key%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fmcp-server%40latest%22%2C%22--email%22%2C%22%24%7Binput%3Aemail%7D%22%2C%22--api-key%22%2C%22%24%7Binput%3AapiKey%7D%22%5D%7D)
4
5
5
-
[<imgalt="Install in VS Code (npx)"src="https://img.shields.io/badge/Install%20in%20VS%20Code-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22upstash-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fmcp-server%40latest%22%2C%22--email%22%2C%22YOUR_EMAIL%22%2C%22--api-key%22%2C%22YOUR_API_KEY%22%5D%7D)
6
+
The Upstash MCP server lets your agent manage and debug your Upstash resources directly, across **Redis**, **QStash**, **Workflow**, and **[Upstash Box](https://upstash.com/docs/box/overall/quickstart)**.
> For most workflows, prefer installing the [Upstash Skill](https://upstash.com/docs/agent-resources/skills) and letting your agent drive [`@upstash/cli`](https://upstash.com/docs/agent-resources/cli) over running the MCP server.
8
10
9
-
The Upstash MCP gives your agent the ability to interact with your Upstash account, such as:
11
+
## Quickstart
10
12
11
-
### Redis
13
+
You'll need your Upstash account email and an API key — create one at [Upstash Console → Account → API Keys](https://console.upstash.com/account/api).
12
14
13
-
- "Create a new Redis in us-east-1"
14
-
- "List my databases that have high memory usage"
15
-
- "Give me the schema of how users are stored in redis"
16
-
- "Create a backup and clear db"
17
-
- "Give me the spikes in throughput during the last 7 days"
15
+
The Upstash MCP server works with any MCP-compatible client. If your client isn't listed below, check its documentation for how to add a stdio MCP server, then point it at the base command:
> Readonly API keys are supported. When the server starts with one, it automatically disables every tool that would modify state (creating databases, deleting backups, retrying workflows, etc.). Your agent can still read and query your account, but it cannot make changes.
20
23
21
-
- "Check the logs and figure out what is wrong"
22
-
- "Find me failed workflows of user @ysfk_0x"
23
-
- "Restart the failed workflow run started in last 2 hours"
24
-
- "Check DLQ and give me a summary"
24
+
<details>
25
+
<summary><b>Claude Code</b></summary>
25
26
26
-
# Usage
27
+
Run this command in your terminal. See the [Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp) for more info.
27
28
28
-
## Quick Setup
29
+
```sh
30
+
claude mcp add --scope user upstash -- npx -y @upstash/mcp-server@latest --email YOUR_EMAIL --api-key YOUR_API_KEY
31
+
```
29
32
30
-
First, get your Upstash credentials:
33
+
</details>
31
34
32
-
-**Email**: Your Upstash account email
33
-
-**API Key**: Get it from [Upstash Console → Account → API Keys](https://console.upstash.com/account/api)
35
+
<details>
36
+
<summary><b>Cursor</b></summary>
34
37
35
-
Add this to your MCP client configuration:
38
+
Go to `Settings` → `Cursor Settings` → `MCP` → `Add new global MCP server`.
39
+
40
+
Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See the [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
41
+
42
+
Since Cursor 1.0, you can click the install button below for instant one-click installation. Replace `YOUR_EMAIL` and `YOUR_API_KEY` with your real values before confirming.
Add this to your Windsurf MCP config file at `~/.codeium/windsurf/mcp_config.json`. See the [Windsurf MCP docs](https://docs.windsurf.com/windsurf/cascade/mcp) for more info.
70
+
71
+
```json
72
+
{
73
+
"mcpServers": {
74
+
"upstash": {
75
+
"command": "npx",
76
+
"args": [
77
+
"-y",
78
+
"@upstash/mcp-server@latest",
79
+
"--email",
80
+
"YOUR_EMAIL",
81
+
"--api-key",
82
+
"YOUR_API_KEY"
83
+
]
84
+
}
85
+
}
86
+
}
87
+
```
88
+
89
+
</details>
90
+
91
+
<details>
92
+
<summary><b>OpenCode</b></summary>
93
+
94
+
Add this to your OpenCode configuration file (`~/.config/opencode/opencode.json` or a project-level `opencode.json`). See the [OpenCode MCP docs](https://opencode.ai/docs/mcp-servers) for more info.
95
+
96
+
```json
97
+
{
98
+
"mcp": {
99
+
"upstash": {
100
+
"type": "local",
101
+
"command": [
102
+
"npx",
103
+
"-y",
104
+
"@upstash/mcp-server@latest",
105
+
"--email",
106
+
"YOUR_EMAIL",
107
+
"--api-key",
108
+
"YOUR_API_KEY"
109
+
],
110
+
"enabled": true
111
+
}
112
+
}
113
+
}
114
+
```
115
+
116
+
</details>
117
+
118
+
<details>
119
+
<summary><b>OpenAI Codex</b></summary>
120
+
121
+
See the [OpenAI Codex MCP docs](https://developers.openai.com/codex/mcp) for more info.
> If you see startup timeout errors, increase `startup_timeout_sec` to `40`.
142
+
143
+
</details>
144
+
145
+
<details>
146
+
<summary><b>VS Code</b></summary>
147
+
148
+
Click to install — VS Code will prompt for your email and API key (stored in its secret storage):
149
+
150
+
[<imgalt="Install in VS Code"src="https://img.shields.io/badge/Install%20in%20VS%20Code-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white" />](https://insiders.vscode.dev/redirect/mcp/install?name=upstash&inputs=%5B%7B%22id%22%3A%22email%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20email%22%7D%2C%7B%22id%22%3A%22apiKey%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20API%20key%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fmcp-server%40latest%22%2C%22--email%22%2C%22%24%7Binput%3Aemail%7D%22%2C%22--api-key%22%2C%22%24%7Binput%3AapiKey%7D%22%5D%7D)
151
+
[<imgalt="Install in VS Code Insiders"src="https://img.shields.io/badge/Install%20in%20VS%20Code%20Insiders-24bfa5?style=for-the-badge&logo=visualstudiocode&logoColor=white" />](https://insiders.vscode.dev/redirect/mcp/install?name=upstash&inputs=%5B%7B%22id%22%3A%22email%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20email%22%7D%2C%7B%22id%22%3A%22apiKey%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Upstash%20API%20key%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fmcp-server%40latest%22%2C%22--email%22%2C%22%24%7Binput%3Aemail%7D%22%2C%22--api-key%22%2C%22%24%7Binput%3AapiKey%7D%22%5D%7D&quality=insiders)
152
+
153
+
Or add this to `.vscode/mcp.json` (or your user `mcp.servers` setting). Using `inputs` with `promptString` means your API key is prompted once and kept in VS Code's secret storage instead of sitting in the config file. See the [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
If you use [Upstash Box](https://upstash.com/docs/box), you can configure the Box API key at startup so you don't have to pass it on every tool call. This is **optional** — Box tools still work without it (the agent will ask you for the key or read it from your `.env`).
180
+
<details>
181
+
<summary><b>Google Antigravity</b></summary>
64
182
65
-
Pass it via the `--box-api-key` CLI flag:
183
+
Add this to your Antigravity MCP config. See the [Antigravity MCP docs](https://antigravity.google/docs/mcp) for more info.
184
+
185
+
```json
186
+
{
187
+
"mcpServers": {
188
+
"upstash": {
189
+
"command": "npx",
190
+
"args": [
191
+
"-y",
192
+
"@upstash/mcp-server@latest",
193
+
"--email",
194
+
"YOUR_EMAIL",
195
+
"--api-key",
196
+
"YOUR_API_KEY"
197
+
]
198
+
}
199
+
}
200
+
}
201
+
```
202
+
203
+
</details>
204
+
205
+
<details>
206
+
<summary><b>Claude Desktop</b></summary>
207
+
208
+
Open Claude Desktop's developer settings and edit `claude_desktop_config.json`. See the [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.
209
+
210
+
```json
211
+
{
212
+
"mcpServers": {
213
+
"upstash": {
214
+
"command": "npx",
215
+
"args": [
216
+
"-y",
217
+
"@upstash/mcp-server@latest",
218
+
"--email",
219
+
"YOUR_EMAIL",
220
+
"--api-key",
221
+
"YOUR_API_KEY"
222
+
]
223
+
}
224
+
}
225
+
}
226
+
```
227
+
228
+
</details>
229
+
230
+
<details>
231
+
<summary><b>Gemini CLI</b></summary>
232
+
233
+
Open the Gemini CLI settings file at `~/.gemini/settings.json` and add Upstash to `mcpServers`. See [Gemini CLI Configuration](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html) for details.
234
+
235
+
```json
236
+
{
237
+
"mcpServers": {
238
+
"upstash": {
239
+
"command": "npx",
240
+
"args": [
241
+
"-y",
242
+
"@upstash/mcp-server@latest",
243
+
"--email",
244
+
"YOUR_EMAIL",
245
+
"--api-key",
246
+
"YOUR_API_KEY"
247
+
]
248
+
}
249
+
}
250
+
}
251
+
```
252
+
253
+
</details>
254
+
255
+
## Example prompts
256
+
257
+
### Redis
258
+
259
+
-_"Create a new Redis database in us-east-1"_
260
+
-_"List my databases sorted by memory usage"_
261
+
-_"Update the user schema by pulling from Redis"_
262
+
-_"Create a backup of this db, then clear it"_
263
+
-_"Show me throughput spikes during the last 7 days"_
264
+
265
+
### QStash & Workflow
266
+
267
+
-_"Check the QStash logs and figure out why my webhook keeps failing"_
268
+
-_"Find failed workflow runs for user `@admin` today"_
269
+
-_"Retry the failed workflow run that started 2 hours ago"_
270
+
-_"Summarize what's in the DLQ right now, grouped by error type"_
271
+
-_"Pause the schedules that are throwing errors"_
272
+
273
+
### Upstash Box
274
+
275
+
-_"Spin up a Box, clone this repo, and run the tests"_
276
+
-_"Snapshot this Box and create 5 copies from it, assign each one a GitHub issue"_
277
+
-_"My Box keeps failing to start, check the logs and tell me what's wrong"_
278
+
279
+
## Upstash Box API key (optional)
280
+
281
+
For the MCP to interact with [Upstash Box](https://upstash.com/docs/box/overall/quickstart), the agent needs your Box API key. By default you have to paste it into the chat (or keep it in a `.env`) every time the agent runs a Box tool. To avoid this, you can wire the key into the MCP setup itself so the server picks it up automatically on startup.
282
+
283
+
You can pass it in two ways.
284
+
285
+
**CLI flag**
66
286
67
287
```json
68
288
{
@@ -84,7 +304,7 @@ Pass it via the `--box-api-key` CLI flag:
84
304
}
85
305
```
86
306
87
-
Or set the `UPSTASH_BOX_API_KEY` environment variable:
307
+
**Environment variable**
88
308
89
309
```json
90
310
{
@@ -107,33 +327,34 @@ Or set the `UPSTASH_BOX_API_KEY` environment variable:
107
327
}
108
328
```
109
329
110
-
### Streamable HTTP Transport (for web applications)
And configure your MCP client to use the HTTP transport:
332
+
If the server is misbehaving or a tool keeps failing, enable verbose logging with the `--debug` flag:
119
333
120
334
```json
121
335
{
122
336
"mcpServers": {
123
337
"upstash": {
124
-
"url": "http://localhost:3000/mcp"
338
+
"command": "npx",
339
+
"args": [
340
+
"-y",
341
+
"@upstash/mcp-server@latest",
342
+
"--email",
343
+
"YOUR_EMAIL",
344
+
"--api-key",
345
+
"YOUR_API_KEY",
346
+
"--debug"
347
+
]
125
348
}
126
349
}
127
350
}
128
351
```
129
352
130
-
## Telemetry
353
+
Every internal event is then written to **stderr**, which your MCP client surfaces in its own log viewer. Share the relevant snippet when reporting an issue on [GitHub](https://github.com/upstash/mcp/issues).
131
354
132
-
The server sends anonymous runtime/platform info to Upstash with each request. To opt out, add `--disable-telemetry` to your args.
133
-
134
-
## Troubleshooting
355
+
## Telemetry
135
356
136
-
See the [troubleshooting guide](https://modelcontextprotocol.io/quickstart#troubleshooting) in the official MCP documentation. You can also reach out to us at [Discord](https://discord.com/invite/w9SenAtbme) for support.
357
+
The server sends anonymous diagnostic info to Upstash with each request: the MCP server SDK version, your runtime version (Node, Bun, etc.), and basic platform info (OS and architecture). **No account data, tool arguments, or results are collected.** To opt out, add `--disable-telemetry` to the args.
137
358
138
359
## Development
139
360
@@ -144,9 +365,9 @@ bun i
144
365
bun run watch
145
366
```
146
367
147
-
This will continuously build the project and watch for changes.
368
+
This continuously builds the project and watches for changes.
148
369
149
-
For testing, you can create a `.env` file in the same directory as the project with the following content:
370
+
For testing, create a `.env` file in the project root:
0 commit comments