@@ -21,13 +21,35 @@ how to get a test server active within minutes.
2121When you have a Redis server available, use the instructions below to install and
2222configure the Redis MCP server.
2323
24- ## Quick Start with uvx
24+ ## Quick Start with PyPI
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 )
2931for 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+ ## Run from GitHub
48+
49+ Running from [ PyPI] ( #quick-start-with-pypi )
50+ is the recommended way to use the Redis MCP server, but
51+ you can also run it from a GitHub branch or a tagged release with ` uvx ` :
52+
3153``` bash
3254# Run with Redis URI
3355uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --url redis://localhost:6379/0
@@ -124,21 +146,21 @@ of options).
124146
125147``` bash
126148# Basic Redis connection
127- uvx --from git+https://github.com/ redis/ mcp-redis.git redis-mcp-server \
149+ uvx --from redis- mcp-server@latest redis-mcp-server \
128150 --host localhost \
129151 --port 6379 \
130152 --password mypassword
131153
132154# Using Redis URI (simpler)
133- uvx --from git+https://github.com/ redis/ mcp-redis.git redis-mcp-server \
155+ uvx --from redis- mcp-server@latest redis-mcp-server \
134156 --url redis://user:pass@localhost:6379/0
135157
136158# SSL connection
137- uvx --from git+https://github.com/ redis/ mcp-redis.git redis-mcp-server \
159+ uvx --from redis- mcp-server@latest redis-mcp-server \
138160 --url rediss://user:
[email protected] :6379/0
139161
140162# See all available options
141- uvx --from git+https://github.com/ redis/ mcp-redis.git redis-mcp-server --help
163+ uvx --from redis- mcp-server@latest redis-mcp-server --help
142164```
143165
144166{{< note >}}The command-line options take precedence over the environment variables.
0 commit comments