Skip to content

Commit 4acf67f

Browse files
Merge pull request #1876 from redis/DOC-5498-mcp-updates
DOC-5498 MCP updates
2 parents 8c1b8a5 + bb608d5 commit 4acf67f

File tree

2 files changed

+47
-10
lines changed

2 files changed

+47
-10
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ give the general configuration details for some common MCP client tools:
4848
- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
4949
- [GitHub Copilot for VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
5050
- [OpenAI](https://openai.github.io/openai-agents-python/mcp/)
51+
- [Augment](https://docs.augmentcode.com/setup-augment/mcp)
5152

5253
### Local servers
5354

@@ -124,6 +125,18 @@ configuration as shown below:
124125
}
125126
```
126127

128+
For Augment in VS Code or JetBrains IDEs, you can also add the configuration
129+
from the Settings panel.
130+
131+
Open the **Settings** panel using the menu
132+
in the top right corner of the main Augment panel. In the **Tools**
133+
settings, scroll down to the **MCP** section and select **Add MCP**.
134+
Enter `Redis` in the name field and paste appropriate command line in the
135+
command field (see
136+
[Configuration]({{< relref "/integrate/redis-mcp/install#configuration" >}})
137+
for more information about the command line options). You can also add any
138+
[environment variables]({{< relref "/integrate/redis-mcp/install#environment-variables" >}}) that you need.
139+
127140
## Redis Cloud MCP
128141

129142
If you are using

content/integrate/redis-mcp/install.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ See the [`.env.example` file](https://github.com/redis/mcp-redis/blob/main/.env.
118118
in the repository for the full list of variables and their default values.
119119

120120
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).
122124

123125
```bash
124126
# Basic Redis connection
@@ -139,25 +141,47 @@ uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server \
139141
uvx --from git+https://github.com/redis/mcp-redis.git redis-mcp-server --help
140142
```
141143

144+
{{< note >}}The command-line options take precedence over the environment variables.
145+
{{< /note >}}
146+
142147
### Environment variables
143148

144149
The full set of environment variables is shown in the table below:
145150

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` |
150155
| `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 |
155160
| `REDIS_SSL_KEYFILE` | Client's private key file for client authentication | None |
156161
| `REDIS_SSL_CERTFILE` | Client's certificate file for client authentication | None |
157162
| `REDIS_CERT_REQS` | Whether the client should verify the server's certificate | `"required"` |
158163
| `REDIS_CA_CERTS` | Path to the trusted CA certificates file | None |
159164
| `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` |
161185

162186
## Redis Cloud MCP
163187

0 commit comments

Comments
 (0)