Skip to content

DOC-5498 MCP updates #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 28, 2025
+47 −10
Merged

DOC-5498 MCP updates #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
213fcd1
DOC-5498 updated command line info
andy-stark-redis Jul 25, 2025
6dda4d0
DOC-5498 updates to config details
andy-stark-redis Jul 25, 2025
bb608d5
Update content/integrate/redis-mcp/client-conf.md
andy-stark-redis Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions content/integrate/redis-mcp/client-conf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ give the general configuration details for some common MCP client tools:
- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
- [GitHub Copilot for VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
- [OpenAI](https://openai.github.io/openai-agents-python/mcp/)
- [Augment](https://docs.augmentcode.com/setup-augment/mcp)

### Local servers

Expand Down Expand Up @@ -124,6 +125,18 @@ configuration as shown below:
}
```

For Augment in VS Code or JetBrains IDEs, you can also add the configuration
from the Settings panel.

Open the **Settings** panel using the menu
in the top right corner of the main Augment panel. In the **Tools**
settings, scroll down to the **MCP** section and select **Add MCP**.
Enter `Redis` in the name field and paste appropriate command line in the
command field (see
[Configuration]({{< relref "/integrate/redis-mcp/install#configuration" >}})
for more information about the command line options). You can also add any
[environment variables]({{< relref "/integrate/redis-mcp/install#environment-variables" >}}) that you need.

## Redis Cloud MCP

If you are using
Expand Down
44 changes: 34 additions & 10 deletions content/integrate/redis-mcp/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ See the [`.env.example` file](https://github.com/redis/mcp-redis/blob/main/.env.
in the repository for the full list of variables and their default values.

You can also set the configuration using command-line arguments, which
may be useful if you only want to change a few settings from the defaults:
may be useful if you only want to change a few settings from the defaults
(see [Command line options](#command-line-options) below for the full list
of options).

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

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

### Environment variables

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

| Name | Description | Default Value |
|----------------------|-----------------------------------------------------------|---------------|
| `REDIS_HOST` | Redis IP or hostname | `"127.0.0.1"` |
| `REDIS_PORT` | Redis port | `6379` |
| Name | Description | Default Value |
|----------------------|-----------------------------|---------------|
| `REDIS_HOST` | Redis IP or hostname | `"127.0.0.1"` |
| `REDIS_PORT` | Redis port | `6379` |
| `REDIS_DB` | Database | 0 |
| `REDIS_USERNAME` | Database username | `"default"` |
| `REDIS_PWD` | Database password | "" |
| `REDIS_SSL` | Enables or disables SSL/TLS | `False` |
| `REDIS_CA_PATH` | CA certificate for verifying server | None |
| `REDIS_USERNAME` | Database username | `"default"` |
| `REDIS_PWD` | Database password | "" |
| `REDIS_SSL` | Enables or disables SSL/TLS | `False` |
| `REDIS_CA_PATH` | CA certificate for verifying server | None |
| `REDIS_SSL_KEYFILE` | Client's private key file for client authentication | None |
| `REDIS_SSL_CERTFILE` | Client's certificate file for client authentication | None |
| `REDIS_CERT_REQS` | Whether the client should verify the server's certificate | `"required"` |
| `REDIS_CA_CERTS` | Path to the trusted CA certificates file | None |
| `REDIS_CLUSTER_MODE` | Enable Redis Cluster mode | `False` |
| `MCP_TRANSPORT` | Use the `stdio` or `sse` transport | `stdio` |

### Command line options

The full set of command line options is shown in the table below:

| Name | Description | Default Value |
|----------------------|-----------------|---------------|
| `--url` | Redis URL (`redis://user:pass@host:port/db`) | |
| `--host` | Redis IP or hostname | `"127.0.0.1"` |
| `--port` | Redis port | `6379` |
| `--db` | Database | 0 |
| `--username` | Database username | `"default"` |
| `--password` | Database password | |
| `--ssl` | Enables or disables SSL/TLS | `False` |
| `--ssl-ca-path` | CA certificate for verifying server | None |
| `--ssl-keyfile` | Client's private key file for client authentication | |
| `--ssl-certfile` | Client's certificate file for client authentication | |
| `--ssl-cert-reqs` | Whether the client should verify the server's certificate | `"required"` |
| `--ssl-ca-certs` | Path to the trusted CA certificates file | |
| `--cluster-mode` | Enable Redis Cluster mode | `False` |

## Redis Cloud MCP

Expand Down