Skip to content

Commit 4687460

Browse files
committed
Instructions to run the dockerized MCP Server for Claude Desktop
1 parent 62e254a commit 4687460

File tree

1 file changed

+46
-8
lines changed

1 file changed

+46
-8
lines changed

README.md

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,8 @@ Additional tools.
4040

4141
## Installation
4242

43-
### Installing via Smithery
43+
Follow these instructions to install the server.
4444

45-
To install Redis MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@redis/mcp-redis):
46-
47-
```bash
48-
npx -y @smithery/cli install @redis/mcp-redis --client claude
49-
```
50-
51-
### Manual Installation
5245
```sh
5346
# Clone the repository
5447
git clone https://github.com/redis/mcp-redis.git
@@ -103,6 +96,19 @@ python3.13 redis_assistant.py
10396
You can troubleshoot your agent workflows using the [OpenAI dashboard](https://platform.openai.com/traces/).
10497

10598
## Integration with Claude Desktop
99+
100+
### Via Smithery
101+
102+
To install Redis MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@redis/mcp-redis):
103+
104+
```bash
105+
npx -y @smithery/cli install @redis/mcp-redis --client claude
106+
```
107+
108+
Follow the prompt and provide the details to configure the server. The procedure will create the proper configuration in the `claude_desktop_config.json` configuration file.
109+
110+
### Manual configuration
111+
106112
You can configure Claude Desktop to use this MCP Server.
107113

108114
1. Specify your Redis credentials and TLS configuration
@@ -134,6 +140,38 @@ You can configure Claude Desktop to use this MCP Server.
134140
}
135141
```
136142

143+
### Using with Docker
144+
145+
The Redis MCP Server provides a Dockerfile. Build this server's image with:
146+
147+
```commandline
148+
docker build -t mcp-redis .
149+
```
150+
151+
Finally, configure Claude Desktop to create the container at start-up. Edit the `claude_desktop_config.json` and add:
152+
153+
```commandline
154+
{
155+
"mcpServers": {
156+
"redis": {
157+
"command": "docker",
158+
"args": ["run",
159+
"--rm",
160+
"--name",
161+
"redis-mcp-server",
162+
"-i",
163+
"-e", "REDIS_HOST=<redis_hostname>",
164+
"-e", "REDIS_PORT=<redis_port>",
165+
"-e", "REDIS_USERNAME=<redis_username>",
166+
"-e", "REDIS_PWD=<redis_password>",
167+
"mcp-redis"]
168+
}
169+
}
170+
}
171+
```
172+
173+
### Troubleshooting
174+
137175
You can troubleshoot problems by tailing the log file.
138176

139177
```commandline

0 commit comments

Comments
 (0)