rework-mcp-server

Rework MCP サーバー

Rework プラットフォームと AI アプリケーションを連携するための Model Context Protocol（MCP）サーバーです。このサーバーを使用すると、AI エージェントが標準化されたプロトコルを介して、Rework のプロジェクト、タスク、ワークフロー、ジョブを操作できます。

🚀 ステータスの更新： プロジェクト管理とワークフローを完全にサポートする v0.7.2 が利用可能になりました。

セットアップ

1. Rework の認証情報を取得します。
   • Rework プラットフォームの設定から API キーを取得します
   • Rework アカウントからワークスペース情報を取得します
2. 認証情報を使って MCP サーバーを設定します
3. 自然言語を使ってプロジェクトやワークフローを管理します！

インストール

クライアントの MCP 設定 JSON ファイルに次のエントリを追加します。

{
  "mcpServers": {
    "Rework": {
      "command": "node",
      "args": [
        "index.js"
      ],
      "env": {
        "REWORK_API_KEY": "your-api-key",
        "REWORK_WORKSPACE_ID": "your-workspace-id"
      }
    }
  }
}

または、Node を使ってサーバーを直接実行できます。

node index.js --env REWORK_API_KEY=your-api-key --env REWORK_WORKSPACE_ID=your-workspace-id

DISABLED_TOOLS 環境変数を使って、特定のツールを無効にできます。無効にするツール名をカンマ区切りで指定してください（例：create_task,get_tasks）。

ツールの数やコンテキストの制限に関する問題が発生した場合は、不要なツールを無効にしてください。

SSE サポートを有効にして実行

次の環境変数を設定すると、サーバーを SSE（Server-Sent Events）モードで実行できます。

{
  "mcpServers": {
    "Rework": {
      "command": "node",
      "args": [
        "index.js"
      ],
      "env": {
        "REWORK_API_KEY": "your-api-key",
        "REWORK_WORKSPACE_ID": "your-workspace-id",
        "ENABLE_SSE": "true",
        "PORT": "8000"  // Optional, defaults to 3000
      }
    }
  }
}

または、コマンドラインから実行できます。

node index.js --env REWORK_API_KEY=your-api-key --env REWORK_WORKSPACE_ID=your-workspace-id --env ENABLE_SSE=true --env PORT=8000

Docker でのデプロイ

version: '3.8'

services:
  rework-mcp-server:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - '3000:8000'
    environment:
      - REWORK_API_KEY=${REWORK_API_KEY}
      - REWORK_WORKSPACE_ID=${REWORK_WORKSPACE_ID}
      - ENABLE_SSE=true
      - LOG_LEVEL=info
    volumes:
      - ./src:/app/src
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 5s

機能

📝 プロジェクト管理	🔄 ワークフロー管理
• タスクの作成と管理 • タスクの詳細表示 • プロジェクト内のタスク一覧表示 • タスクへのコメント追加 • プロジェクト内のタスク整理 • タスクのステータスと進捗の表示	• ジョブの作成と管理 • ジョブのステータス追跡 • ジョブの詳細表示 • ワークフロー別のジョブ一覧表示 • ワークフローの整理 • ジョブとワークフローのリンク

👥 ユーザー管理	⚡ 連携機能
• 名前またはメールアドレスによるユーザー検索 • 利用可能な全ユーザーの一覧表示 • タスクへのユーザー割り当て • ユーザー情報の表示 • ユーザー認証 • ユーザー権限の管理	• ID と名前による検索 • Markdown コンテンツのサポート • エラー処理を標準搭載 • API レート制限 • 入力値の検証 • 包括的な API 対応

利用可能なツール

ツール	説明	必須パラメーター
プロジェクト管理
create_task	プロジェクト内にタスクを作成します	name、board_id、creator_username
get_tasks	ボードのタスクを取得します	board_id と任意のフィルター
get_detail_task	タスクの詳細情報を取得します	id
get_projects	すべてのプロジェクトとボードを取得します	任意の検索クエリ q
ワークフロー管理
create_job	ワークフロー内にジョブを作成します	name、workflow_id、creator_username
get_jobs	ワークフローのジョブを取得します	workflow_id と任意のフィルター
get_detail_job	ジョブの詳細情報を取得します	id
get_workflows	利用可能なすべてのワークフローを取得します	任意の検索クエリ q
ユーザー管理
find_users	名前またはメールアドレスでユーザーを検索します	q（検索クエリ）、properties
list_all_users	ワークスペースのメンバー全員を取得します	なし

任意のパラメーターや高度な使用方法については、プロジェクトのドキュメントを参照してください。

ユーザー管理

タスクやジョブを作成するときは、user_id パラメーターを使用してユーザーを割り当てることができます。また、タスクやジョブを作成したユーザーを示すために、creator_username も指定する必要があります。

{
  "name": "🚀 New Feature Implementation",
  "board_id": "board_123",
  "content": "Implement the new feature described in the spec",
  "creator_username": "jane.doe",
  "user_id": "user_456"
}

ユーザー管理ツールを使用すると、名前やメールアドレスでユーザーを検索し、タスクの割り当てに必要な ID を取得できます。

エラー処理

Rework MCP サーバーでは、次の内容について明確なエラーメッセージが表示されます。

• 必須パラメーターの不足
• 無効な ID または参照
• リソースが見つからない
• 認証の失敗
• 権限の問題
• API エラー
• レート制限

サーバーログの詳細度は、LOG_LEVEL 環境変数で指定できます。有効な値は trace、debug、info、warn、error（デフォルト）です。 コマンドラインで --env LOG_LEVEL=info と指定することもできます。

カスタムフィールドのサポート

タスクとジョブの作成では、どちらも custom_fields パラメーターを使用してカスタムフィールドを設定できます。このパラメーターには、id と value プロパティを含むオブジェクトの配列を指定します。

{
  "custom_fields": [
    {
      "id": "custom_field_123",
      "value": "High Priority"
    },
    {
      "id": "custom_field_456",
      "value": true
    }
  ]
}

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細については、LICENSE ファイルをご覧ください。

免責事項

このソフトウェアは Rework API を使用しています。すべての商標およびブランド名は、それぞれの所有者に帰属します。このプロジェクトは Rework とは公式に提携しておらず、Rework による承認も受けていません。