From 213fcd119fed4cea381522f4c9647be0a60d7541 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Fri, 25 Jul 2025 14:30:10 +0100 Subject: [PATCH 1/3] DOC-5498 updated command line info --- content/integrate/redis-mcp/install.md | 39 ++++++++++++++++++++------ 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/content/integrate/redis-mcp/install.md b/content/integrate/redis-mcp/install.md index 720c9e9e6..2f69157b7 100644 --- a/content/integrate/redis-mcp/install.md +++ b/content/integrate/redis-mcp/install.md @@ -139,19 +139,22 @@ 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"` | @@ -159,6 +162,26 @@ The full set of environment variables is shown in the table below: | `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 A separate version of the MCP server is available for From 6dda4d0f4fd047b0d381e287f3ec13fd1203c274 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Fri, 25 Jul 2025 16:23:07 +0100 Subject: [PATCH 2/3] DOC-5498 updates to config details --- content/integrate/redis-mcp/client-conf.md | 11 +++++++++++ content/integrate/redis-mcp/install.md | 5 +++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/content/integrate/redis-mcp/client-conf.md b/content/integrate/redis-mcp/client-conf.md index 99fa4d660..bc54bdf05 100644 --- a/content/integrate/redis-mcp/client-conf.md +++ b/content/integrate/redis-mcp/client-conf.md @@ -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 @@ -124,6 +125,16 @@ 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 diff --git a/content/integrate/redis-mcp/install.md b/content/integrate/redis-mcp/install.md index 2f69157b7..e9b500d03 100644 --- a/content/integrate/redis-mcp/install.md +++ b/content/integrate/redis-mcp/install.md @@ -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 @@ -160,7 +162,6 @@ The full set of environment variables is shown in the table below: | `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 From bb608d5ab10f46e8c06ae693e06cc8cc8281b958 Mon Sep 17 00:00:00 2001 From: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> Date: Mon, 28 Jul 2025 10:31:23 +0100 Subject: [PATCH 3/3] Update content/integrate/redis-mcp/client-conf.md Co-authored-by: Cameron Bates <102550101+cmilesb@users.noreply.github.com> --- content/integrate/redis-mcp/client-conf.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/integrate/redis-mcp/client-conf.md b/content/integrate/redis-mcp/client-conf.md index bc54bdf05..7f4d0db82 100644 --- a/content/integrate/redis-mcp/client-conf.md +++ b/content/integrate/redis-mcp/client-conf.md @@ -126,7 +126,9 @@ 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 +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