@@ -118,7 +118,9 @@ See the [`.env.example` file](https://github.com/redis/mcp-redis/blob/main/.env.
118
118
in the repository for the full list of variables and their default values.
119
119
120
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:
121
+ may be useful if you only want to change a few settings from the defaults
122
+ (see [ Command line options] ( #command-line-options ) below for the full list
123
+ of options).
122
124
123
125
``` bash
124
126
# Basic Redis connection
@@ -139,25 +141,47 @@ uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
139
141
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
140
142
```
141
143
144
+ {{< note >}}The command-line options take precedence over the environment variables.
145
+ {{< /note >}}
146
+
142
147
### Environment variables
143
148
144
149
The full set of environment variables is shown in the table below:
145
150
146
- | Name | Description | Default Value |
147
- | ----------------------| ----------------------------------------------------------- | ---------------|
148
- | ` REDIS_HOST ` | Redis IP or hostname | ` "127.0.0.1" ` |
149
- | ` REDIS_PORT ` | Redis port | ` 6379 ` |
151
+ | Name | Description | Default Value |
152
+ | ----------------------| -----------------------------| ---------------|
153
+ | ` REDIS_HOST ` | Redis IP or hostname | ` "127.0.0.1" ` |
154
+ | ` REDIS_PORT ` | Redis port | ` 6379 ` |
150
155
| ` 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 |
156
+ | ` REDIS_USERNAME ` | Database username | ` "default" ` |
157
+ | ` REDIS_PWD ` | Database password | "" |
158
+ | ` REDIS_SSL ` | Enables or disables SSL/TLS | ` False ` |
159
+ | ` REDIS_CA_PATH ` | CA certificate for verifying server | None |
155
160
| ` REDIS_SSL_KEYFILE ` | Client's private key file for client authentication | None |
156
161
| ` REDIS_SSL_CERTFILE ` | Client's certificate file for client authentication | None |
157
162
| ` REDIS_CERT_REQS ` | Whether the client should verify the server's certificate | ` "required" ` |
158
163
| ` REDIS_CA_CERTS ` | Path to the trusted CA certificates file | None |
159
164
| ` REDIS_CLUSTER_MODE ` | Enable Redis Cluster mode | ` False ` |
160
- | ` MCP_TRANSPORT ` | Use the ` stdio ` or ` sse ` transport | ` stdio ` |
165
+
166
+ ### Command line options
167
+
168
+ The full set of command line options is shown in the table below:
169
+
170
+ | Name | Description | Default Value |
171
+ | ----------------------| -----------------| ---------------|
172
+ | ` --url ` | Redis URL (` redis://user:pass@host:port/db ` ) | |
173
+ | ` --host ` | Redis IP or hostname | ` "127.0.0.1" ` |
174
+ | ` --port ` | Redis port | ` 6379 ` |
175
+ | ` --db ` | Database | 0 |
176
+ | ` --username ` | Database username | ` "default" ` |
177
+ | ` --password ` | Database password | |
178
+ | ` --ssl ` | Enables or disables SSL/TLS | ` False ` |
179
+ | ` --ssl-ca-path ` | CA certificate for verifying server | None |
180
+ | ` --ssl-keyfile ` | Client's private key file for client authentication | |
181
+ | ` --ssl-certfile ` | Client's certificate file for client authentication | |
182
+ | ` --ssl-cert-reqs ` | Whether the client should verify the server's certificate | ` "required" ` |
183
+ | ` --ssl-ca-certs ` | Path to the trusted CA certificates file | |
184
+ | ` --cluster-mode ` | Enable Redis Cluster mode | ` False ` |
161
185
162
186
## Redis Cloud MCP
163
187
0 commit comments