farhankaz/redis-mcp

开发工具

本页由 AI 翻译，技术细节请以原文为准。查看原文

6 stars 8 forks 质量 67 趋势 14MIT

Repository Install

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

概览

A Model Context Protocol (MCP) server that provides access to Redis database operations. Configure in your MCP client (e.g., Claude Desktop, Cline): - --redis-host: Redis server host (default: localhost) - --redis-port: Redis server port (default: 6379) To install Redis Server for Claude Desktop automatically via Smithery: 1. Create a new tool class in src/tools/ extending RedisTool 2. Define the tool's interface in src/interfaces/types.ts 3. Register the tool in src/tools/tool_registry.ts The evals package loads an mcp client that then runs the index.ts file, so there is no need to rebuild between tests. You can load environment variables by prefixing the npx command. Full documentation can be found here.

README

以下为原文 README 节选，完整内容请查看原文。

Redis MCP Server

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

Project Structure

src/
├── interfaces/
│   └── types.ts           # Shared TypeScript interfaces and types
├── tools/
│   ├── base_tool.ts       # Abstract base class for Redis tools
│   ├── tool_registry.ts   # Registry managing 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

Available Tools

Tool	Type	Description	Input Schema
hmset	Hash Command	Set multiple hash fields to multiple values	`key`: string (Hash key)`fields`: object (Field-value pairs to set)
hget	Hash Command	Get the value of a hash field	`key`: string (Hash key)`field`: string (Field to get)
hgetall	Hash Command	Get all fields and values in a hash	`key`: string (Hash key)
scan	Key Command	Scan Redis keys matching a pattern	`pattern`: string (Pattern to match, e.g., “user:*”)`count`: number, optional (Number of keys to return)
set	String Command	Set string value with optional NX and PX options	`key`: string (Key to set)`value`: string (Value to set)`nx`: boolean, optional (Only set if not exists)`px`: number, optional (Expiry in milliseconds)
get	String Command	Get string value	`key`: string (Key to get)
del	Key Command	Delete a key	`key`: string (Key to delete)
zadd	Sorted Set Command	Add one or more members to a sorted set	`key`: string (Sorted set key)`members`: array of objects with `score`: number and `value`: string
zrange	Sorted Set Command	Return a range of members from a sorted set by index	`key`: string (Sorted set key)`start`: number (Start index)`stop`: number (Stop index)`withScores`: boolean, optional (Include scores in output)
zrangebyscore	Sorted Set Command	Return members from a sorted set with scores between min and max	`key`: string (Sorted set key)`min`: number (Minimum score)`max`: number (Maximum score)`withScores`: boolean, optional (Include scores in output)

在 GitHub 查看完整 README

安装

npx redis-mcp --redis-host localhost --redis-port 6379

新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "redis": {
      "command": "npx",
      "args": ["redis-mcp", "--redis-host", "localhost", "--redis-port", "6379"],
      "disabled": false
    }
  }
}