Redis MCP Server

The Redis MCP Server is available as a PyPI package and as direct installation from the GitHub repository.

For development or if you prefer to clone the repository:

uv venv
source .venv/bin/activate
uv sync
uv run src/main.py

Once you cloned the repository, installed the dependencies and verified you can run the server, you can configure Claude Desktop or any other MCP Client to use this MCP Server running the main file directly (it uses environment variables). This is usually preferred for development.
The following example is for Claude Desktop, but the same applies to any other MCP Client.

1. Specify your Redis credentials and TLS configuration
2. Retrieve your uv command full path (e.g. which uv)
3. Edit the claude_desktop_config.json configuration file
- on a MacOS, at ~/Library/Application\ Support/Claude/

{
    "mcpServers": {
        "redis": {
            "command": "<full_path_uv_command>",
            "args": [
                "--directory",
                "<your_mcp_server_directory>",
                "run",
                "src/main.py"
            ],
            "env": {
                "REDIS_HOST": "<your_redis_database_hostname>",
                "REDIS_PORT": "<your_redis_database_port>",
                "REDIS_PWD": "<your_redis_database_password>",
                "REDIS_SSL": True|False,
                "REDIS_SSL_CA_PATH": "<your_redis_ca_path>",
                "REDIS_CLUSTER_MODE": True|False
            }
        }
    }
}

You can troubleshoot problems by tailing the log file.

tail -f ~/Library/Logs/Claude/mcp-server-redis.log

When using the CLI interface, you can configure the server with command line arguments:

If desired, you can use environment variables. Defaults are provided for all variables.
| Name                 | Description                                               | Default Value |

|----------------------|-----------------------------------------------------------|---------------|

| REDIS_HOST         | Redis IP or hostname                                      | "127.0.0.1" |

| REDIS_PORT         | Redis port                                                | 6379        |

| REDIS_DB           | Database                                                  | 0             |

| REDIS_USERNAME     | Default database username                                 | "default"   |

| REDIS_PWD          | Default database password                                 | ""            |

| REDIS_SSL          | Enables or disables SSL/TLS                               | False       |

| REDIS_SSL_CA_PATH  | CA certificate for verifying server                       | None          |

| REDIS_SSL_KEYFILE  | Client's private key file for client authentication       | None          |

| REDIS_SSL_CERTFILE | Client's certificate file for client authentication       | None          |

| REDIS_SSL_CERT_REQS| Whether the client should verify the server's certificate | "required"  |

| REDIS_SSL_CA_CERTS | Path to the trusted CA certificates file                  | None          |

| REDIS_CLUSTER_MODE | Enable Redis Cluster mode                                 | False       |
The Redis MCP Server supports EntraID (Azure Active Directory) authentication for Azure Managed Redis, enabling OAuth-based authentication with automatic token management.
Service Principal Authentication - Application-based authentication using client credentials:

Managed Identity Authentication - For Azure-hosted applications:

| Name | Description | Default Value |
|-----------------------------------------|-----------------------------------------------------------|--------------------------------------|
| REDIS_ENTRAID_AUTH_FLOW | Authentication flow type | None (EntraID disabled) |
| REDIS_ENTRAID_CLIENT_ID | Service Principal client ID | None |
| REDIS_ENTRAID_CLIENT_SECRET | Service Principal client secret | None |
| REDIS_ENTRAID_TENANT_ID | Azure tenant ID | None |
| REDIS_ENTRAID_IDENTITY_TYPE | Managed identity type | "system_assigned" |
| REDIS_ENTRAID_USER_ASSIGNED_CLIENT_ID | User-assigned managed identity client ID | None |
| REDIS_ENTRAID_SCOPES | OAuth scopes for Default Azure Credential | "https://redis.azure.com/.default" |
| REDIS_ENTRAID_RESOURCE | Azure Redis resource identifier | "https://redis.azure.com/" |

For local development with Azure CLI:

export REDIS_ENTRAID_AUTH_FLOW=default_credential

export REDIS_URL=redis://your-azure-redis.redis.cache.windows.net:6379

For production with Service Principal:

export REDIS_ENTRAID_AUTH_FLOW=service_principal

export REDIS_ENTRAID_CLIENT_ID=your-app-client-id

export REDIS_ENTRAID_CLIENT_SECRET=your-app-secret

export REDIS_ENTRAID_TENANT_ID=your-tenant-id

export REDIS_URL=redis://your-azure-redis.redis.cache.windows.net:6379

For Azure-hosted applications with Managed Identity:

export REDIS_ENTRAID_AUTH_FLOW=managed_identity

export REDIS_ENTRAID_IDENTITY_TYPE=system_assigned

export REDIS_URL=redis://your-azure-redis.redis.cache.windows.net:6379

There are several ways to set environment variables:

1. Using a .env File:
Place a .env file in your project directory with key-value pairs for each environment variable. Tools like python-dotenv, pipenv, and uv can automatically load these variables when running your application. This is a convenient and secure way to manage configuration, as it keeps sensitive data out of your shell history and version control (if .env is in .gitignore).
For example, create a .env file with the following content from the .env.example file provided in the repository:

cp .env.example .env

Then edit the .env file to set your Redis configuration:

OR,

2. Setting Variables in the Shell:
You can export environment variables directly in your shell before running your application. For example:

export REDIS_HOST=your_redis_host
export REDIS_PORT=6379
If you want to suppress uvx installation messages that may appear as warnings in MCP client logs, use the -qq flag:

The -qq flag enables silent mode, which suppresses "Installed X packages" messages that uvx writes to stderr during package installation.

Alternatively, you can start the server using uv and configure your mcp.json. This is usually desired for development.

> Tip: You can prompt Copilot chat to use the Redis MCP tools by including #redis in your message.

> Note: Starting with VS Code v1.102,
> MCP servers are now stored in a dedicated mcp.json file instead of settings.json`.