Skip to content

Commit 25b4c55

Browse files
DOC-5525 updated MCP docs for Augment Easy MCP
1 parent acbdb2f commit 25b4c55

File tree

1 file changed

+115
-27
lines changed

1 file changed

+115
-27
lines changed

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

Lines changed: 115 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,42 @@ your Redis database.
4242

4343
You can also add the configuration for Redis MCP to your client app
4444
manually. The exact method varies from client to client but the
45-
basic approach is similar in each case. The pages listed below
45+
basic approach is similar in each case. The sections below
4646
give the general configuration details for some common MCP client tools:
4747

48-
- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
49-
- [GitHub Copilot for VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
50-
- [OpenAI](https://openai.github.io/openai-agents-python/mcp/)
51-
- [Augment](https://docs.augmentcode.com/setup-augment/mcp)
48+
- [Augment Code](#augment-code)
49+
- [Claude Desktop](#claude-desktop)
50+
- [OpenAI Agents](#openai-agents)
51+
- [VS Code with GitHub Copilot](#vs-code-with-github-copilot)
5252

53-
### Local servers
5453

55-
For a locally-running MCP server, you need to edit the configuration
56-
file to add the command that launches the server, along with its
57-
arguments. For example, with Claude Desktop, you can locate the
58-
file by selecting **Settings** from the menu, then selecting the
59-
**Developer** tab, and then clicking the **Edit Config** button.
60-
Open this JSON file and add your settings as
61-
shown below:
54+
### Augment Code
55+
56+
Redis supports Augment Code's
57+
[Easy MCP](https://docs.augmentcode.com/setup-augment/mcp#easy-mcp%3A-one-click-integrations)
58+
feature in [VSCode](https://docs.augmentcode.com/setup-augment/mcp#getting-started-with-easy-mcp)
59+
and the [JetBrains IDEs](https://docs.augmentcode.com/jetbrains/setup-augment/mcp#getting-started-with-easy-mcp)
60+
to install the server in seconds:
61+
62+
1. Open the Augment settings panel and
63+
navigate to the **MCP** pane.
64+
1. Click the "+" button next to Redis in the
65+
**Easy MCP installation** list and enter the connection details for your Redis database.
66+
1. Click **Install** to start using Redis MCP.
67+
68+
If you need to supply environment variables or command line parameters:
69+
70+
1. Click the **Add MCP** button underneath the list of Easy MCP integrations.
71+
1. Enter `Redis` in the name field and paste the appropriate command line in the
72+
command field (see
73+
[Configuration]({{< relref "/integrate/redis-mcp/install#configuration" >}}) for
74+
more information about the available command line options).
75+
1. Click the **+ Variable** button to add any environment variables that you need.
76+
1. Click **Add** to add the server.
77+
78+
### Claude Desktop
79+
80+
First, locate the configuration file by selecting **Settings** from the menu, then selecting the **Developer** tab, and then clicking the **Edit Config** button. Open this JSON file and add your settings as shown below to run Redis MCP with [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):
6281

6382
```json
6483
{
@@ -80,9 +99,8 @@ shown below:
8099
}
81100
```
82101

83-
You can find the path to the `uv` command using `which uv`, or
84-
the equivalent. You can also optionally set the environment for
85-
the command shell here in the `env` section:
102+
You can also optionally set the environment for the command shell here in the
103+
`env` section:
86104

87105
```json
88106
"redis": {
@@ -125,17 +143,87 @@ configuration as shown below:
125143
}
126144
```
127145

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.
146+
For more information about using MCP with Claude Desktop, see
147+
[Connect to Local MCP Servers](https://modelcontextprotocol.io/quickstart/user).
148+
149+
### OpenAI Agents
150+
151+
The
152+
[`redis_assistant.py`](https://github.com/redis/mcp-redis/blob/main/examples/redis_assistant.py)
153+
file in the [`mcp-redis`](https://github.com/redis/mcp-redis) repository contains an
154+
example of how to configure OpenAI Agents to use Redis MCP.
155+
156+
To use this example, install the `openai-agents` library, ensure
157+
you have exported the OpenAI token in the `OPENAI_API_KEY` environment variable
158+
and run the `redis_assistant.py` script:
159+
160+
```bash
161+
pip install openai-agents
162+
export OPENAI_API_KEY=<your_openai_api_key>
163+
python3 redis_assistant.py
164+
```
165+
166+
See the
167+
[OpenAI Agents SDK documentation](https://openai.github.io/openai-agents-python/mcp/)
168+
for more information about using MCP servers.
169+
170+
### VS Code with GitHub Copilot
171+
172+
To use Redis MCP with VS Code, first add the following to your `settings.json`
173+
file to enable the
174+
[agent mode tools](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode):
175+
176+
```json
177+
{
178+
"chat.agent.enabled": true
179+
}
180+
```
181+
182+
Then, add the following lines to `settings.json` to run Redis MCP
183+
with [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):
184+
185+
```json
186+
.
187+
.
188+
"mcp": {
189+
"servers": {
190+
"Redis MCP Server": {
191+
"type": "stdio",
192+
"command": "uvx",
193+
"args": [
194+
"--from", "git+https://github.com/redis/mcp-redis.git",
195+
"redis-mcp-server",
196+
"--url", "redis://localhost:6379/0"
197+
]
198+
},
199+
}
200+
},
201+
.
202+
.
203+
```
204+
205+
You can also add
206+
[environment variables]({{< relref "/integrate/redis-mcp/install#environment-variables" >}})
207+
in the `env` section of the configuration:
208+
209+
```json
210+
"Redis MCP Server": {
211+
.
212+
.
213+
"env": {
214+
"REDIS_HOST": "<your_redis_database_hostname>",
215+
"REDIS_PORT": "<your_redis_database_port>",
216+
"REDIS_USERNAME": "<your_redis_database_username>",
217+
"REDIS_PWD": "<your_redis_database_password>",
218+
.
219+
.
220+
}
221+
}
222+
```
223+
224+
See
225+
[Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
226+
for more information.
139227

140228
## Redis Cloud MCP
141229

0 commit comments

Comments
 (0)