Redis

🚀 Redis MCP Server

A Model Context Protocol (MCP) server that provides access to Redis database operations.

🚀 Quick Start

This Redis MCP Server offers access to Redis database operations. It's designed to simplify interactions with Redis through a well - structured project and a set of available tools.

✨ Features

• Rich Redis Operations: Supports a variety of Redis operations such as HMSET, HGET, HGETALL, etc.
• Modular Design: The project has a clear structure, making it easy to add new Redis tools.

📦 Installation

No installation steps are provided in the original document, so this section is skipped.

💻 Usage Examples

Basic Usage

The project structure shows how different components are organized:

src/
├── interfaces/
│   └── types.ts           # Shared TypeScript interfaces and types
├── tools/
│   ├── base_tool.ts       # Abstract base class for Redis tools
│   ├── tool_registry.ts   # Registry to manage all available Redis tools
│   ├── hmset_tool.ts      # HMSET Redis operation
│   ├── hget_tool.ts       # HGET Redis operation
│   ├── hgetall_tool.ts    # HGETALL Redis operation
│   ├── scan_tool.ts       # SCAN Redis operation
│   ├── set_tool.ts        # SET Redis operation
│   ├── get_tool.ts        # GET Redis operation
│   ├── del_tool.ts        # DEL Redis operation
│   ├── zadd_tool.ts       # ZADD Redis operation
│   ├── zrange_tool.ts     # ZRANGE Redis operation
│   ├── zrangebyscore_tool.ts # ZRANGEBYSCORE Redis operation
│   └── zrem_tool.ts       # ZREM Redis operation
└── redis_server.ts        # Main server implementation

Advanced Usage

To add a new Redis tool, follow these steps:

1. Create a new tool class in the src/tools/ directory, inheriting from RedisTool.
2. Define the tool's interface in src/interfaces/types.ts.
3. Register the tool in src/tools/tool_registry.ts.

Here is an example of a tool implementation:

export class MyTool extends RedisTool {
  name = 'mytool';
  description = 'Describe the function of the tool';
  inputSchema = {
    type: 'object',
    properties: {
      // Define input parameters
    },
    required: ['requiredParam']
  };

  validateArgs(args: unknown): args is MyToolArgs {
    // Implement parameter validation
  }

  async execute(args: unknown, client: RedisClientType): Promise<ToolResponse> {
    // Implement tool logic
  }
}

📚 Documentation

Available Tools

🔧 Technical Details

The project uses a modular design. The src/interfaces/types.ts file stores shared TypeScript interfaces and types, which helps maintain type consistency across the project. The src/tools directory contains various Redis operation tools, each inheriting from the base_tool.ts abstract base class. The tool_registry.ts manages all available tools, making it easy to register and use new tools.

📄 License

This project is licensed under the MIT license: https://opensource.org/license/mit