Sidekiq MCP

🚀 Sidekiq MCP

Sidekiq MCP 是一款 Sidekiq 插件，它提供了一個 MCP（模型上下文協議）服務器，使大語言模型（LLMs）能夠通過標準化接口與 Sidekiq 隊列、統計信息和失敗任務進行交互，為任務管理和監控提供了便捷的途徑。

🚀 快速開始

安裝

將以下代碼添加到你的應用程序的 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 # 啟用服務器發送事件以實現即時更新
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 服務器支持兩種身份驗證方法：

1. Bearer Token：在請求頭中包含 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

通過命令行界面進行配置：

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"
    }
  }
}

✨ 主要特性

可用工具

MCP 服務器提供了以下工具：

統計與監控

• 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 - 按任務 ID（JID）顯示任務的參數、錯誤消息和歷史記錄。

任務操作

• retry_job - 按任務 ID（JID）重試失敗的任務。
• delete_failed_job - 按任務 ID（JID）刪除失敗的任務。
• remove_job - 按任務 ID（JID）從任何集合（隊列/調度/重試/死亡）中移除任務。
• reschedule_job - 將調度集中的任務重新安排到新的時間。
• kill_job - 將任務從重試/調度集移動到死亡集。
• clear_queue - 清除特定隊列中的所有任務（破壞性操作）。

即時監控

• stream_stats - 開始流式傳輸即時 Sidekiq 統計信息（與服務器發送事件一起使用）。
• process_set - 獲取所有 Sidekiq 進程/工作進程的詳細信息。

示例提示

配置完成後，你可以向大語言模型提問：

• "Sidekiq 的當前狀態如何？"
• "顯示失敗的任務及其錯誤消息。"
• "列出所有隊列及其健康狀態。"
• "哪些任務類的錯誤率最高？"
• "顯示任務 abc123 的詳細信息。"
• "重試 JID 為 abc123 的任務。"
• "當前正在運行哪些任務？"
• "是否有隊列積壓或不健康？"
• "目前有多少工作進程忙碌？"
• "清除 'low_priority' 隊列中的所有任務。"
• "將任務 abc123 重新安排到明天上午 9 點運行。"
• "將這個失敗的任務移動到死亡集。"
• "開始流式傳輸即時統計更新。"

🛠️ 開發

檢出倉庫後，運行 bin/setup 安裝依賴項。然後，運行 rake test 運行測試。example/ 目錄包含一個示例 Rails 應用程序，展示了集成方法。

🤝 貢獻

歡迎在 GitHub（https://github.com/andrew/sidekiq-mcp）上提交錯誤報告和拉取請求。

📄 許可證

該 gem 以開源形式提供，遵循 MIT 許可證。