Redis

一個基於Model Context Protocol的Redis數據庫操作服務，提供多種Redis命令工具

數據庫開發者工具 #Redis服務 #數據庫工具 #MCP協議本地 .TypeScript

評分 : 4.2分

下載量 : 14.1K

更新時間 : 2025-04-28

打開站點

什麼是Redis MCP服務器？

Redis MCP服務器是一個通過Model Context Protocol (MCP)協議提供Redis數據庫操作的工具。它允許用戶執行多種Redis命令，如哈希操作、集合操作、排序集操作等，簡化了對Redis數據庫的管理和訪問。

如何使用Redis MCP服務器？

通過配置MCP客戶端（例如Claude Desktop、Cline），您可以輕鬆連接到Redis MCP服務器並執行各種Redis命令。只需設置服務器地址和端口即可開始使用。

適用場景

Redis MCP服務器適用於需要快速訪問Redis數據庫的企業和個人用戶，特別適合於緩存管理、數據分析和即時應用開發。

主要功能

哈希操作

支持設置和獲取哈希表中的字段值，例如HMSET、HGET、HGETALL。

鍵操作

支持掃描、刪除和設置鍵值對，例如SCAN、DEL、SET。

排序集操作

支持添加、移除和查詢排序集成員，例如ZADD、ZRANGE、ZREMBYSCORE。

集合操作

支持添加和查詢集合成員，例如SADD、SMEMBERS。

優勢

簡單易用，無需深入瞭解Redis命令即可操作數據庫。

支持多種Redis命令，滿足多樣化的應用場景需求。

集成MCP協議，便於與其他工具無縫協作。

侷限性

依賴Redis服務器運行環境，需確保Redis已正確安裝。

對於大規模數據處理可能需要優化性能。

如何使用

安裝Redis MCP服務器

通過npm安裝Redis MCP服務器：`npx -y @smithery/cli install redis-mcp --client claude`。

配置MCP客戶端

在MCP客戶端中配置Redis服務器地址和端口，例如：`localhost:6379`。

使用案例

設置和獲取用戶信息

通過Redis MCP服務器設置和獲取用戶信息。

查詢排序集成員

查詢排序集中指定範圍內的成員。

常見問題

Redis MCP服務器支持哪些Redis命令？

如何確保Redis MCP服務器的安全性？

🚀 Redis MCP 服務器

一個提供Redis數據庫操作訪問的模型上下文協議（MCP）服務器，可幫助用戶便捷地進行Redis數據庫的各項操作。

🚀 快速開始

本項目是一個提供Redis數據庫操作訪問的模型上下文協議（MCP）服務器，下面將為你介紹項目的結構、可用工具、開發方式以及許可證信息。

✨ 主要特性

提供多種Redis數據庫操作工具，涵蓋哈希表操作、鍵值操作、有序集合操作等。
支持自定義添加新的Redis工具，方便擴展功能。

📚 詳細文檔

項目結構

src/
├── interfaces/
│   └── types.ts           # 共享的 TypeScript 接口和類型
├── tools/
│   ├── base_tool.ts       # Redis 工具的抽象基礎類
│   ├── tool_registry.ts   # 管理所有可用Redis工具的註冊表
│   ├── hmset_tool.ts      # HMSET Redis 操作
│   ├── hget_tool.ts       # HGET Redis 操作
│   ├── hgetall_tool.ts    # HGETALL Redis 操作
│   ├── scan_tool.ts       # SCAN Redis 操作
│   ├── set_tool.ts        # SET Redis 操作
│   ├── get_tool.ts        # GET Redis 操作
│   ├── del_tool.ts        # DEL Redis 操作
│   ├── zadd_tool.ts       # ZADD Redis 操作
│   ├── zrange_tool.ts     # ZRANGE Redis 操作
│   ├── zrangebyscore_tool.ts # ZRANGEBYSCORE Redis 操作
│   └── zrem_tool.ts       # ZREM Redis 操作
└── redis_server.ts        # 主服務器實現

可用工具

工具	類型	描述	輸入方案
hmset	命令	用於設置哈希表中字段的值	{ field: string, value: string }
hget	命令	通過鍵獲取哈希表中的值	{ key: string, field: string }
hgetall	命令	獲取哈希表中所有字段及其值	{ key: string }
scan	命令	迭代器用於逐步掃描集合的成員	{ key: string, cursor: number }
set	命令	設置鍵的值	{ key: string, value: string }
get	命令	獲取鍵的值	{ key: string }
del	命令	刪除指定的鍵	{ key: string }
zadd	命令	向有序集合中添加一個或多個成員及其分數值	{ key: string, score: number, member: string }
zrange	命令	獲取有序集合指定範圍內的成員	{ key: string, start: number, end: number }
zrangebyscore	命令	根據分數獲取有序集合的成員	{ key: string, min: number, max: number }
zrem	命令	刪除指定的有序集合成員	{ key: string, member: string }

開發

要添加新的Redis工具：

在src/tools/目錄下創建一個新的工具類，繼承自RedisTool
定義工具的接口在src/interfaces/types.ts
將工具註冊到src/tools/tool_registry.ts

💻 使用示例

基礎用法

export class MyTool extends RedisTool {
  name = 'mytool';
  description = '描述工具的功能';
  inputSchema = {
    type: 'object',
    properties: {
      // 定義輸入參數
    },
    required: ['requiredParam']
  };

  validateArgs(args: unknown): args is MyToolArgs {
    // 實現參數驗證
  }

  async execute(args: unknown, client: RedisClientType): Promise<ToolResponse> {
    // 實現工具邏輯
  }
}