mekayelanik/valkey-mcp-server

Valkey MCP Server

https://hub.docker.com/r/mekayelanik/valkey-mcp-server https://hub.docker.com/r/mekayelanik/valkey-mcp-server https://github.com/MekayelAnik/valkey-mcp-docker/pkgs/container/valkey-mcp-server https://github.com/MekayelAnik/valkey-mcp-docker/blob/main/LICENSE https://hub.docker.com/r/mekayelanik/valkey-mcp-server https://github.com/MekayelAnik/valkey-mcp-docker/stargazers https://github.com/MekayelAnik/valkey-mcp-docker/forks https://github.com/MekayelAnik/valkey-mcp-docker/issues https://github.com/MekayelAnik/valkey-mcp-docker/commits/main

Multi-Architecture Docker Image for Valkey Data Management

---

😎 Buy Me a Coffee ☕︎

Your support encourages me to keep creating/supporting my open-source projects. If you found value in this project, you can buy me a coffee to keep me inspired.

Table of Contents

• Overview
• Supported Architectures
• Available Tags
• Quick Start
• Configuration
• MCP Client Configuration
• Network Configuration
• Updating
• Troubleshooting
• Additional Resources
• Support & License

---

Overview

Valkey MCP Server is a Model Context Protocol server that provides tools for managing and interacting with Valkey databases. Built on Alpine Linux for minimal footprint and maximum security, wrapped with https://github.com/sparfenyuk/mcp-proxy (replacing supergateway) for StreamableHTTP/SSE transport. Valkey is an open-source, high-performance key/value datastore that is fully compatible with the Redis protocol.

Key Features

• Multi-Architecture Support - Native support for x86-64 and ARM64
• Multiple Transport Protocols - StreamableHTTP and SSE via mcp-proxy (exposed simultaneously)
• Secure by Design - Alpine-based with minimal *** surface
• High Performance - ZSTD compression for faster deployments
• Production Ready - Stable releases with comprehensive testing
• Easy Configuration - Simple environment variable setup

---

Supported Architectures

Multi-arch images automatically select the correct architecture for your system.

---

Available Tags

System Requirements

• Docker Engine: 23.0+
• RAM: Minimum 512MB
• CPU: Single core sufficient

CRITICAL: Do NOT expose this container directly to the internet without proper security measures (reverse proxy, SSL/TLS, authentication, firewall rules).

---

Quick Start

Docker Compose (Recommended)

yaml
services:
  valkey-mcp-server:
    image: mekayelanik/valkey-mcp-server:stable
    container_name: valkey-mcp-server
    restart: unless-stopped
    ports:
      - "8040:8040"
    environment:
      - PORT=8040
      - INTERNAL_PORT=38011
      - PUID=1000
      - PGID=1000
      - TZ=Asia/Dhaka
      - PROTOCOL=SHTTP
      # ENABLE_HTTPS=false is plaintext over the wire. Safe ONLY for loopback
      # / trusted internal networks. Set to "true" for any public, multi-host,
      # or untrusted deployment — HAProxy auto-generates a self-signed cert
      # if none is mounted under /etc/haproxy/certs/.
      - ENABLE_HTTPS=false
      - HTTP_VERSION_MODE=auto
      # mcp-proxy session model. Stateful by default — one stdio child shared
      # across all sessions (multiplexed via JSON-RPC ids). Set to true only
      # if full per-request isolation is required (memory-hostile).
      - MCP_PROXY_STATELESS=false
      # Cap virtual memory of the valkey-mcp stdio child (MiB; 0 disables)
      - VALKEY_MAX_MEM_MB=1024
      # HAProxy concurrency caps (0 disables)
      - HAPROXY_FRONTEND_MAXCONN=64
      - HAPROXY_SERVER_MAXCONN=16
      # Valkey connection settings
      # - VALKEY_URL=valkey://localhost:6379
      # - VALKEY_HOST=localhost
      # - VALKEY_PORT=6379
      # - VALKEY_USERNAME=
      # - VALKEY_PWD=
      # - VALKEY_USE_SSL=false
      # - VALKEY_SSL_CA_PATH=
      # - VALKEY_SSL_KEYFILE=
      # - VALKEY_SSL_CERTFILE=
      # - VALKEY_SSL_CERT_REQS=required
      # - VALKEY_SSL_CA_CERTS=
      # - VALKEY_CLUSTER_MODE=false
      # Optional: require Bearer token auth at HAProxy layer
      # - API_KEY=replace-with-strong-secret
    hostname: valkey-mcp-server
    domainname: local

Deploy:

bash
docker compose up -d
docker compose logs -f valkey-mcp-server

Docker CLI

bash
docker run -d \
  --name=valkey-mcp-server \
  --restart=unless-stopped \
  -p 8040:8040 \
  -e PORT=8040 \
  -e INTERNAL_PORT=38011 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Asia/Dhaka \
  -e PROTOCOL=SHTTP \
  -e ENABLE_HTTPS=false \
  -e HTTP_VERSION_MODE=auto \
  mekayelanik/valkey-mcp-server:stable

Access Endpoints

When HTTPS is enabled (ENABLE_HTTPS=true), use TLS endpoints:

WebSocket transport was dropped in the migration to mcp-proxy. Setting PROTOCOL=WS will now fail at startup with a clear message. Use SHTTP or SSE instead.

Security Warning: The container now defaults to HTTP (ENABLE_HTTPS=false) for easier local setup. Use ENABLE_HTTPS=true for production, public networks, or any untrusted environment.

ARM Devices: Allow 30-60 seconds for initialization before accessing endpoints.

---

Configuration

Environment Variables

HTTPS and HTTP Version Notes

• If ENABLE_HTTPS=true and cert files are missing, the container auto-generates a self-signed certificate.
• If TLS_CERT_PATH and TLS_KEY_PATH exist, they are merged into TLS_PEM_PATH and used directly.
• HTTP_VERSION_MODE=h3 (or auto) enables HTTP/3 only when HAProxy build includes QUIC; otherwise it safely falls back.

API Key Authentication Notes

• Set API_KEY to enforce authentication at reverse proxy level.
• Expected header format: Authorization: Bearer <API_KEY>.
• Localhost health checks remain accessible for liveness/readiness.

Rate Limiting and IP Access Control

• Rate limiting: Set RATE_LIMIT=100 to allow 100 requests per RATE_LIMIT_PERIOD (default 10s) per IP. Exceeding the limit returns HTTP 429 with a Retry-After header.
• Connection limiting: Set MAX_CONNECTIONS_PER_IP=50 to cap concurrent connections per IP. Exceeding returns HTTP 429.
• IP blocklist: Set IP_BLOCKLIST=192.0.2.0/24,198.51.100.5 to block specific IPs/CIDRs. Blocked IPs receive HTTP 403.
• IP allowlist: Set IP_ALLOWLIST=10.0.0.0/8,192.168.1.0/24 to allow only listed IPs/CIDRs. All others receive HTTP 403. Localhost is always allowed.
• All features default to disabled. Com***e as needed — blocklist is checked before allowlist.

Memory & Concurrency Tuning

mcp-proxy runs the Valkey MCP backend as a single long-lived stdio child and multiplexes all client sessions through it via JSON-RPC ids. This caps the expected memory footprint; the knobs below cap the worst case:

• MCP_PROXY_STATELESS=false (default) — share one backend child across all sessions. Recommended for almost every deployment. Flip to true only when you genuinely need per-request isolation.
• VALKEY_MAX_MEM_MB=1024 — caps the virtual-memory size of the valkey-mcp child via prlimit --as. A runaway backend gets OOM-killed by the kernel before it exhausts the host.
• HAPROXY_FRONTEND_MAXCONN=64 + HAPROXY_SERVER_MAXCONN=16 — bound concurrent connections at the HAProxy layer so a burst cannot saturate the upstream stdio bridge.
• /healthz is answered directly by HAProxy with a local 200 — Docker's container healthcheck no longer depends on upstream MCP readiness.

User & Group IDs

Find your IDs and set them to avoid permission issues:

bash
id username
# uid=1000(user) gid=1000(group)

Timezone Examples

yaml
- TZ=Asia/Dhaka        # Bangladesh
- TZ=America/New_York  # US Eastern
- TZ=Europe/London     # UK
- TZ=UTC               # Universal Time

---

MCP Client Configuration

Transport Support

WebSocket transport was dropped in the migration to mcp-proxy.

---

VS Code (Cline/Roo-Cline)

Configure in .vscode/settings.json:

json
{
  "mcp.servers": {
    "valkey-mcp": {
      "url": "http://host-ip:8040/mcp",
      "transport": "http"
    }
  }
}

---

Claude Desktop App/Claude Code

With API_KEY:

claude mcp add-json valkey-mcp '{"type":"http","url":"http://localhost:8040/mcp","headers":{"Authorization":"Bearer <YOUR_API_KEY>"}}'

Without API_KEY:

claude mcp add-json valkey-mcp '{"type":"http","url":"http://localhost:8040/mcp"}'

---

Codex CLI

Configure in ~/.codex/config.json:

json
{
  "mcpServers": {
    "valkey-mcp": {
      "transport": "http",
      "url": "http://host-ip:8040/mcp"
    }
  }
}

---

Codeium (Windsurf)

Configure in .codeium/mcp_settings.json:

json
{
  "mcpServers": {
    "valkey-mcp": {
      "transport": "http",
      "url": "http://host-ip:8040/mcp"
    }
  }
}

---

Cursor

Configure in ~/.cursor/mcp.json:

json
{
  "mcpServers": {
    "valkey-mcp": {
      "transport": "http",
      "url": "http://host-ip:8040/mcp"
    }
  }
}

---

Testing Configuration

Verify with https://github.com/modelcontextprotocol/inspector:

bash
npm install -g @modelcontextprotocol/inspector
mcp-inspector http://host-ip:8040/mcp

---

Network Configuration

Comparison

---

Bridge Network (Default)

yaml
services:
  valkey-mcp-server:
    image: mekayelanik/valkey-mcp-server:stable
    ports:
      - "8040:8040"

Benefits: Container isolation, easy setup, works everywhere Access: http://localhost:8040/mcp

---

Host Network (Linux Only)

yaml
services:
  valkey-mcp-server:
    image: mekayelanik/valkey-mcp-server:stable
    network_mode: host

Benefits: Maximum performance, no NAT overhead, no port mapping needed ***ations: Linux only, shares host network namespace Access: http://localhost:8040/mcp

---

MACVLAN Network (Advanced)

yaml
services:
  valkey-mcp-server:
    image: mekayelanik/valkey-mcp-server:stable
    mac_address: "AB:BC:CD:DE:EF:01"
    networks:
      macvlan-net:
        ipv4_address: 192.168.1.100

networks:
  macvlan-net:
    driver: macvlan
    driver_opts:
      parent: eth0
    ipam:
      config:
        - subnet: 192.168.1.0/24
          gateway: 192.168.1.1

Benefits: Dedicated IP, direct LAN access ***ations: Linux only, requires additional setup Access: http://192.168.1.100:8040/mcp

---

Updating

Docker Compose

bash
docker compose pull
docker compose up -d
docker image prune -f

Docker CLI

bash
docker pull mekayelanik/valkey-mcp-server:stable
docker stop valkey-mcp-server && docker rm valkey-mcp-server
# Run your original docker run command
docker image prune -f

One-Time Update with Watchtower

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once \
  valkey-mcp-server

---

Troubleshooting

Pre-Flight Checklist

• Docker Engine 23.0+
• Port 8040 available
• Sufficient startup time (ARM devices)
• Latest stable image
• Correct configuration

Common Issues

Container Won't Start

bash
# Check Docker version
docker --version

# Verify port availability
sudo netstat -tulpn | grep 8040

# Check logs
docker logs valkey-mcp-server

Permission Errors

bash
# Get your IDs
id $USER

# Update configuration with correct PUID/PGID
# Fix volume permissions if needed
sudo chown -R 1000:1000 /path/to/volume

Client Cannot Connect

bash
# Test connectivity
curl http://localhost:8040/mcp
curl http://host-ip:8040/mcp
curl -k https://localhost:8040/mcp
curl -k https://host-ip:8040/mcp

# Check firewall
sudo ufw status

# Verify container
docker inspect valkey-mcp-server | grep IPAddress

Slow ARM Performance

• Wait 30-60 seconds after start
• Monitor: docker logs -f valkey-mcp-server
• Check resources: docker stats valkey-mcp-server
• Use faster storage (SSD vs SD card)

Debug Information

When reporting issues, include:

bash
# System info
docker --version && uname -a

# Container logs
docker logs valkey-mcp-server --tail 200 > logs.txt

# Container config
docker inspect valkey-mcp-server > inspect.json

---

Additional Resources

Documentation

• https://github.com/awslabs/mcp
• https://pypi.org/project/awslabs.valkey-mcp-server/
• https://github.com/sparfenyuk/mcp-proxy
• https://github.com/modelcontextprotocol/inspector

Docker Resources

• https://docs.docker.com/compose/production/
• https://docs.docker.com/network/
• https://docs.docker.com/engine/security/

Monitoring

• https://crazymax.dev/diun/
• https://containrrr.dev/watchtower/

---

😎 Buy Me a Coffee ☕︎

Your support encourages me to keep creating/supporting my open-source projects. If you found value in this project, you can buy me a coffee to keep me inspired.

Support & License

Getting Help

Docker Image Issues:

• GitHub: https://github.com/MekayelAnik/valkey-mcp-docker/issues

Valkey MCP Issues:

• GitHub: https://github.com/awslabs/mcp/issues

Contributing

We welcome contributions:

1. Report bugs via GitHub Issues
2. Suggest features
3. Improve documentation
4. Test beta releases

License

GPL License. See https://raw.githubusercontent.com/MekayelAnik/valkey-mcp-docker/refs/heads/main/LICENSE for details.

Valkey MCP server has its own license - see https://github.com/awslabs/mcp.

---