Sidekiq MCP

🚀 Sidekiq MCP

Sidekiq MCPは、MCP（Model Context Protocol）サーバーを提供するSidekiqプラグインです。これにより、LLM（大規模言語モデル）が標準化されたインターフェースを通じて、Sidekiqのキュー、統計情報、失敗したジョブとやり取りできるようになります。

🚀 クイックスタート

Sidekiq MCPを使用することで、LLMがSidekiqの様々な情報を取得し、ジョブを管理できます。以下に、利用可能なツール、インストール方法、使用例などを説明します。

✨ 主な機能

統計情報とモニタリング

• sidekiq_stats - Sidekiqの一般的な統計情報（処理済み、失敗、実行中、キュー内のジョブ数）を取得します。
• job_class_stats - ジョブクラスごとのジョブ数、リトライ回数、エラー率の内訳を表示します。
• workers_count - 実行中およびビジーなワーカーの数を表示します。
• queue_health - キューがバックアップされているか、正常かを判断するヒューリスティック情報を提供します。

キューの調査

• list_queues - サイズとレイテンシーを含むすべてのキューをリストアップします。
• queue_details - 特定のキューに関する詳細情報（ジョブを含む）を取得します。
• busy_workers - 現在ビジーなワーカーとそのジョブの詳細をリストアップします。

ジョブの管理

• failed_jobs - エラー詳細を含む失敗したジョブをリストアップします。
• list_retry_jobs - リトライセット内のジョブ（失敗したがリトライされるジョブ）をリストアップします。
• list_scheduled_jobs - スケジュールセット内のジョブをリストアップします。
• dead_jobs - デッドセット内のジョブ（すべてのリトライを使い果たしたジョブ）を表示します。
• job_details - JIDによってジョブの引数、エラーメッセージ、履歴を表示します。

ジョブのアクション

• retry_job - JIDによって失敗したジョブをリトライします。
• delete_failed_job - JIDによって失敗したジョブを削除します。
• remove_job - JIDによって任意のセット（キュー/スケジュール/リトライ/デッド）からジョブを削除します。
• reschedule_job - スケジュールセット内のジョブを新しい時間に再スケジュールします。
• kill_job - リトライ/スケジュールセットからデッドセットにジョブを移動します。
• clear_queue - 特定のキューからすべてのジョブを削除します（破壊的な操作です）。

リアルタイムモニタリング

• stream_stats - リアルタイムのSidekiq統計情報のストリーミングを開始します（SSEとともに使用します）。
• process_set - すべてのSidekiqプロセス/ワーカーに関する詳細情報を取得します。

💻 使用例

基本的な使用法

設定が完了すると、以下のようなプロンプトをLLMに投げることができます。

- "Sidekiqの現在の状態はどうですか？"
- "失敗したジョブとそのエラーメッセージを表示してください。"
- "すべてのキューとその健康状態をリストアップしてください。"
- "最もエラー率の高いジョブクラスはどれですか？"
- "ジョブabc123の詳細を表示してください。"
- "JIDがabc123のジョブをリトライしてください。"
- "現在実行中のジョブはどれですか？"
- "キューがバックアップされているか、不健康なキューはありますか？"
- "現在ビジーなワーカーは何人いますか？"
- "低優先度のキューからすべてのジョブを削除してください。"
- "ジョブabc123を明日の午前9時に再スケジュールしてください。"
- "この失敗したジョブをデッドセットに移動してください。"
- "ライブステータスの更新をストリーミングし始めてください。"

📦 インストール

アプリケーションのGemfileに以下の行を追加します。

gem 'sidekiq-mcp'

そして、以下のコマンドを実行します。

bundle install

📚 ドキュメント

Railsへの統合

このgemはRailsアプリケーションと自動的に統合されます。初期化ファイルで設定を行います。

# config/initializers/sidekiq_mcp.rb
Sidekiq::Mcp.configure do |config|
  config.enabled = true
  config.path = "/sidekiq-mcp"
  config.auth_token = Rails.application.credentials.sidekiq_mcp_token
  config.sse_enabled = true # リアルタイム更新のためのServer-Sent Eventsを有効にする
end

MCPサーバーは設定されたパス（デフォルト: /sidekiq-mcp）で利用可能になります。

手動設定（非Rails）

非Railsアプリケーションの場合、Rackスタックにミドルウェアを追加します。

require 'sidekiq/mcp'

# 設定
Sidekiq::Mcp.configure do |config|
  config.auth_token = "your-secret-token"
end

# config.ruまたはミドルウェアスタックに追加
use Sidekiq::Mcp::Middleware

認証

MCPサーバーは2つの認証方法をサポートしています。

1. ベアラートークン：Authorization: Bearer your-token ヘッダーを含めます。
2. HTTP基本認証：任意のユーザー名とトークンをパスワードとして使用します。

異なるMCPクライアントの設定例を以下に示します。

Claude Desktop

claude_desktop_config.json に以下を追加します。

{
  "mcpServers": {
    "sidekiq": {
      "command": "curl",
      "args": [
        "-X", "POST",
        "-H", "Content-Type: application/json",
        "-H", "Authorization: Bearer your-secret-token",
        "http://localhost:3000/sidekiq-mcp"
      ]
    }
  }
}

Claude拡張機能付きのVS Code

VS Codeの設定で以下のように構成します。

{
  "claude.mcpServers": {
    "sidekiq": {
      "url": "http://localhost:3000/sidekiq-mcp",
      "headers": {
        "Authorization": "Bearer your-secret-token"
      }
    }
  }
}

Cursor

Cursorの設定に以下を追加します。

{
  "mcp": {
    "servers": {
      "sidekiq": {
        "command": ["curl"],
        "args": [
          "-X", "POST",
          "-H", "Content-Type: application/json", 
          "-H", "Authorization: Bearer your-secret-token",
          "http://localhost:3000/sidekiq-mcp"
        ]
      }
    }
  }
}

Claude Code

CLIを通じて設定します。

claude mcp add --transport http sidekiq-mcp-server http://localhost:3000/sidekiq-mcp

または、MCP設定に以下を追加します。

{
  "sidekiq-mcp": {
    "endpoint": "http://localhost:3000/sidekiq-mcp",
    "auth": {
      "type": "bearer",
      "token": "your-secret-token"
    }
  }
}

🔧 開発

リポジトリをチェックアウトした後、依存関係をインストールするには bin/setup を実行します。そして、テストを実行するには rake test を実行します。

example/ ディレクトリには、統合を示すサンプルのRailsアプリケーションが含まれています。

🤝 コントリビューション

バグレポートとプルリクエストは、GitHubの https://github.com/andrew/sidekiq-mcp で歓迎されます。

📄 ライセンス

このgemは、MITライセンスの条件でオープンソースとして利用可能です。