REDIS-MCP-Server
by: GongRzhe
A Redis Model Context Protocol (MCP) server implementation for interacting with Redis databases. This server enables LLMs to interact with Redis key-value stores through a set of standardized tools.
📌Overview
Purpose: The Redis MCP Server provides an implementation for interacting with Redis databases via a standardized Model Context Protocol (MCP), enabling seamless communication between large language models (LLMs) and Redis key-value stores.
Overview: This server allows users to connect and manage Redis databases efficiently, offering tools for setting, getting, deleting, and listing keys. It is designed for easy integration with applications, including support for various installation methods and usage with Docker.
Key Features:
-
Set: Enables users to set a key-value pair in Redis, with an option for setting an expiration time, enhancing data management flexibility.
-
Get: Allows retrieval of values based on keys, supporting efficient data access within Redis.
-
Delete: Provides functionality to remove single or multiple keys, streamlining data cleanup processes.
-
List: Supports listing keys that match a specific pattern, facilitating organized key management.
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 LLMs to interact with Redis key-value stores through a set of standardized tools.
Update
62 Redis MCP tools in https://github.com/GongRzhe/REDIS-MCP-Server/tree/redis-plus
Installation & Usage
Installing via Smithery
To install Redis MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @gongrzhe/server-redis-mcp --client claude
Installing Manually
# Using npx with specific 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 specific version globally
npm install -g @gongrzhe/server-redis-mcp@1.0.0
# Run after global installation
@gongrzhe/server-redis-mcp redis://your-redis-host:port
Components
Tools
-
set
- Set a Redis key-value pair with optional expiration
- Input:
key
(string): Redis keyvalue
(string): Value to storeexpireSeconds
(number, optional): Expiration time in seconds
-
get
- Get value by key from Redis
- Input:
key
(string): Redis key to retrieve
-
delete
- Delete one or more keys from Redis
- Input:
key
(string | string[]): Key or array of keys to delete
-
list
- List Redis keys matching a pattern
- Input:
pattern
(string, optional): Pattern to match keys (default: *)
Configuration
Usage with Claude Desktop
To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your claude_desktop_config.json
:
{
"mcpServers": {
"redis": {
"command": "npx",
"args": [
"@gongrzhe/server-redis-mcp@1.0.0",
"redis://localhost:6379"
]
}
}
}
Alternatively, you can use the node command directly if you have the package installed:
{
"mcpServers": {
"redis": {
"command": "node",
"args": [
"path/to/build/index.js",
"redis://10.1.210.223:6379"
]
}
}
}
Docker Usage
When using Docker:
- For macOS, use
host.docker.internal
if the Redis server is running on the host network - Redis URL can be specified as an argument, defaults to "redis://localhost:6379"
{
"mcpServers": {
"redis": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"mcp/redis",
"redis://host.docker.internal:6379"
]
}
}
}
Development
Building from Source
- Clone the repository
- Install dependencies:
npm install
- Build the project:
npm run build
Docker Build
docker build -t mcp/redis .
License
This MCP server is licensed under the ISC License. For more details, please see the LICENSE file in the project repository.