Skip to content

Commit 67d58b0

Browse files
DOC-5254 rounded out install and client config details
1 parent 9bc131b commit 67d58b0

File tree

3 files changed

+84
-14
lines changed

3 files changed

+84
-14
lines changed

content/integrate/redis-mcp/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ Redis MCP is a general-purpose implementation that lets agents read, write, and
2828
query data in Redis and also has some basic commands to manage the Redis
2929
server. With this enabled, you can use an LLM client as a very high-level
3030
interface to Redis. Add, query, and analyze any Redis data set directly from
31-
an LLM chat:
31+
an LLM chat using instructions and questions like the following:
3232

3333
- "Store the entire conversation in the 'recent_chats' stream"
3434
- "Cache this item"
3535
- "How many keys does my database have?"
3636
- "What is user:1's email?"
3737

38+
See the other pages in this section to learn how to set up and use Redis MCP:

content/integrate/redis-mcp/ciient-conf.md renamed to content/integrate/redis-mcp/client-conf.md

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ The sections below describe the ways you can do this.
1919

2020
## Smithery
2121

22-
Smithery provides a searchable repository of scripts that add configurations
23-
for many MCP services to client apps.
22+
[Smithery](https://smithery.ai/) provides a searchable repository of scripts
23+
that add configurations for many MCP services to client apps.
2424
The easiest way to configure your client is to use the
2525
[Smithery tool for Redis MCP](https://smithery.ai/server/@redis/mcp-redis).
2626

2727
When you select your client from the **Install** bar on the Redis MCP page,
2828
you will see a command line that you can copy and paste into a terminal.
2929
Running this command will configure your client app to use Redis MCP. (Note
30-
that you need to have [Node.js](https://nodejs.org/en) installed to run
30+
that you must have [Node.js](https://nodejs.org/en) installed to run
3131
the Smithery scripts.) For example, the command line for
3232
[Claude Desktop](https://claude.ai/download) is
3333

@@ -42,14 +42,21 @@ 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.
45+
basic approach is similar in each case. The pages listed below
46+
give the general configuration details for some common MCP client tools:
47+
48+
- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
49+
- [Github Copilot for VSCode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
50+
- [OpenAI](https://openai.github.io/openai-agents-python/mcp/)
51+
52+
### Local servers
4653

4754
For a locally-running MCP server, you need to edit the configuration
4855
file to add the command that launches the server, along with its
4956
arguments. For example, with Claude Desktop, you can locate the
5057
file by selecting **Settings** from the menu, then selecting the
5158
**Developer** tab, and then clicking the **Edit Config** button.
52-
When you open this JSON file, you should add your settings as
59+
Open this JSON file and add your settings as
5360
shown below:
5461

5562
```json
@@ -58,7 +65,7 @@ shown below:
5865
.
5966
.
6067
"redis": {
61-
"command": "<path-to-uv-command>>",
68+
"command": "<path-to-uv-command>",
6269
"args": [
6370
"--directory",
6471
"<your-folder-path>/mcp-redis",
@@ -96,4 +103,55 @@ the command shell here in the `env` section:
96103
}
97104
```
98105

106+
If you are using
107+
[Docker]({{< relref "/integrate/redis-mcp/install#install-using-docker" >}})
108+
to deploy the server, change the `command` and `args` sections of the
109+
configuration as shown below:
110+
111+
```json
112+
"redis": {
113+
"command": "docker",
114+
"args": ["run",
115+
"--rm",
116+
"--name",
117+
"redis-mcp-server",
118+
"-i",
119+
"-e", "REDIS_HOST=<redis_hostname>",
120+
"-e", "REDIS_PORT=<redis_port>",
121+
"-e", "REDIS_USERNAME=<redis_username>",
122+
"-e", "REDIS_PWD=<redis_password>",
123+
"mcp-redis"]
124+
}
125+
```
126+
127+
### Remote servers
128+
129+
If you set up an
130+
[externally visible]({{< relref "/integrate/redis-mcp/install#making-mcp-visible-externally" >}})
131+
MCP server, you may be able to configure it directly from the app (but
132+
if you can't, then see [Using a gateway](#using-a-gateway) for an alternative approach). For
133+
example, the following `JSON` element configures
134+
[Github Copilot for VSCode](https://code.visualstudio.com/docs/copilot/overview)
135+
to use an `sse` type server running at `127.0.0.1`:
136+
137+
```json
138+
.
139+
.
140+
"mcp": {
141+
"servers": {
142+
"redis-mcp": {
143+
"type": "sse",
144+
"url": "http://127.0.0.1:8000/sse"
145+
},
146+
}
147+
},
148+
.
149+
.
150+
```
151+
152+
### Using a gateway
99153

154+
Apps that don't currently support external MCP servers directly, such as Claude
155+
Desktop, can still access them using a *gateway*. See
156+
[MCP server gateway](https://github.com/lightconetech/mcp-gateway)
157+
for more information.

content/integrate/redis-mcp/install.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,23 @@ categories:
77
- rs
88
summary: Access a Redis server using any MCP client.
99
group: service
10-
linkTitle: Install
10+
linkTitle: Install the server
1111
description: Install and configure the Redis MCP server.
1212
type: integration
1313
weight: 10
1414
---
1515

1616
The MCP server runs separately from Redis, so you will need a
17-
Redis server to access. See [Redis Cloud]({{< relref "/operate/rc" >}})
17+
Redis server for it to connect to. See [Redis Cloud]({{< relref "/operate/rc" >}})
1818
or [Redis Open Source]({{< relref "/operate/oss_and_stack" >}}) to learn
1919
how to get a test server active within minutes.
2020

21+
When you have a Redis server available, use the instructions below to install and
22+
configure the Redis MCP server.
23+
2124
## Install the server from source
2225

23-
When you have a Redis server, you can clone Redis MCP from the
26+
Clone Redis MCP from the
2427
[Github repository](https://github.com/redis/mcp-redis) using the following
2528
command:
2629

@@ -33,7 +36,7 @@ tool to set up the server. See the `uv`
3336
[installation instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation)
3437
for more information.
3538

36-
When you have `uv`, go into the `mcp-redis` folder that you cloned and
39+
When you have installed `uv`, go to the `mcp-redis` folder that you cloned and
3740
enter the following commands to initialize the MCP server code:
3841

3942
```bash
@@ -47,9 +50,10 @@ uv sync
4750
## Install using Docker
4851

4952
You can use the [`mcp/redis`](https://hub.docker.com/r/mcp/redis)
50-
image (or build your own image from the source using the `Dockerfile`) to
51-
run Redis MCP with [Docker](https://www.docker.com/). Use the following
52-
command to download `mcp/redis` from [DockerHub](https://hub.docker.com/):
53+
image to run Redis MCP with [Docker](https://www.docker.com/).
54+
Alternatively, use the following
55+
command to build the Docker image with the `Dockerfile` in the
56+
`mcp/redis` folder:
5357

5458
```
5559
docker build -t mcp-redis .
@@ -113,3 +117,10 @@ tool:
113117
curl -i http://127.0.0.1:8000/sse
114118
HTTP/1.1 200 OK
115119
```
120+
121+
## Next steps
122+
123+
When you have installed the server, you will need a MCP client to
124+
connect to it and use its services. See
125+
[Configure client apps]({{< relref "/integrate/redis-mcp/client-conf" >}})
126+
for more information.

0 commit comments

Comments
 (0)