redmine-mcp-server

REDMINE_AUTOFILL_REQUIRED_CUSTOM_FIELDS=true の場合、create_redmine_issue は、関連するカスタムフィールドの検証エラー（例：<Field Name> cannot be blank や <Field Name> is not included in the list）が発生すると、1 回再試行し、次の値のみを入力します。

• Redmine のカスタムフィールドの default_value、または
• REDMINE_REQUIRED_CUSTOM_FIELD_DEFAULTS

実際には、2 つ目の方法のみが有効です。サーバーは GET /projects/{id}.json?include=issue_custom_fields からプロジェクトのカスタムフィールドを読み込みますが、Redmine はこれを ID と名前のみで表示するため、default_value を取得できません。詳しくは、list_project_issue_custom_fields を参照してください。自動入力で使用する値を設定するには、環境変数のマップを設定してください。

例：

REDMINE_AUTOFILL_REQUIRED_CUSTOM_FIELDS=true
REDMINE_REQUIRED_CUSTOM_FIELD_DEFAULTS='{"Required Field A":"Value A","Required Field B":"Value B"}'

Redmine サーバーが自己署名証明書または内部 CA を使用している場合：

# In .env file
REDMINE_URL=https://redmine.company.com
REDMINE_API_KEY=your_api_key
REDMINE_SSL_CERT=/path/to/ca-certificate.crt

対応する証明書形式：.pem、.crt、.cer

クライアント証明書による認証が必要な環境の場合：

# In .env file
REDMINE_URL=https://secure.redmine.com
REDMINE_API_KEY=your_api_key
REDMINE_SSL_CERT=/path/to/ca-bundle.pem
REDMINE_SSL_CLIENT_CERT=/path/to/cert.pem,/path/to/key.pem

注記：秘密鍵は暗号化されていない必要があります（Python の requests ライブラリの要件）。

⚠️ 警告：開発／テスト環境でのみ使用してください！

# In .env file
REDMINE_SSL_VERIFY=false

SSL 検証を無効にすると、中間者攻撃に対して接続が脆弱になります。

各 MCP リクエストには個別の Authorization: Bearer <token> が含まれるため、各ユーザーは自身の Redmine アカウントで認証されます。サーバーはリクエストを転送する前に、Doorkeeper のイントロスペクションエンドポイントで各トークンを検証し、クライアントが必要とする OAuth2 ディスカバリーエンドポイントと /revoke エンドポイントを公開します。

REDMINE_AUTH_MODE=oauth
REDMINE_URL=https://redmine.example.com
REDMINE_MCP_BASE_URL=https://redmine-mcp.example.com   # public URL of this server

# Confidential OAuth app registered in Redmine admin (see setup guide)
REDMINE_INTROSPECT_CLIENT_ID=...
REDMINE_INTROSPECT_CLIENT_SECRET=...

OAuth アプリは Redmine の管理画面 → アプリケーション で手動登録します（Dynamic Client Registration はありません）。手順の詳細、エンドポイントのリファレンス、トラブルシューティングについては、OAuth2 セットアップガイドをご覧ください。

FastMCP が MCP 側の認可サーバーとして機能し、MCP クライアントの DCR を処理した後、同意を得るために上流の OAuth プロバイダーである Redmine にユーザーをリダイレクトします。クライアント（例：Claude Desktop、VS Code）自身での登録が想定されている場合に使用します。

REDMINE_AUTH_MODE=oauth-proxy
REDMINE_URL=https://redmine.example.com
REDMINE_MCP_BASE_URL=https://redmine-mcp.example.com   # public URL of this server

# Confidential OAuth app registered in Redmine admin (see setup guide)
REDMINE_INTROSPECT_CLIENT_ID=...
REDMINE_INTROSPECT_CLIENT_SECRET=...
REDMINE_MCP_JWT_SIGNING_KEY=...

上流の Redmine アプリでは、${REDMINE_MCP_BASE_URL}/auth/callback をリダイレクト URI として登録する必要があります。ストレージ、スケーリング、認証情報の再利用に関する注意事項は、OAuth2 セットアップガイドをご覧ください。

サーバー自身が OAuth 認可サーバーとして機能するため、MCP クライアントはサーバーの URL だけで接続できます。初回利用時にクライアントがブラウザーを開き、ユーザーがこのサーバーの提供するページに個人用の Redmine API キーを貼り付けます。それ以降のすべてのツール呼び出しは、そのユーザーとして実行されます。クライアント設定にキーを記載する必要はなく、パスワードを求められることもありません。

REDMINE_AUTH_MODE=api-key-login
REDMINE_URL=https://redmine.example.com
REDMINE_MCP_BASE_URL=https://redmine-mcp.example.com   # public https URL of this server
REDMINE_MCP_JWT_SIGNING_KEY=...                        # encrypts the stored keys

サーバーは各ユーザーのキーを FASTMCP_HOME/api-key-login/ 以下に暗号化して保存するため、このディレクトリには永続ボリュームが必要であり、このモードは単一レプリカで実行します。ここでの OAuth スコープは、クライアントが要求する範囲を狭めるものであり、Redmine の権限を表すものではありません。権限の境界となるのは、引き続き Redmine 自身の権限です。有効化する前に、セキュリティモデル、セッションルール、クライアントの設定について、api-key-login ガイドをご覧ください。

OAuth に対応するには古すぎる Redmine インスタンスでは、各ユーザーの MCP クライアントが、X-Redmine-API-Key ヘッダーで各自の Redmine API キーを送信します。各リクエストは、そのユーザーの権限に基づき、そのユーザーとして実行されます。

これは高度な設定が必要なオプトインモードです。 エンドツーエンドの TLS と、正しく設定されたリバースプロキシが必要です。有効化する前に、脅威モデル、ファイアウォールのガイダンス、キー失効時の手順について、docs/legacy-per-user-auth.mdをご覧ください。

mcp-remote（推奨）：

{ "mcpServers": { "redmine": {
  "command": "npx",
  "args": ["mcp-remote", "https://your-host/mcp",
           "--header", "X-Redmine-API-Key:${RM_KEY}"],
  "env": { "RM_KEY": "<your redmine api key>" }
}}}

X-Redmine-API-Key:${RM_KEY} では、コロンの前後にスペースがない点に注意してください。これにより、Windows 上の Cursor と Claude Desktop で発生する引数のエスケープに関するバグを回避できます。

VS Code（mcp.json）：

.vscode/mcp.json（ワークスペースファイル）またはユーザープロファイルの mcp.json を使用してください。ワークスペースの .mcp.json は headers を黙って破棄するため（microsoft/vscode#319528）、使用しないでください。VS Code 1.102 以降を指定してください。

{
  "servers": {
    "redmine": {
      "type": "http",
      "url": "https://your-host/mcp",
      "headers": { "X-Redmine-API-Key": "${input:rmKey}" },
      "inputs": [{ "id": "rmKey", "type": "promptString",
                   "description": "Redmine API key", "password": true }]
    }
  }
}

非対応： カスタムリクエストヘッダーを設定できないクライアント、または独自の OAuth フロー用に Authorization ヘッダーを確保しているクライアント。

VS Code は GitHub Copilot を通じて MCP を標準でサポートしています（VS Code 1.102 以降が必要です）。

CLI を使用する（最速）：

code --add-mcp '{"name":"redmine","type":"http","url":"http://127.0.0.1:8000/mcp"}'

コマンドパレットを使用する：

1. コマンドパレット（Cmd/Ctrl+Shift+P）を開きます
2. MCP: Open User Configuration（グローバル設定の場合）または MCP: Open Workspace Folder Configuration（プロジェクト固有の設定の場合）を実行します
3. 設定を追加します：

   {
     "servers": {
       "redmine": {
         "type": "http",
         "url": "http://127.0.0.1:8000/mcp"
       }
     }
   }
   

4. ファイルを保存します。VS Code が MCP サーバーを自動的に読み込みます。

手動で設定する： ワークスペースに .vscode/mcp.json（またはユーザープロファイルディレクトリに mcp.json）を作成します：

{
  "servers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

CLI コマンドを使用して Claude Code に追加します：

claude mcp add --transport http redmine http://127.0.0.1:8000/mcp

または、Claude Code の設定ファイル（~/.claude.json）で手動設定します：

{
  "mcpServers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

Claude Desktop の設定ファイルがサポートするのは stdio トランスポートのみです。uv 経由で FastMCP のプロキシを使用し、この HTTP サーバーに接続します。

セットアップ：

1. Claude Desktop を開きます
2. Claude メニュー（macOS のメニューバー／Windows のタイトルバー）> Settings... をクリックします
3. Developer タブ > Edit Config をクリックします
4. 次の設定を追加します：

{
  "mcpServers": {
    "redmine": {
      "command": "uv",
      "args": [
        "run",
        "--with", "fastmcp",
        "fastmcp",
        "run",
        "http://127.0.0.1:8000/mcp"
      ]
    }
  }
}

5. ファイルを保存し、Claude Desktop を完全に終了してから再起動します
6. 入力エリアにツールアイコンが表示されていることを確認し、接続を確かめます

設定ファイルの場所：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

注： Claude Desktop を起動する前に、Redmine MCP サーバーが実行されている必要があります。

Cursor はブリッジなしで HTTP MCP サーバーに直接接続します。

1. ~/.cursor/mcp.json（すべてのプロジェクトで有効）またはプロジェクトのルートに .cursor/mcp.json（そのプロジェクトのみで有効）を作成します：

   {
     "mcpServers": {
       "redmine": {
         "url": "http://127.0.0.1:8000/mcp"
       }
     }
   }
   

2. ファイルを保存します。Cursor はサーバーを自動的に認識します。MCP 設定にはサーバーと読み込まれたツールが表示されます。

注： Cursor は url のみでリモートサーバーを識別し、上記の VS Code や Claude Code の設定とは異なり、type フィールドはありません。

legacy-per-user モードの場合、API キーヘッダーを追加します：

{
  "mcpServers": {
    "redmine": {
      "url": "https://your-host/mcp",
      "headers": { "X-Redmine-API-Key": "<your redmine api key>" }
    }
  }
}

oauth モードの場合、MCP サーバーで REDMINE_OAUTH_DISCOVERY_AS=self を設定します。Cursor は正規の well-known URL で認可サーバーのメタデータを探します。デフォルトの（redmine）ディスカバリープロファイルではそこにメタデータが提供されないため、この設定がないとフローが停止します（#188）。Cursor と self-AS ディスカバリーをご覧ください。

コマンドを使用して Codex CLI に追加します：

codex mcp add redmine -- npx -y mcp-client-http http://127.0.0.1:8000/mcp

または、~/.codex/config.toml で手動設定します：

[mcp_servers.redmine]
command = "npx"
args = ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]

注： Codex CLI が主にサポートするのは stdio ベースの MCP サーバーです。上記では、HTTP トランスポートへのブリッジとして mcp-client-http を使用しています。

Kiro が主にサポートするのは stdio ベースの MCP サーバーです。HTTP サーバーには、HTTP から stdio へのブリッジを使用します：

1. ワークスペースの .kiro/settings/mcp.json を作成または編集します：

   {
     "mcpServers": {
       "redmine": {
         "command": "npx",
         "args": [
           "-y",
           "mcp-client-http",
           "http://127.0.0.1:8000/mcp"
         ],
         "disabled": false
       }
     }
   }
   

2. ファイルを保存し、Kiro を再起動します。Redmine ツールが MCP パネルに表示されます。

注： Kiro の HTTP トランスポートの直接サポートは限定的です。上記の設定では、HTTP MCP サーバーへの接続にブリッジとして mcp-client-http を使用しています。

ほとんどの MCP クライアントは標準的な設定形式を使用します。HTTP サーバーの場合：

{
  "mcpServers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

HTTP ブリッジを使ったコマンドベースの方法が必要なクライアントの場合：

{
  "mcpServers": {
    "redmine": {
      "command": "npx",
      "args": ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]
    }
  }
}

コアツール（53 個、常に利用可能）

これらのツールを使用するには、Redmine インスタンスと認証情報のみが必要です。追加のプラグインや機能フラグは必要ありません。

• プロジェクト管理（10 個）

  • list_redmine_projects - アクセス可能なプロジェクトを一覧表示します（filters で追加の指定がない限り、アクティブなプロジェクトのみ）。サーバー側で絞り込み、必要に応じてページ分割します
  • list_project_issue_custom_fields - プロジェクトに設定されているチケットのカスタムフィールドを一覧表示します
  • list_redmine_versions - プロジェクトのバージョン／マイルストーンを一覧表示します
  • manage_redmine_version - バージョン／マイルストーンを作成、更新、または削除します
  • manage_redmine_project - プロジェクトを作成し、設定を編集するか、プロジェクトをクローズまたは再開します
  • list_project_members - プロジェクトのメンバーとロールを一覧表示します
  • summarize_project_status - プロジェクトの包括的なステータス概要を取得します
  • list_redmine_roles - Redmine インスタンスで定義されているすべてのロールを一覧表示します（有効な role_ids の確認に使用）
  • get_project_modules - プロジェクトで有効になっているモジュールを取得します
  • manage_project_member - プロジェクトのメンバーシップを追加、更新、または削除します

• チケット操作（13 ツール）

  • get_redmine_issue - チケットの詳細情報を取得します（ジャーナルのページネーション、ウォッチャー、関連、子チケットに対応）
  • list_redmine_issues - 柔軟な条件（プロジェクト、ステータス、担当者など）でチケットを一覧表示します
  • search_redmine_issues - テキストクエリでチケットを検索します
  • create_redmine_issue - 新しいチケットを作成します。uploads パラメーターを使ってファイルを添付することもできます
  • update_redmine_issue - 既存のチケットを更新します。uploads パラメーターを使ってファイルを添付することもできます（ジャーナルの注記にファイルを添付するには notes と併用します）
  • delete_redmine_issue - 必須の確認フラグと、取り消し不能な削除の前にカスケード影響をプレビューしたうえで、チケットを完全に削除します。
  • copy_issue - 既存のチケットを複製します。フィールドを任意で上書きできます
  • list_subtasks - 指定した親チケットのサブタスク（子チケット）を一覧表示します
  • get_private_notes - チケットの非公開の注記を取得します
  • manage_issue_relation - チケットの関連を一覧表示、作成、または削除します
  • manage_issue_watcher - チケットのウォッチャーを追加または削除します
  • manage_issue_note - ジャーナルの注記のテキストを編集するか、非公開設定を切り替えます
  • manage_issue_category - チケットカテゴリを一覧表示、作成、更新、または削除します
  • 注：get_redmine_issue では custom_fields を含めることができ、update_redmine_issue では名前を指定してカスタムフィールドを更新できます（例：{"size": "S"}）。

• 時間管理（4 ツール）

  • list_time_entries - プロジェクト、チケット、ユーザー、期間で絞り込んで時間エントリーを一覧表示します
  • manage_time_entry - 時間エントリーを作成または更新します（別のユーザーに代わって記録するには user_id を使用します）
  • list_time_entry_activities - 時間エントリーで使用できる作業分類を確認します
  • import_time_entries - 順次 API 呼び出しで時間エントリーを一括インポートし、各エントリーのエラーを報告します

• 検出／列挙（7 ツール）：作成／更新ツールを呼び出す前に、LLM が有効な ID を見つけるのに役立ちます

  • list_redmine_trackers - すべてのトラッカー（バグ、機能、サポートなど）を一覧表示します
  • list_project_trackers - 特定のプロジェクトで有効なトラッカーを一覧表示します
  • list_redmine_issue_statuses - すべてのチケットステータスとその is_closed フラグを一覧表示します
  • list_redmine_issue_priorities - すべての優先度を一覧表示します
  • list_redmine_users - ユーザーを絞り込み／一覧表示します（管理者のみ。名前とグループによる絞り込みに対応）
  • get_current_user - 認証済みユーザーのプロフィールを取得します（管理者以外も利用可能）
  • list_redmine_queries - 保存済みのカスタムクエリを一覧表示します（読み取り専用）

• 検索と Wiki（2 ツール）

  • search_entire_redmine - チケットと Wiki ページを対象に全体検索します（Redmine 3.3.0+）
  • manage_redmine_wiki_page - Wiki ページの一覧表示、取得、作成、更新、削除、または名前変更を行います

• ニュース（4 ツール）：プロジェクトのお知らせ — リリースノート、メンテナンス時間

  • list_redmine_news - ニュースの一覧を取得します。特定のプロジェクトに限定することもできます
  • get_redmine_news - コメントと添付ファイルを含むニュース項目を1件読み込みます
  • manage_redmine_news - ニュース項目を作成または更新します（Redmine 4.1+）
  • delete_redmine_news - 確認のうえ、ニュース項目を削除します（Redmine 4.1+）

• ファイル操作（5 ツール）

  • list_files - プロジェクトの「ファイル」セクションにアップロードされたファイルの一覧を取得します
  • create_upload_ticket - アップロード枠を予約し、1回限りの URL を返します。これにより、呼び出し元のマシン上のファイルを、モデルを経由してバイト列を送信することなくサーバーに届けられます
  • upload_file - 新しいファイルをプロジェクトにアップロードします（ステージング済みの upload_id、URL、base64 コンテンツ、またはサーバー側の file_path を使用）。バージョンに関連付けることもできます
  • delete_file - プロジェクトからファイルを削除します
  • get_redmine_attachment - 添付ファイルをダウンロードします（HTTP モードと stdio モードの両方で動作します）

• ガントチャート（1 ツール）

  • get_gantt_chart - 日付、依存関係、マイルストーンを含む、プロジェクトのタイムラインデータを取得します

• インタラクティブアプリ（4 ツール）：MCP Apps 拡張機能を介してチャット内にライブ UI を表示します（対応クライアントが必要です）

  • show_triage_board - プロジェクトのチケットをステータス別にまとめたインタラクティブなカンバンボードとして表示します。ドラッグ操作によるステータス変更を反映します
  • get_triage_board_data - ボードの「更新」アクションで使用するデータソースです
  • show_project_dashboard - 未完了／完了、期限超過、今週が期限、優先度別の未完了件数、最近のアクティビティを含む、プロジェクトの最新スナップショットをインタラクティブなダッシュボードとして表示します。一致するチケット一覧へのドリルダウンもできます
  • get_project_dashboard_data - ダッシュボードの「更新」アクションで使用するアプリ専用データソースです
  • show_project_timeline - バージョンごとのチケットバー、マイルストーンのダイヤモンド、今日を示す線を含む、プロジェクトのスケジュールをインタラクティブなタイムラインとして表示します
  • get_project_timeline_data - タイムラインの「更新」アクションで使用するアプリ専用データソースです

• メタ（1 ツール）

  • get_mcp_server_info - サーバーのバージョン、認証モード、読み取り専用状態、認証済みユーザー（current_user）、およびプラグインが有効化の条件となるツール群のうち有効なものを報告します。最近リリースされた修正に依存する前にデプロイの遅延を検出したり、assigned_to_id="me" が誰に解決されるかを確認したりするのに使います。

プラグインが有効化の条件となるツール（15、環境変数でオプトイン）

これらのツールを使うには、対応する Redmine プラグインがサーバーにインストールされており、かつ MCP サーバーで対応する環境変数が true に設定されている必要があります。フラグが設定されている場合にのみ tools/list に表示されます。フラグがオフの場合、MCP のインターフェースには登録されず、直接呼び出しても機能が無効であることを示すエラーが返されます。

• チェックリスト（3 ツール）：REDMINE_CHECKLISTS_ENABLED=true を設定します。RedmineUP Checklists Pro プラグインが必要です。

  • get_checklist - チケットのすべてのチェックリスト項目を取得します
  • create_checklist_item - チケットに新しいチェックリスト項目を追加します
  • update_checklist_item - チェックリスト項目のテキスト、完了状態、または位置を更新します

• 製品（1 ツール）：REDMINE_PRODUCTS_ENABLED=true を設定します。RedmineUP Products プラグインが必要です。

  • manage_product - 製品の一覧表示、取得、作成、または更新を行います

• 連絡先（CRM）（2 ツール）：REDMINE_CRM_ENABLED=true を設定します。RedmineUP CRM プラグインが必要です。OAuth モードでは、このフラグによって公開されるスコープに CRM の権限も追加されるため、OAuth アプリケーションでそれらの権限を付与し、ユーザーに再度同意してもらってください。Pro インストールで REDMINE_CRM_EDITION=pro を設定すると、Light ビルドでは登録されない連絡先の list フィルターを使用できます。

  • manage_contact - 連絡先の一覧表示、取得、作成、更新、削除、またはプロジェクトとの関連付けの設定・解除を行います
  • list_contact_tags - 連絡先で使用されているタグを色とともに取得します。tags フィルターと tag_list で使用します

• 案件（CRM）（3 ツール）：REDMINE_DEALS_ENABLED=true を設定します。同じ CRM プラグインの Pro エディションと、プロジェクトで有効になっている deals プロジェクトモジュールが必要です。Light エディションでは案件の権限が定義されていないため、Light のデプロイ環境で同意に問題が発生しないよう、案件には独自のフラグがあります。

  • manage_deal - 案件の一覧表示、取得、作成、更新、または削除を行います
  • list_deal_statuses - 案件のステータス（プラグイン側では管理者専用）と、案件作成前に使用するプロジェクトの案件カテゴリを取得します
  • manage_deal_category - プロジェクトの案件カテゴリの一覧表示、作成、名前変更、または削除を行います

• CRM のメモと保存済みクエリ（共有 2 ツール）：REDMINE_CRM_ENABLED または REDMINE_DEALS_ENABLED のいずれかを設定すると利用できます。各呼び出しは、メモまたはクエリのソースに対応するフラグによって制御されます。

  • manage_crm_note - 連絡先と案件の CRM メモを取得、作成、更新、または削除します
  • list_crm_queries - 保存済みの連絡先または案件のクエリを取得します

• 案件の商品明細（1 ツール）：REDMINE_DEALS_ENABLED=true と REDMINE_PRODUCTS_ENABLED=true の両方が必要です。このエンドポイントは、Products プラグインが CRM と併せてインストールされている場合にのみ存在します。

  • add_deal_product - カタログ商品または自由入力の商品明細を案件に追加します

• ドキュメント（DMSF）（1 ツール）：REDMINE_DMSF_ENABLED=true を設定します。redmine_dmsf プラグインが必要です。

  • manage_document - DMSF ドキュメントの一覧表示、取得、作成（アップロード）、または更新（新しいリビジョンの作成）を行います

• ヘルプデスク（1 ツール）：REDMINE_HELPDESK_ENABLED=true を設定します。RedmineUP Helpdesk プラグインが必要です。

  • send_helpdesk_email_reply - ヘルプデスクチケットの顧客にメールで返信します。必要に応じてチケットのステータスも変更できます

• ヘルプデスクチケット（1 ツール）：REDMINE_HELPDESK_TICKETS_ENABLED=true を設定します。RedmineUP Helpdesk プラグインと RedmineUP CRM プラグインが必要です。

  • manage_helpdesk_ticket - チケットのヘルプデスクデータを読み取るか、別の既存の連絡先に移動します

オペレーターツール（1件、管理者限定）

デフォルトでは tools/list に表示されません。MCP サーフェスに登録するには、REDMINE_MCP_EXPOSE_ADMIN_TOOLS=true を設定してください。このフラグにかかわらず、基盤となるバックグラウンドタスクは実行されます。これらを公開すると、MCP 経由で実行する選択肢が追加されます。

• cleanup_attachment_files - 期限切れの添付ファイルを手動でクリーンアップします（バックグラウンドのクリーンアップタスクは、設定にかかわらず自動的に実行されます）