Redis

🚀 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        # 主服務器實現

可用工具

開發

要添加新的Redis工具：

1. 在src/tools/目錄下創建一個新的工具類，繼承自RedisTool
2. 定義工具的接口在src/interfaces/types.ts
3. 將工具註冊到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> {
    // 實現工具邏輯
  }
}

📄 許可證

本項目採用 MIT 許可證，詳情請見：https://opensource.org/license/mit