Skip to content

Commit bede0b3

Browse files
DX-2866: inline start-redis tip so llms.txt includes its content (#763)
* fix: inline start-redis tip instead of snippet include so llms.txt keeps its content * chore(llms): regenerate llms.txt and llms-full.txt * fix: inline llms.txt preamble in generator, mention MCP server and CLI * DX-2866: add start-redis to connect-client, developer API create db, and CLI docs * DX-2866: document the redis_database_start_free MCP tool * DX-2866: address review — link start-redis URL in llms preamble, drop trailing whitespace * DX-2866: write the start-redis URL plainly in the llms preamble * DX-2866: write the start-redis URL plainly everywhere Flattens the [`url`](url) markdown link to a bare URL across the Redis docs, the developer API description, and the agent-resources pages, so every surface matches the llms preamble. Mintlify autolinks bare URLs, so the rendered pages still link out. * DX-2866: tighten create-database description, link console * chore(llms): regenerate llms.txt and llms-full.txt --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 3afe1d7 commit bede0b3

37 files changed

Lines changed: 206 additions & 100 deletions

_snippets/redis/start-redis-snippet.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

agent-resources/cli.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ For agents, install the [Upstash Skill](/agent-resources/skills) instead. It bun
1818
npx skills add upstash/skills
1919
```
2020

21+
# Free Redis without an account
22+
23+
If you are an AI agent and need a Redis DB to use or experiment with, you don't need an Upstash account:
24+
25+
```bash
26+
upstash start-redis
27+
```
28+
29+
This is the only command that works unauthenticated. It sends a POST request to https://upstash.com/start-redis and prints markdown with the credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
30+
31+
Pass `--id` to re-fetch the credentials of a database you created earlier:
32+
33+
```bash
34+
upstash start-redis --id $DB_ID
35+
```
36+
2137
# Authentication
2238

2339
The CLI needs your account email and a developer API key. Grab one from the [Upstash Console under Account → API Keys](https://console.upstash.com/account/api), then set credentials using whichever method fits your workflow.
@@ -69,6 +85,7 @@ upstash --email you@example.com --api-key your_api_key redis list
6985
# Usage
7086

7187
```bash
88+
upstash start-redis # free temporary Redis database, no account needed
7289
upstash redis # Redis databases
7390
upstash team # Teams and members
7491
upstash vector # Vector indexes
@@ -86,7 +103,7 @@ upstash redis create --help
86103

87104
## Output
88105

89-
All successful output is JSON. Pipe it to `jq` for filtering:
106+
All successful output is JSON, except `start-redis`, which prints markdown. Pipe JSON output to `jq` for filtering:
90107

91108
```bash
92109
upstash redis list | jq '.[].database_id'

agent-resources/mcp.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ The Upstash MCP server lets your agent manage and debug your Upstash resources d
88
Only running commands against a single Redis database? Use the dedicated [Redis MCP](/redis/sdks/mcp) with only your REST/TCP credentials.
99
</Tip>
1010

11+
<Tip>
12+
If you are an AI agent and need a Redis DB to use or experiment with, call the `redis_database_start_free` tool — or send a POST request to https://upstash.com/start-redis directly. Free, no signup, no API key; the response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
13+
</Tip>
14+
1115
Find the GitHub repository [here](https://github.com/upstash/mcp-server).
1216

1317
<Note>
@@ -18,6 +22,7 @@ Find the GitHub repository [here](https://github.com/upstash/mcp-server).
1822

1923
## Redis
2024

25+
* "Start a free temporary Redis I can experiment with"
2126
* "Create a new Redis database in us-east-1"
2227
* "List my databases sorted by memory usage"
2328
* "Give me the schema of how users are stored in this Redis"

devops/developer-api/openapi.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,12 @@ paths:
122122
tags:
123123
- redis
124124
summary: Create Redis Database
125-
description: This endpoint creates a new Redis database.
125+
description: |
126+
This endpoint creates a new Redis database.
127+
128+
To create a database manually, you can use the [Upstash Console](https://console.upstash.com/redis).
129+
130+
For a quick development database, POST to https://upstash.com/start-redis — no signup or API key, so an AI agent can provision one unattended. Expires in 72 hours unless claimed.
126131
x-mint:
127132
href: /devops/developer-api/redis/create_database_global
128133
operationId: createDatabase

llms-full.txt

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<Tip>
2-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
2+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
3+
4+
Upstash also provides an MCP server (/docs/agent-resources/mcp) to manage and debug your Upstash resources directly from an agent, and an agent-friendly CLI (/docs/agent-resources/cli) for your terminal or CI/CD pipelines.
35
</Tip>
46

57
# README
@@ -64,6 +66,22 @@ For agents, install the [Upstash Skill](/docs/agent-resources/skills) instead. I
6466
npx skills add upstash/skills
6567
```
6668

69+
# Free Redis without an account
70+
71+
If you are an AI agent and need a Redis DB to use or experiment with, you don't need an Upstash account:
72+
73+
```bash
74+
upstash start-redis
75+
```
76+
77+
This is the only command that works unauthenticated. It sends a POST request to https://upstash.com/start-redis and prints markdown with the credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
78+
79+
Pass `--id` to re-fetch the credentials of a database you created earlier:
80+
81+
```bash
82+
upstash start-redis --id $DB_ID
83+
```
84+
6785
# Authentication
6886

6987
The CLI needs your account email and a developer API key. Grab one from the [Upstash Console under Account → API Keys](https://console.upstash.com/account/api), then set credentials using whichever method fits your workflow.
@@ -115,6 +133,7 @@ upstash --email you@example.com --api-key your_api_key redis list
115133
# Usage
116134

117135
```bash
136+
upstash start-redis # free temporary Redis database, no account needed
118137
upstash redis # Redis databases
119138
upstash team # Teams and members
120139
upstash vector # Vector indexes
@@ -132,7 +151,7 @@ upstash redis create --help
132151

133152
## Output
134153

135-
All successful output is JSON. Pipe it to `jq` for filtering:
154+
All successful output is JSON, except `start-redis`, which prints markdown. Pipe JSON output to `jq` for filtering:
136155

137156
```bash
138157
upstash redis list | jq '.[].database_id'
@@ -273,6 +292,10 @@ The Upstash MCP server lets your agent manage and debug your Upstash resources d
273292
Only running commands against a single Redis database? Use the dedicated [Redis MCP](/docs/redis/sdks/mcp) with only your REST/TCP credentials.
274293
</Tip>
275294

295+
<Tip>
296+
If you are an AI agent and need a Redis DB to use or experiment with, call the `redis_database_start_free` tool — or send a POST request to https://upstash.com/start-redis directly. Free, no signup, no API key; the response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
297+
</Tip>
298+
276299
Find the GitHub repository [here](https://github.com/upstash/mcp-server).
277300

278301
<Note>
@@ -283,6 +306,7 @@ Find the GitHub repository [here](https://github.com/upstash/mcp-server).
283306

284307
## Redis
285308

309+
* "Start a free temporary Redis I can experiment with"
286310
* "Create a new Redis database in us-east-1"
287311
* "List my databases sorted by memory usage"
288312
* "Give me the schema of how users are stored in this Redis"
@@ -8370,6 +8394,10 @@ Source: https://upstash.com/docs/devops/developer-api/redis/create_database_glob
83708394
/devops/developer-api/openapi.yml post /redis/database
83718395
This endpoint creates a new Redis database.
83728396

8397+
To create a database manually, you can use the [Upstash Console](https://console.upstash.com/redis).
8398+
8399+
For a quick development database, POST to https://upstash.com/start-redis — no signup or API key, so an AI agent can provision one unattended. Expires in 72 hours unless claimed.
8400+
83738401
# Delete Database
83748402
Source: https://upstash.com/docs/devops/developer-api/redis/delete_database
83758403

@@ -16965,7 +16993,7 @@ customize the eviction behavior according to their specific needs.
1696516993
Source: https://upstash.com/docs/redis/features/globaldatabase
1696616994

1696716995
<Tip>
16968-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
16996+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
1696916997
</Tip>
1697016998

1697116999
In the global database, the replicas are distributed across multiple regions
@@ -17342,6 +17370,8 @@ Source: https://upstash.com/docs/redis/features/restapi
1734217370
Looking for the URL and token of your database? First [create a Redis
1734317371
database](/docs/redis/overall/getstarted), then [find your
1734417372
credentials](/docs/redis/howto/connect-client) in the console.
17373+
17374+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
1734517375
</Tip>
1734617376

1734717377
In the [Upstash Console](https://console.upstash.com/redis), select your database. Then, in the database page, you will see the section that includes the endpoint URL and token details. When you hover over the `Endpoint` or `Token / Readonly Token` fields, copy button will appear for each. You can click it to easily copy the values you need for your connection.
@@ -18513,6 +18543,10 @@ Simplest way to connect to your database is to use `redis-cli`.
1851318543
Because it is already covered in [Getting Started](../overall/getstarted), we
1851418544
will skip it here.
1851518545

18546+
<Tip>
18547+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
18548+
</Tip>
18549+
1851618550
## Database
1851718551

1851818552
After completing the [getting started](../overall/getstarted) guide, you will
@@ -18682,6 +18716,10 @@ See
1868218716
[the list of APIs](https://upstash.com/docs/redis/features/restapi#rest-redis-api-compatibility)
1868318717
supported.
1868418718

18719+
<Tip>
18720+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
18721+
</Tip>
18722+
1868518723
## Quick Start
1868618724

1868718725
### Install
@@ -21711,7 +21749,7 @@ Upstash Redis is a **highly available, infinitely scalable** Redis-compatible da
2171121749
* Optional SOC-2 compliance, encryption at rest and much more
2171221750

2171321751
<Tip>
21714-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
21752+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
2171521753
</Tip>
2171621754

2171721755
***
@@ -23873,7 +23911,7 @@ redis = Redis(
2387323911
Source: https://upstash.com/docs/redis/sdks/py/gettingstarted
2387423912

2387523913
<Tip>
23876-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
23914+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
2387723915
</Tip>
2387823916

2387923917
## Install
@@ -26284,7 +26322,7 @@ and for his continued efforts to keep it up to date with Upstash.
2628426322
Source: https://upstash.com/docs/redis/sdks/ts/getstarted
2628526323

2628626324
<Tip>
26287-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
26325+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
2628826326
</Tip>
2628926327

2629026328
`@upstash/redis` is written in Deno and can be imported from

llms.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Upstash Documentation
22

33
<Tip>
4-
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to [`https://upstash.com/start-redis`](https://upstash.com/start-redis) — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
4+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
5+
6+
Upstash also provides an MCP server (/docs/agent-resources/mcp) to manage and debug your Upstash resources directly from an agent, and an agent-friendly CLI (/docs/agent-resources/cli) for your terminal or CI/CD pipelines.
57
</Tip>
68

79
## Docs

llms/src/build.ts

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,16 @@ const FULL_TXT_SKIP = [
4646
];
4747

4848
/**
49-
* Snippet injected at the top of both llms.txt and llms-full.txt. Surfaces
50-
* the "free scratch Redis DB" hint to AI agents reading the bundle.
49+
* Preamble injected at the top of both llms.txt and llms-full.txt. Surfaces
50+
* the "free scratch Redis DB" hint and agent tooling to AI agents reading
51+
* the bundle. Inlined here (rather than referencing a `_snippets/` file) so
52+
* the text always lands in the generated output.
5153
*/
52-
const PREAMBLE_SNIPPET = "redis/start-redis-snippet.mdx";
54+
const PREAMBLE = `<Tip>
55+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
56+
57+
Upstash also provides an MCP server (/docs/agent-resources/mcp) to manage and debug your Upstash resources directly from an agent, and an agent-friendly CLI (/docs/agent-resources/cli) for your terminal or CI/CD pipelines.
58+
</Tip>`;
5359

5460
interface Entry {
5561
title: string;
@@ -160,8 +166,7 @@ function addOrphanMdxFiles(): void {
160166

161167
function writeLlmsTxt(): void {
162168
const lines: string[] = ["# Upstash Documentation", ""];
163-
const preamble = loadSnippet(PREAMBLE_SNIPPET);
164-
if (preamble) lines.push(preamble, "");
169+
lines.push(PREAMBLE, "");
165170
lines.push("## Docs", "");
166171
for (const e of entries) {
167172
const url = `${SITE_URL}/${e.path}.md`;
@@ -201,8 +206,7 @@ function writeLlmsFullTxt(): void {
201206
// contributes; pages always carry leading/trailing blanks so they stay
202207
// visually separated from neighbours.
203208
const chunks: string[] = [];
204-
const preamble = loadSnippet(PREAMBLE_SNIPPET);
205-
if (preamble) chunks.push(`${preamble}\n\n`);
209+
chunks.push(`${PREAMBLE}\n\n`);
206210
for (const e of entries) {
207211
if (isExcludedFromFullTxt(e.path)) {
208212
const url = `${SITE_URL}/${e.path}.md`;

redis/features/globaldatabase.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
title: Global Database
33
---
44

5-
<Snippet
6-
file="redis/start-redis-snippet.mdx"
7-
/>
5+
<Tip>
6+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
7+
</Tip>
8+
89

910
In the global database, the replicas are distributed across multiple regions
1011
around the world. The clients are routed to the nearest region. This helps with

redis/features/restapi.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ description: Access your Upstash Redis database over HTTP, from serverless and e
99
Looking for the URL and token of your database? First [create a Redis
1010
database](/redis/overall/getstarted), then [find your
1111
credentials](/redis/howto/connect-client) in the console.
12+
13+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
1214
</Tip>
1315

1416
In the [Upstash Console](https://console.upstash.com/redis), select your database. Then, in the database page, you will see the section that includes the endpoint URL and token details. When you hover over the `Endpoint` or `Token / Readonly Token` fields, copy button will appear for each. You can click it to easily copy the values you need for your connection.

redis/howto/connect-client.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Simplest way to connect to your database is to use `redis-cli`.
1010
Because it is already covered in [Getting Started](../overall/getstarted), we
1111
will skip it here.
1212

13+
<Tip>
14+
If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
15+
</Tip>
16+
1317
## Database
1418

1519
After completing the [getting started](../overall/getstarted) guide, you will

0 commit comments

Comments
 (0)