Skip to main content

A FastMCP-based server with SSE support for Redis operations

Project description

Redis MCP Server

A Model Context Protocol (MCP) server for Redis operations built with FastMCP.

Features

  • Core Redis operations: get, set, delete, list
  • Bulk operations: mget, mset
  • Pattern-based key scanning
  • Connection pooling for efficient Redis access
  • Multiple transport support (stdio, SSE, streamable-http)
  • Environment-based configuration
  • Type hints and comprehensive error handling

Installation

From PyPI

pip install redis-mcp

Or using uv:

uv tool install redis-mcp

From Source

# Clone the repository
git clone https://github.com/yourusername/redis-mcp.git
cd redis-mcp

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install the package
pip install -e .

Configuration

The server can be configured via environment variables:

  • REDIS_HOST: Redis server hostname (default: localhost)
  • REDIS_PORT: Redis server port (default: 6379)
  • REDIS_DB: Redis database number (default: 0)
  • REDIS_PASSWORD: Redis password (optional)
  • REDIS_USERNAME: Redis username (optional)

Usage

As a CLI Tool

# Using stdio transport (default)
redis-mcp

# Using SSE transport
redis-mcp --transport sse

# With custom Redis connection
redis-mcp --host redis.example.com --port 6380 --db 1

In Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "redis": {
      "command": "uvx",
      "args": ["redis-mcp"],
      "env": {
        "REDIS_HOST": "localhost",
        "REDIS_PORT": "6379"
      }
    }
  }
}

Available Tools

  • get: Retrieve a value by key
  • set: Store a key-value pair with optional expiry and conditions
  • delete: Remove one or more keys
  • list: List keys matching a pattern
  • mget: Get multiple values in one operation
  • mset: Set multiple key-value pairs in one operation
  • scan: Iterate through keys matching a pattern without blocking

Example Usage

from fastmcp import Client

async def main():
    async with Client("http://localhost:8000/sse") as client:
        # Set a value
        await client.call_tool("set", {"key": "user:123", "value": "John Doe"})
        
        # Get a value
        result = await client.call_tool("get", {"key": "user:123"})
        print(result)  # "John Doe"
        
        # List keys
        keys = await client.call_tool("list", {"pattern": "user:*"})
        print(keys)  # ["user:123"]

Development

Setup

# Install development dependencies
pip install -e ".[dev]"

Running Tests

pytest

Code Quality

# Format code
black .
isort .

# Type checking
mypy .

# Linting
ruff check .

Requirements

  • Python 3.10+
  • Redis server
  • FastMCP 2.3.3+

License

MIT

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

redis_mcp-0.1.3.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

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

redis_mcp-0.1.3-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file redis_mcp-0.1.3.tar.gz.

File metadata

  • Download URL: redis_mcp-0.1.3.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for redis_mcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 43fd25e67243f4b8d9efbd0077aff586373189aced8eaf76ee408292c17cdadb
MD5 37309d4b233726a46d1d6be825a2e944
BLAKE2b-256 5fb68a6eb59d89878ae279a39fd108c7e77995ce7b8b6873ec3e46e8052c8f6e

See more details on using hashes here.

File details

Details for the file redis_mcp-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: redis_mcp-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for redis_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ee0e8b430644f36843848c6a02e2cd804b8c24e5b8033ff12a4d464c33118d90
MD5 7c5453097a1e9bacf128c8e2c47da2cd
BLAKE2b-256 8579ab351b42f9b741ea641b2e79969b0313868a6e552ddd4b2e8f6b234d9406

See more details on using hashes here.

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