Skip to main content

An AWS Labs Model Context Protocol (MCP) server for valkey

Project description

Amazon ElastiCache/MemoryDB Valkey MCP Server

An AWS Labs Model Context Protocol (MCP) server for Amazon ElastiCache Valkey datastores.

Features

This MCP server provides tools to operate on Valkey data types. For example, it allows an agent to operate with Valkey Strings using commands such as SET, SETRANGE, GET, GETRANGE, APPEND, INCREMENT and more.

Supported Data Types

  • Strings- Store, retrieve, append, increment, decrement, length and more.
  • Lists- Manage List collections with push/pop operations.
  • Sets and Sorted Sets- Store and retrieve items from Sets.
  • Hashes- Store and retrieve items in Hashes. Check for existence of items in a hash, increment item values in a Hash, and more.
  • Streams- Store, retrieve, trim items in Streams.
  • Bitmaps- Bitmaps let you perform bitwise operations on strings.
  • JSONs- Store and retrieve JSON documents with path-based access.
  • HyperLogLog- Store and count items in HyperLogs.

Advanced Features

  • Cluster Support: Support for standalone and clustered Valkey deployments.
  • SSL/TLS Security: Configure secure connections using SSL/TLS.
  • Connection Pooling: Pools connections by default to enable efficient connection management.

Prerequisites

  1. Install uv from Astral or the GitHub README
  2. Install Python using uv python install 3.10
  3. Access to a Valkey datastore.
  4. For instructions to connect to an Amazon ElastiCache/MemoryDB Valkey datastore click here.

Installation

Here are some ways you can work with MCP across AWS tools (e.g., for Amazon Q Developer CLI MCP, ~/.aws/amazonq/mcp.json):

{
  "mcpServers": {
    "awslabs.valkey-mcp-server": {
      "command": "uvx",
      "args": [
        "awslabs.valkey-mcp-server@latest"
      ],
      "env": {
        "VALKEY_HOST": "127.0.0.1",
        "VALKEY_PORT": "6379",
        "FASTMCP_LOG_LEVEL": "ERROR"
      },
      "autoApprove": [],
      "disabled": false
    }
  }
}

Or using Docker after a successful docker build -t awslabs/valkey-mcp-server .:

{
  "mcpServers": {
    "awslabs.valkey-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "--interactive",
        "--env",
        "FASTMCP_LOG_LEVEL=ERROR",
        "--env",
        "VALKEY_HOST=127.0.0.1",
        "--env",
        "VALKEY_PORT=6379",
        "awslabs/valkey-mcp-server:latest"
      ],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}

Configuration

The server can be configured using the following environment variables:

Name Description Default Value
VALKEY_HOST ElastiCache Primary Endpoint or MemoryDB Cluster Endpoint or Valkey IP or hostname "127.0.0.1"
VALKEY_PORT Valkey port 6379
VALKEY_USERNAME Default database username None
VALKEY_PWD Default database password ""
VALKEY_USE_SSL Enables or disables SSL/TLS False
VALKEY_CA_PATH CA certificate for verifying server None
VALKEY_SSL_KEYFILE Client's private key file None
VALKEY_SSL_CERTFILE Client's certificate file None
VALKEY_CERT_REQS Server certificate verification "required"
VALKEY_CA_CERTS Path to trusted CA certificates None
VALKEY_CLUSTER_MODE Enable Valkey Cluster mode False

Example Usage

Here are some example natural language queries that the server can handle:

"Store user profile data in a hash"
"Add this event to the activity stream"
"Cache API response for 5 minutes"
"Store JSON document with nested fields"
"Add score 100 to user123 in leaderboard"
"Get all members of the admins set"

Development

Running Tests

uv venv
source .venv/bin/activate
uv sync
uv run --frozen pytest

Building Docker Image

docker build -t awslabs/valkey-mcp-server .

Running Docker Container

docker run -p 8080:8080 \
  -e VALKEY_HOST=host.docker.internal \
  -e VALKEY_PORT=6379 \
  awslabs/valkey-mcp-server

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awslabs_valkey_mcp_server-1.0.2.tar.gz (89.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

awslabs_valkey_mcp_server-1.0.2-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file awslabs_valkey_mcp_server-1.0.2.tar.gz.

File metadata

File hashes

Hashes for awslabs_valkey_mcp_server-1.0.2.tar.gz
Algorithm Hash digest
SHA256 4ce0620037e0335fc2f0ed1556f585756f0687f4ead931c11d8fa5f2e879ee0d
MD5 5258234e60472cec020aa62ea1c5ec66
BLAKE2b-256 5df2e595ea5d103124d2bca6f75c128ca00d15c0e2e5059fb4fc9d30271f63a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_valkey_mcp_server-1.0.2.tar.gz:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file awslabs_valkey_mcp_server-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_valkey_mcp_server-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1145da87b8982105edf0f52888d55d1318ea8d1e402a5f43faa7ee34eb7ad0c9
MD5 6a3d13ebc25e78b325fb7b28757f1536
BLAKE2b-256 558f8feec0a765974bd96938572351772748e0c596236374b199c1325cd8e4c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_valkey_mcp_server-1.0.2-py3-none-any.whl:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page