Redis

🚀 Redis MCP サーバー

Redisデータベース操作へのアクセスを提供するモデルコンテキストプロトコル（MCP）サーバーです。

🚀 クイックスタート

このRedis MCPサーバーは、Redisデータベース操作へのアクセスを提供します。以下では、サーバーの構造や利用可能なツール、開発方法について説明します。

✨ 主な機能

• Redisデータベース操作へのアクセスを提供します。
• 様々な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