Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -460,9 +460,27 @@ Configure your AI assistant (Claude Desktop, Cursor, etc.) to use it:
}
```

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

See the [MCP Documentation](https://redis-field-engineering.github.io/redisctl-docs/mcp/) for full setup instructions.
```json
{
"mcpServers": {
"redisctl": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
"-e", "REDIS_ENTERPRISE_PASSWORD",
"ghcr.io/redis-developer/redisctl",
"redisctl-mcp"
]
}
}
}
```

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).

---

Expand Down
90 changes: 73 additions & 17 deletions docs/docs/getting-started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,27 +84,35 @@ docker run --rm \
enterprise support-package cluster --output-dir /output
```

## MCP Server
## MCP Server (Zero-Install)

The Docker image also includes `redisctl-mcp` for AI assistant integration:
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.

```bash
# Run MCP server with environment credentials
docker run -i --rm \
-e REDIS_ENTERPRISE_URL \
-e REDIS_ENTERPRISE_USER \
-e REDIS_ENTERPRISE_PASSWORD \
ghcr.io/redis-developer/redisctl \
redisctl-mcp --read-only=false
### Option 1: Environment Variables (Simplest)

# Or mount config for profile-based auth
docker run -i --rm \
-v ~/.config/redisctl:/root/.config/redisctl:ro \
ghcr.io/redis-developer/redisctl \
redisctl-mcp --profile my-profile
Pass credentials as environment variables. The password is pulled from your host environment rather than hardcoded:

```json
{
"mcpServers": {
"redisctl": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
"-e", "REDIS_ENTERPRISE_PASSWORD",
"ghcr.io/redis-developer/redisctl",
"redisctl-mcp"
]
}
}
}
```

For IDE configuration (note the `-i` flag for stdin):
### Option 2: Mounted Config

Mount your existing redisctl config directory for profile-based auth:

```json
{
Expand All @@ -122,7 +130,55 @@ For IDE configuration (note the `-i` flag for stdin):
}
```

**Note:** Native installation is recommended for MCP usage since Docker adds latency to each tool call.
### Option 3: Local Clusters (Host Networking)

For clusters running on localhost (e.g. Docker Compose demos), use `--network host` so the container can reach host ports:

```json
{
"mcpServers": {
"redisctl": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"--network", "host",
"-e", "REDIS_ENTERPRISE_URL=https://localhost:9443",
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
"-e", "REDIS_ENTERPRISE_PASSWORD",
"-e", "REDIS_ENTERPRISE_INSECURE=true",
"ghcr.io/redis-developer/redisctl",
"redisctl-mcp"
]
}
}
}
```

!!! note
`--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.

### Running from the CLI

You can also run the MCP server directly:

```bash
# With environment credentials
docker run -i --rm \
-e REDIS_ENTERPRISE_URL \
-e REDIS_ENTERPRISE_USER \
-e REDIS_ENTERPRISE_PASSWORD \
ghcr.io/redis-developer/redisctl \
redisctl-mcp

# With mounted config
docker run -i --rm \
-v ~/.config/redisctl:/root/.config/redisctl:ro \
ghcr.io/redis-developer/redisctl \
redisctl-mcp --profile my-profile
```

!!! tip
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.

## Image Tags

Expand Down
28 changes: 24 additions & 4 deletions docs/docs/mcp/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,33 @@ brew install redis-developer/homebrew-tap/redisctl

### Linux/Windows

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

```bash
docker pull ghcr.io/redis-developer/redisctl
See the [Installation Guide](../getting-started/installation.md) for all options.

### Docker (Zero-Install)

No local install required. Pass credentials via environment variables and point your AI assistant at the Docker image:

```json
{
"mcpServers": {
"redisctl": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "REDIS_ENTERPRISE_URL=https://cluster:9443",
"-e", "REDIS_ENTERPRISE_USER=admin@redis.local",
"-e", "REDIS_ENTERPRISE_PASSWORD",
"ghcr.io/redis-developer/redisctl",
"redisctl-mcp"
]
}
}
}
```

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

## Setting Up Credentials

Expand Down
Loading