Skip to content

Commit a2f0c53

Browse files
DOC-5687 update MCP deploy instructions to use PyPI package
1 parent cd72fc5 commit a2f0c53

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ First, locate the configuration file by selecting **Settings** from the menu, th
8888
"type": "stdio",
8989
"command": "uvx",
9090
"args": [
91-
"--from", "git+https://github.com/redis/mcp-redis.git",
91+
"--from", "redis-mcp-server@latest",
9292
"redis-mcp-server",
9393
"--url", "redis://localhost:6379/0"
9494
]
@@ -107,7 +107,7 @@ You can also optionally set the environment for the command shell here in the
107107
"type": "stdio",
108108
"command": "uvx",
109109
"args": [
110-
"--from", "git+https://github.com/redis/mcp-redis.git",
110+
"--from", "redis-mcp-server@latest",
111111
"redis-mcp-server",
112112
"--url", "redis://localhost:6379/0"
113113
],
@@ -191,7 +191,7 @@ with [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):
191191
"type": "stdio",
192192
"command": "uvx",
193193
"args": [
194-
"--from", "git+https://github.com/redis/mcp-redis.git",
194+
"--from", "redis-mcp-server@latest",
195195
"redis-mcp-server",
196196
"--url", "redis://localhost:6379/0"
197197
]

content/integrate/redis-mcp/install.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,29 @@ configure the Redis MCP server.
2323

2424
## Quick Start with uvx
2525

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`
26+
The easiest way to use the Redis MCP Server is with
27+
[`uvx`](https://docs.astral.sh/uv/guides/tools/),
28+
which lets you run it from its [PyPI package](https://pypi.org/project/redis-mcp-server/)
29+
(see the `uv`
2830
[installation instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation)
2931
for more information.)
3032

33+
```bash
34+
# Run with Redis URI
35+
uvx --from redis-mcp-server@latest redis-mcp-server --url redis://localhost:6379/0
36+
37+
# Run with Redis URI and SSL
38+
uvx --from redis-mcp-server@latest redis-mcp-server --url "rediss://<USERNAME>:<PASSWORD>@<HOST>:<PORT>?ssl_cert_reqs=required&ssl_ca_certs=<PATH_TO_CERT>"
39+
40+
# Run with individual parameters
41+
uvx --from redis-mcp-server@latest redis-mcp-server --host localhost --port 6379 --password mypassword
42+
43+
# See all options
44+
uvx --from redis-mcp-server@latest redis-mcp-server --help
45+
```
46+
47+
You can also run Redis MCP from a GitHub branch or a tagged release with `uvx`:
48+
3149
```bash
3250
# Run with Redis URI
3351
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url redis://localhost:6379/0
@@ -124,21 +142,21 @@ of options).
124142

125143
```bash
126144
# Basic Redis connection
127-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
145+
uvx --from redis-mcp-server@latest redis-mcp-server \
128146
--host localhost \
129147
--port 6379 \
130148
--password mypassword
131149

132150
# Using Redis URI (simpler)
133-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
151+
uvx --from redis-mcp-server@latest redis-mcp-server \
134152
--url redis://user:pass@localhost:6379/0
135153

136154
# SSL connection
137-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
155+
uvx --from redis-mcp-server@latest redis-mcp-server \
138156
--url rediss://user:[email protected]:6379/0
139157

140158
# See all available options
141-
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
159+
uvx --from redis-mcp-server@latest redis-mcp-server --help
142160
```
143161

144162
{{< note >}}The command-line options take precedence over the environment variables.

0 commit comments

Comments
 (0)