Skip to content

Commit 213fcd1

Browse files
DOC-5498 updated command line info
1 parent cb930fe commit 213fcd1

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

content/integrate/redis-mcp/install.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,26 +139,49 @@ uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
139139
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
140140
```
141141

142+
{{< note >}}The command-line options take precedence over the environment variables.
143+
{{< /note >}}
144+
142145
### Environment variables
143146

144147
The full set of environment variables is shown in the table below:
145148

146-
| Name | Description | Default Value |
147-
|----------------------|-----------------------------------------------------------|---------------|
148-
| `REDIS_HOST` | Redis IP or hostname | `"127.0.0.1"` |
149-
| `REDIS_PORT` | Redis port | `6379` |
149+
| Name | Description | Default Value |
150+
|----------------------|-----------------------------|---------------|
151+
| `REDIS_HOST` | Redis IP or hostname | `"127.0.0.1"` |
152+
| `REDIS_PORT` | Redis port | `6379` |
150153
| `REDIS_DB` | Database | 0 |
151-
| `REDIS_USERNAME` | Database username | `"default"` |
152-
| `REDIS_PWD` | Database password | "" |
153-
| `REDIS_SSL` | Enables or disables SSL/TLS | `False` |
154-
| `REDIS_CA_PATH` | CA certificate for verifying server | None |
154+
| `REDIS_USERNAME` | Database username | `"default"` |
155+
| `REDIS_PWD` | Database password | "" |
156+
| `REDIS_SSL` | Enables or disables SSL/TLS | `False` |
157+
| `REDIS_CA_PATH` | CA certificate for verifying server | None |
155158
| `REDIS_SSL_KEYFILE` | Client's private key file for client authentication | None |
156159
| `REDIS_SSL_CERTFILE` | Client's certificate file for client authentication | None |
157160
| `REDIS_CERT_REQS` | Whether the client should verify the server's certificate | `"required"` |
158161
| `REDIS_CA_CERTS` | Path to the trusted CA certificates file | None |
159162
| `REDIS_CLUSTER_MODE` | Enable Redis Cluster mode | `False` |
160163
| `MCP_TRANSPORT` | Use the `stdio` or `sse` transport | `stdio` |
161164

165+
### Command line options
166+
167+
The full set of command line options is shown in the table below:
168+
169+
| Name | Description | Default Value |
170+
|----------------------|-----------------|---------------|
171+
| `--url` | Redis URL (`redis://user:pass@host:port/db`) | |
172+
| `--host` | Redis IP or hostname | `"127.0.0.1"` |
173+
| `--port` | Redis port | `6379` |
174+
| `--db` | Database | 0 |
175+
| `--username` | Database username | `"default"` |
176+
| `--password` | Database password | |
177+
| `--ssl` | Enables or disables SSL/TLS | `False` |
178+
| `--ssl-ca-path` | CA certificate for verifying server | None |
179+
| `--ssl-keyfile` | Client's private key file for client authentication | |
180+
| `--ssl-certfile` | Client's certificate file for client authentication | |
181+
| `--ssl-cert-reqs` | Whether the client should verify the server's certificate | `"required"` |
182+
| `--ssl-ca-certs` | Path to the trusted CA certificates file | |
183+
| `--cluster-mode` | Enable Redis Cluster mode | `False` |
184+
162185
## Redis Cloud MCP
163186

164187
A separate version of the MCP server is available for

0 commit comments

Comments
 (0)