REDIS MCP Server

🚀 Redis 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 the Redis key - value store through a set of standardized tools.

✨ Features

• A Redis MCP server implementation for interacting with Redis databases.
• Enables LLMs to interact with Redis key - value stores via standardized tools.

📦 Installation

Automatic Installation via Smithery

Automatically install the Redis MCP Server for Claude Desktop through 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:

# Globally install the specified version
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

  • Retrieve 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 Redis keys based on a pattern.
  • Input: pattern (string, optional): The pattern to match keys (default: *).

Configuration

Usage with Claude Desktop

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

{
  "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

Use in Docker:

docker run -p 3000:3000 ghcr.io/gongrzhe/server-redis-mcp:1.0.0

Access http://localhost:3000.

🔧 Technical Details

Development

Build from Source Code

npm install
npm run build

Docker Deployment

# Use the base image
FROM node:18

# Set the working directory
WORKDIR /app

# Copy the package files
COPY package*.json ./

# Install dependencies
RUN npm install --production

# Copy the application code
COPY . .

# Expose the port
EXPOSE 3000

# Run the server
CMD ["npm", "start"]

docker build -t server-redis-mcp:1.0.0 .
docker run -p 3000:3000 server-redis-mcp:1.0.0

📚 Documentation

Updates

62 Redis MCP tools are located at https://github.com/GongRzhe/REDIS-MCP-Server/tree/redis-plus.

By following the above steps, you can easily set up and use the Redis MCP server.