Skip to content

Commit f240d39

Browse files
docs: document Docker as zero-install MCP option (#647) (#659)
Add .mcp.json snippets for all three Docker approaches: environment variables, mounted config, and --network host for local clusters. Update README MCP section and MCP getting-started guide with zero-install Docker examples.
1 parent 25a8b40 commit f240d39

3 files changed

Lines changed: 117 additions & 23 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,9 +460,27 @@ Configure your AI assistant (Claude Desktop, Cursor, etc.) to use it:
460460
}
461461
```
462462

463-
**For development:** Copy `.mcp.json.example` to `.mcp.json`, update the profile name, and restart your IDE.
463+
**Zero-install with Docker** -- no local install needed:
464464

465-
See the [MCP Documentation](https://redis-field-engineering.github.io/redisctl-docs/mcp/) for full setup instructions.
465+
```json
466+
{
467+
"mcpServers": {
468+
"redisctl": {
469+
"command": "docker",
470+
"args": [
471+
"run", "-i", "--rm",
472+
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
473+
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
474+
"-e", "REDIS_ENTERPRISE_PASSWORD",
475+
"ghcr.io/redis-developer/redisctl",
476+
"redisctl-mcp"
477+
]
478+
}
479+
}
480+
}
481+
```
482+
483+
See the [MCP Documentation](https://redis-field-engineering.github.io/redisctl-docs/mcp/) for full setup instructions including [Docker options](https://redis-field-engineering.github.io/redisctl-docs/getting-started/docker/#mcp-server-zero-install).
466484

467485
---
468486

docs/docs/getting-started/docker.md

Lines changed: 73 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -84,27 +84,35 @@ docker run --rm \
8484
enterprise support-package cluster --output-dir /output
8585
```
8686

87-
## MCP Server
87+
## MCP Server (Zero-Install)
8888

89-
The Docker image also includes `redisctl-mcp` for AI assistant integration:
89+
The Docker image includes `redisctl-mcp`, so you can use the MCP server with your AI assistant without installing anything. Copy one of the `.mcp.json` snippets below and start chatting.
9090

91-
```bash
92-
# Run MCP server with environment credentials
93-
docker run -i --rm \
94-
-e REDIS_ENTERPRISE_URL \
95-
-e REDIS_ENTERPRISE_USER \
96-
-e REDIS_ENTERPRISE_PASSWORD \
97-
ghcr.io/redis-developer/redisctl \
98-
redisctl-mcp --read-only=false
91+
### Option 1: Environment Variables (Simplest)
9992

100-
# Or mount config for profile-based auth
101-
docker run -i --rm \
102-
-v ~/.config/redisctl:/root/.config/redisctl:ro \
103-
ghcr.io/redis-developer/redisctl \
104-
redisctl-mcp --profile my-profile
93+
Pass credentials as environment variables. The password is pulled from your host environment rather than hardcoded:
94+
95+
```json
96+
{
97+
"mcpServers": {
98+
"redisctl": {
99+
"command": "docker",
100+
"args": [
101+
"run", "-i", "--rm",
102+
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
103+
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
104+
"-e", "REDIS_ENTERPRISE_PASSWORD",
105+
"ghcr.io/redis-developer/redisctl",
106+
"redisctl-mcp"
107+
]
108+
}
109+
}
110+
}
105111
```
106112

107-
For IDE configuration (note the `-i` flag for stdin):
113+
### Option 2: Mounted Config
114+
115+
Mount your existing redisctl config directory for profile-based auth:
108116

109117
```json
110118
{
@@ -122,7 +130,55 @@ For IDE configuration (note the `-i` flag for stdin):
122130
}
123131
```
124132

125-
**Note:** Native installation is recommended for MCP usage since Docker adds latency to each tool call.
133+
### Option 3: Local Clusters (Host Networking)
134+
135+
For clusters running on localhost (e.g. Docker Compose demos), use `--network host` so the container can reach host ports:
136+
137+
```json
138+
{
139+
"mcpServers": {
140+
"redisctl": {
141+
"command": "docker",
142+
"args": [
143+
"run", "-i", "--rm",
144+
"--network", "host",
145+
"-e", "REDIS_ENTERPRISE_URL=https://localhost:9443",
146+
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
147+
"-e", "REDIS_ENTERPRISE_PASSWORD",
148+
"-e", "REDIS_ENTERPRISE_INSECURE=true",
149+
"ghcr.io/redis-developer/redisctl",
150+
"redisctl-mcp"
151+
]
152+
}
153+
}
154+
}
155+
```
156+
157+
!!! note
158+
`--network host` is required on Linux. On macOS, Docker Desktop routes `host.docker.internal` to the host automatically, but `--network host` is the simplest cross-platform approach.
159+
160+
### Running from the CLI
161+
162+
You can also run the MCP server directly:
163+
164+
```bash
165+
# With environment credentials
166+
docker run -i --rm \
167+
-e REDIS_ENTERPRISE_URL \
168+
-e REDIS_ENTERPRISE_USER \
169+
-e REDIS_ENTERPRISE_PASSWORD \
170+
ghcr.io/redis-developer/redisctl \
171+
redisctl-mcp
172+
173+
# With mounted config
174+
docker run -i --rm \
175+
-v ~/.config/redisctl:/root/.config/redisctl:ro \
176+
ghcr.io/redis-developer/redisctl \
177+
redisctl-mcp --profile my-profile
178+
```
179+
180+
!!! tip
181+
Native installation is recommended for regular MCP usage since Docker adds latency to each tool call. Docker is best for quick trials and CI environments.
126182

127183
## Image Tags
128184

docs/docs/mcp/getting-started.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,33 @@ brew install redis-developer/homebrew-tap/redisctl
1212

1313
### Linux/Windows
1414

15-
Download from [GitHub Releases](https://github.com/redis-developer/redisctl/releases) or use Docker:
15+
Download from [GitHub Releases](https://github.com/redis-developer/redisctl/releases).
1616

17-
```bash
18-
docker pull ghcr.io/redis-developer/redisctl
17+
See the [Installation Guide](../getting-started/installation.md) for all options.
18+
19+
### Docker (Zero-Install)
20+
21+
No local install required. Pass credentials via environment variables and point your AI assistant at the Docker image:
22+
23+
```json
24+
{
25+
"mcpServers": {
26+
"redisctl": {
27+
"command": "docker",
28+
"args": [
29+
"run", "-i", "--rm",
30+
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
31+
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
32+
"-e", "REDIS_ENTERPRISE_PASSWORD",
33+
"ghcr.io/redis-developer/redisctl",
34+
"redisctl-mcp"
35+
]
36+
}
37+
}
38+
}
1939
```
2040

21-
See the [Installation Guide](../getting-started/installation.md) for all options.
41+
See [Docker Usage](../getting-started/docker.md#mcp-server-zero-install) for more options including mounted configs and local cluster access.
2242

2343
## Setting Up Credentials
2444

0 commit comments

Comments
 (0)