Gongrzhe REDIS MCP Server

🚀 Redis Model Context Protocol (MCP) Server (@gongrzhe/server-redis-mcp@1.0.0)

A Redis Model Context Protocol (MCP) server implementation for interacting with Redis databases. This server enables Large Language Models (LLMs) to interact with Redis key - value stores through a set of standardized tools.

🚀 Quick Start

✨ Features

This Redis MCP server provides a set of tools to interact with Redis databases, including setting, getting, deleting, and listing keys. It can be integrated with Claude Desktop and used in Docker environments.

📦 Installation

Install via Smithery

To automatically install the Redis MCP server for Claude Desktop via Smithery:

npx -y @smithery/cli install @gongrzhe/server-redis-mcp --client claude

Manual Installation

# Use npx to specify the version (recommended)
npx @gongrzhe/server-redis-mcp@1.0.0 redis://your-redis-host:port

# Example:
npx @gongrzhe/server-redis-mcp@1.0.0 redis://localhost:6379

Or install globally:

# Install the specified version globally
npm install -g @gongrzhe/server-redis-mcp@1.0.0

# Run after installation
@gongrzhe/server-redis-mcp redis://your-redis-host:port

💻 Usage Examples

Components - Tools

• set

  • Set a Redis key - value pair with an optional expiration time.
  • Input:
    • key (string): The Redis key.
    • value (string): The value to store.
    • expireSeconds (number, optional): The expiration time in seconds.

• get

  • Get a value from Redis based on the key.
  • Input: key (string): The Redis key to retrieve.

• delete

  • Delete one or more Redis keys.
  • Input: key (string | array of strings): The key or array of keys.

• list

  • List matching Redis keys based on a pattern.
  • Input: pattern (string, optional): The key pattern to match (default: *).

📚 Documentation

Configuration

Usage with Claude Desktop

To use this server in the Claude Desktop application, add the following configuration to the "mcpServers" section of the claude_desktop_config.json file:

{
  "mcpServers": {
    "redis": {
      "command": "npx",
      "args": [
        "@gongrzhe/server-redis-mcp@1.0.0",
        "redis://localhost:6379"
      ]
    }
  }
}

Or, if you have installed the package, you can use the node command directly:

{
  "mcpServers": {
    "redis": {
      "command": "node",
      "args": [
        "path/to/build/index.js",
        "redis://10.1.210.223:6379"
      ]
    }
  }
}

Usage with Docker

When using Docker:

• For macOS, use host.docker.internal when the Redis server is running on the host network.
• The Redis URL can be specified as a parameter, with the default being "redis://localhost:6379".

{
  "mcpServers": {
    "redis": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-it",
        "redis:alpine",
        "redis-cli",
        "redis://host.docker.internal:6379"
      ]
    }
  }
}

Build and Test

To build the project, run:

npm run build

Then start the server with the following command:

node dist/index.js redis://localhost:6379

📄 License

Please refer to the project's license file for detailed information.