Skip to content

Commit ec7366c

Browse files
DOC-5254 updated docs with latest info
1 parent d62b14b commit ec7366c

File tree

2 files changed

+83
-75
lines changed

2 files changed

+83
-75
lines changed

content/integrate/redis-mcp/client-conf.md

Lines changed: 12 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ shown below:
6464
"mcpServers": {
6565
.
6666
.
67-
"redis": {
68-
"command": "<path-to-uv-command>",
67+
"redis-mcp-server": {
68+
"type": "stdio",
69+
"command": "uvx",
6970
"args": [
70-
"--directory",
71-
"<your-folder-path>/mcp-redis",
72-
"run",
73-
"src/main.py"
71+
"--from", "git+https://github.com/redis/mcp-redis.git",
72+
"redis-mcp-server",
73+
"--url", "redis://localhost:6379/0"
7474
]
7575
}
76-
},
76+
}
7777
.
7878
.
7979
}
@@ -85,12 +85,12 @@ the command shell here in the `env` section:
8585

8686
```json
8787
"redis": {
88-
"command": "<path-to-uv-command>>",
88+
"type": "stdio",
89+
"command": "uvx",
8990
"args": [
90-
"--directory",
91-
"<your-folder-path>/mcp-redis",
92-
"run",
93-
"src/main.py"
91+
"--from", "git+https://github.com/redis/mcp-redis.git",
92+
"redis-mcp-server",
93+
"--url", "redis://localhost:6379/0"
9494
],
9595
"env": {
9696
"REDIS_HOST": "<your_redis_database_hostname>",
@@ -124,38 +124,6 @@ configuration as shown below:
124124
}
125125
```
126126

127-
### Remote servers
128-
129-
If you set up an
130-
[externally visible]({{< relref "/integrate/redis-mcp/install#making-mcp-visible-externally" >}})
131-
MCP server, you may be able to configure it directly from the app (but
132-
if you can't, then see [Using a gateway](#using-a-gateway) for an alternative approach). For
133-
example, the following `JSON` element configures
134-
[GitHub Copilot for VS Code](https://code.visualstudio.com/docs/copilot/overview)
135-
to use an `sse` type server running at `127.0.0.1`:
136-
137-
```json
138-
.
139-
.
140-
"mcp": {
141-
"servers": {
142-
"redis-mcp": {
143-
"type": "sse",
144-
"url": "http://127.0.0.1:8000/sse"
145-
},
146-
}
147-
},
148-
.
149-
.
150-
```
151-
152-
### Using a gateway
153-
154-
Apps that don't currently support external MCP servers directly, such as Claude
155-
Desktop, can still access them using a *gateway*. See
156-
[MCP server gateway](https://github.com/lightconetech/mcp-gateway)
157-
for more information.
158-
159127
## Redis Cloud MCP
160128

161129
If you are using

content/integrate/redis-mcp/install.md

Lines changed: 71 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,32 @@ how to get a test server active within minutes.
2121
When you have a Redis server available, use the instructions below to install and
2222
configure the Redis MCP server.
2323

24+
## Quick Start with uvx
25+
26+
The easiest way to use the Redis MCP Server is with [`uvx`](https://docs.astral.sh/uv/guides/tools/),
27+
which lets you run it directly from a GitHub branch or a tagged release (see the `uv`
28+
[installation instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation)
29+
for more information.)
30+
31+
```bash
32+
# Run with Redis URI
33+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url redis://localhost:6379/0
34+
35+
# Run with Redis URI and SSL
36+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url "rediss://<USERNAME>:<PASSWORD>@<HOST>:<PORT>?ssl_cert_reqs=required&ssl_ca_certs=<PATH_TO_CERT>"
37+
38+
# Run with individual parameters
39+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --host localhost --port 6379 --password mypassword
40+
41+
# See all options
42+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
43+
```
44+
2445
## Install the server from source
2546

47+
You can also run Redis MCP from source, which may be useful if you want to
48+
contribute to the project.
49+
2650
Clone Redis MCP from the
2751
[Github repository](https://github.com/redis/mcp-redis) using the following
2852
command:
@@ -45,6 +69,12 @@ cd mcp-redis
4569
uv venv
4670
source .venv/bin/activate
4771
uv sync
72+
73+
# Run with CLI interface
74+
uv run redis-mcp-server --help
75+
76+
# Or run the main file directly (uses environment variables)
77+
uv run src/main.py
4878
```
4979

5080
## Install using Docker
@@ -63,8 +93,9 @@ docker build -t mcp-redis .
6393

6494
The default settings for MCP assume a Redis server is running on the
6595
local machine, with the default port and no security arrangements.
66-
To change these settings, use the environment variables shown in the
67-
table below. For example, for a `bash` shell, use
96+
You can use environment variables to change these settings
97+
(see [Environment variables](#environment-variables) below for the full list).
98+
For example, for a `bash` shell, use
6899

69100
```bash
70101
export REDIS_USERNAME="my_username"
@@ -73,6 +104,44 @@ export REDIS_USERNAME="my_username"
73104
from the command line or the `.bashrc` file to set the username you want
74105
to connect with.
75106

107+
Alternatively, you can use a `.env` file in your project folder to set the
108+
environment variables as key-value pairs, one per line:
109+
110+
```
111+
REDIS_HOST=your_redis_host
112+
REDIS_PORT=6379
113+
.
114+
.
115+
```
116+
117+
See the [`.env.example` file](https://github.com/redis/mcp-redis/blob/main/.env.example)
118+
in the repository for the full list of variables and their default values.
119+
120+
You can also set the configuration using command-line arguments, which
121+
may be useful if you only want to change a few settings from the defaults:
122+
123+
```bash
124+
# Basic Redis connection
125+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
126+
--host localhost \
127+
--port 6379 \
128+
--password mypassword
129+
130+
# Using Redis URI (simpler)
131+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
132+
--url redis://user:pass@localhost:6379/0
133+
134+
# SSL connection
135+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
136+
--url rediss://user:[email protected]:6379/0
137+
138+
# See all available options
139+
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
140+
```
141+
142+
### Environment variables
143+
144+
The full set of environment variables is shown in the table below:
76145

77146
| Name | Description | Default Value |
78147
|----------------------|-----------------------------------------------------------|---------------|
@@ -90,35 +159,6 @@ to connect with.
90159
| `REDIS_CLUSTER_MODE` | Enable Redis Cluster mode | `False` |
91160
| `MCP_TRANSPORT` | Use the `stdio` or `sse` transport | `stdio` |
92161

93-
### Making MCP visible externally
94-
95-
{{< note >}}The configuration for an MCP client includes the commands
96-
to start a local server, so you can ignore this section if you don't
97-
want your Redis MCP to be externally accessible.
98-
{{< /note >}}
99-
100-
The default configuration assumes you only want to use the MCP server
101-
locally, but you can make it externally available by setting
102-
`MCP_TRANSPORT` to `sse`:
103-
104-
```bash
105-
export MCP_TRANSPORT="sse"
106-
```
107-
108-
Then, start the server with the following command:
109-
110-
```bash
111-
uv run src/main.py
112-
```
113-
114-
You can test the server is responding with the [`curl`](https://curl.se/)
115-
tool:
116-
117-
```bash
118-
curl -i http://127.0.0.1:8000/sse
119-
HTTP/1.1 200 OK
120-
```
121-
122162
## Redis Cloud MCP
123163

124164
A separate version of the MCP server is available for

0 commit comments

Comments
 (0)