Mcp For Redmine

MCP-For-Redmine ·

English | 한국어 | 日本語 | 简体中文

このプロジェクトは、Redmine と連携するための Model-Context-Protocol（MCP）サーバーです。MCP 対応クライアントを使うと、Redmine のプロジェクト、チケット、ユーザー、作業時間を簡単に管理できます。

現在、標準入力／出力（stdio）トランスポートのみをサポートしています。

要件

• Node.js 18 以上
• Redmine API キー（Redmine アカウントの個人用 API キー）

互換性の基準：Redmine 6.0.6

はじめに

各環境で MCP サーバーを設定する方法：

{
  "mcpServers": {
    "mcp-for-redmine": {
      "command": "npx",
      "args": ["-y", "@chspower1/mcp-for-redmine@latest"],
      "env": {
        "REDMINE_BASE_URL": "https://your.redmine.tld",
        "REDMINE_API_KEY": "your_api_key_here"
      }
    }
  }
}

{
  "mcpServers": {
    "mcp-for-redmine": {
      "command": "npx",
      "args": ["-y", "@chspower1/mcp-for-redmine@latest"],
      "env": {
        "REDMINE_BASE_URL": "https://your.redmine.tld",
        "REDMINE_API_KEY": "your_api_key_here"
      }
    }
  }
}

# Set environment variables
export REDMINE_BASE_URL=https://your.redmine.tld
export REDMINE_API_KEY=your_api_key_here

# Add MCP server
claude mcp add mcp-for-redmine -- npx -y @chspower1/mcp-for-redmine@latest

{
  "mcpServers": {
    "mcp-for-redmine": {
      "command": "npx",
      "args": ["-y", "@chspower1/mcp-for-redmine@latest"],
      "env": {
        "REDMINE_BASE_URL": "https://your.redmine.tld",
        "REDMINE_API_KEY": "your_api_key_here"
      }
    }
  }
}

{
  "mcpServers": {
    "mcp-for-redmine": {
      "command": "npx",
      "args": ["-y", "@chspower1/mcp-for-redmine@latest"],
      "env": {
        "REDMINE_BASE_URL": "https://your.redmine.tld",
        "REDMINE_API_KEY": "your_api_key_here"
      }
    }
  }
}

[[mcp_servers]]
name = "mcp-for-redmine"
command = "npx"
args = ["-y", "@chspower1/mcp-for-redmine@latest"]

[mcp_servers.env]
REDMINE_BASE_URL = "https://your.redmine.tld"
REDMINE_API_KEY = "your_api_key_here"

設定オプション

サーバーは次の優先順位で設定を読み込みます：

警告

> セキュリティに関する警告：TLS 検証（REDMINE_TLS_VERIFY=false または --no-tls-verify）を無効にすると、接続が中間者（MitM）攻撃に対して脆弱になります。このオプションは、信頼できる環境（例：自己署名証明書を使用する内部ネットワーク）でのみ使用してください。インターネット経由で公開 Redmine インスタンスに接続する際は、絶対に使用しないでください。

主な機能

現在利用可能なツール：

安定版 API

• ユーザー：users_create、users_get、users_current、users_list、users_update、users_delete
• プロジェクト：projects_list、projects_get、projects_create、projects_update、projects_archive、projects_unarchive、projects_delete
• 課題：issues_list、issues_get、issues_create、issues_update、issues_delete
• 時間記録：time_entries_list、time_entries_get、time_entries_create、time_entries_update、time_entries_delete

アルファ版 API

• 列挙型：enumerations_issue_priorities_list、enumerations_time_entry_activities_list
• メンバーシップ：memberships_list_project_memberships、memberships_get、memberships_create、memberships_update、memberships_delete
• 課題の関連：issue_relations_list、issue_relations_get、issue_relations_create、issue_relations_delete
• バージョン：versions_list、versions_get、versions_create、versions_update、versions_delete
• Wiki ページ：wiki_pages_list、wiki_pages_get、wiki_pages_create_or_update、wiki_pages_delete
• クエリ：queries_list
• ファイル：files_list
• 添付ファイル：attachments_get、attachments_delete、attachments_upload
• 課題のステータス：issue_statuses_list
• トラッカー：trackers_list
• ロール：roles_list、roles_get
• グループ：groups_list、groups_get、groups_create、groups_update、groups_delete、groups_add_user、groups_remove_user
• カスタムフィールド：custom_fields_list
• 課題カテゴリ：issue_categories_list、issue_categories_get、issue_categories_create、issue_categories_update、issue_categories_delete
• マイアカウント：my_account_get
• 検索：search

各ツールの入力スキーマは src/schema/*.schema.ts で定義されています。結果は JSON 形式のテキストで返されます。

共通の入力ルール（開発用）

• コレクションのページネーション：ほとんどの一覧表示ツールで offset と limit がサポートされています（デフォルトは 25、最大は 100）。
• 関連項目の展開：一部の get／list ツールでは include がサポートされています（例：課題の場合は children,attachments,journals,...）。
• 添付ファイルのアップロードトークン：attachments_upload は Base64 ファイルを /uploads.json に送信し、トークンを返します。このトークンを issues_create/update または wiki_pages_create_or_update の uploads フィールドで使用すると、添付ファイルを関連付けられます。
• ツール固有の追加項目／制約：課題の custom_fields、watcher_user_ids など、詳細な制約については、各ツールのスキーマ src/schema/*.schema.ts を参照してください。

トラブルシューティングガイド

• 設定エラー
  • メッセージの例：❌ Redmine URL is required! または ❌ Redmine API key is required!
  • 解決方法：エラーメッセージに示されている設定方法を選択してください。セキュリティ上、環境変数の使用を推奨します。
• Node.js／ESM 関連のエラー
  • Node.js 18 以降を使用していることを確認してください。
• 認証エラーおよびネットワークエラー（401、403 など）
  • API キーの権限と URL を確認し、ネットワークに問題がないか確認してください。
• Windows での実行に関する問題
  • ガイドに示されているように、cmd /c npx ... で実行してみてください。

セキュリティと権限

• API キーは機密情報です。Git のコミット、ログ、共有リポジトリに含めないでください。
• プロジェクトや課題の削除など、取り消せない操作を行う場合は、権限を再確認し、慎重に実行してください。

ロードマップ

ベータエンドポイント（添付ファイルのアップロードフローなど）の対応範囲を拡大し、SSE（Server-Sent Events）を追加するとともに、サンプルやテストを拡充する予定です。

ライセンス

MIT