Redmine MCP Server For Cline

🚀 Redmine MCP サーバ（Cline 用）

このサーバは、Redmine と統合されたカスタム MCP (Model Context Protocol) サーバです。Cline VS Code 拡張機能を通じて、Redmine プロジェクトや問題とやり取りすることができます。

🚀 クイックスタート

この Redmine MCP サーバを使用することで、Cline を通じて Redmine とのやり取りを容易に行えます。以下の手順に従ってセットアップしましょう。

✨ 主な機能

• Redmine との統合により、Cline を通じて Redmine のプロジェクトや問題にアクセスできます。
• さまざまなリソースやツールを提供し、Redmine での操作を効率化します。

📦 インストール

前提条件

• Node.js: システムに Node.js（バージョン 18 以上）をインストールする必要があります。
• Redmine インスタンス: REST API が有効になっている稼働中の Redmine インスタンスが必要です。
• Redmine API キー: Redmine ユーザーアカウントの API キーが必要です。Redmine のアカウント設定（通常は「マイアカウント」 -> 「API アクセスキー」）で取得できます。
• Cline: Cline VS Code 拡張機能をインストールし、設定する必要があります。

インストール手順

1. リポジトリをクローンする

   git clone https://github.com/ilask/Redmine-MCP.git
   cd Redmine-MCP
   

2. 依存関係をインストールする

   npm install
   

📚 ドキュメント

設定

1. 環境変数を設定する プロジェクトのルートディレクトリに .env ファイルを作成し、以下の内容を追加します。your-redmine-host.com と your-redmine-api-key を実際の Redmine ホスト名と API キーに置き換えてください。

   REDMINE_HOST=your-redmine-host.com
   REDMINE_API_KEY=your-redmine-api-key
   

   ⚠️ 重要提示

   .env ファイルには機密情報が含まれているため、バージョン管理にコミットしないでください。このリポジトリに含まれる .gitignore ファイルにより、コミットが防止されます。

Cline への追加

1. Cline 設定を開く：VS Code で Cline 拡張機能を開き、「MCP サーバ」タブに移動します。
2. MCP 設定を編集する：「MCP 設定を編集」をクリックして cline_mcp_settings.json ファイルを開きます。
3. サーバを追加する：mcpServers オブジェクトに以下のエントリを追加し、args のパスを実際の server.js ファイルの絶対パスに置き換えてください。

   {
     "mcpServers": {
       "redmine-server": {
         "command": "node",
         "args": ["C:\\Users\\yourusername\\path\\to\\Redmine-MCP\\server.js"],
         "disabled": false,
         "autoApprove": []
       }
     }
   }
   

   ⚠️ 重要提示

   Windows ではダブルバックスラッシュ（\\）を使用するようにしてください。

4. 保存する：cline_mcp_settings.json ファイルを保存します。Cline は自動的に変更を検出し、サーバを起動します。

利用可能なリソースとツール

リソース

• redmine://projects/{project_id}：このリソースは Redmine プロジェクトを表します。{project_id} を実際の Redmine インスタンスのプロジェクト ID に置き換えてください。Cline の access_mcp_resource ツールを使用して、プロジェクトの詳細を読み取ることができます。例：

  <access_mcp_resource>
  <server_name>redmine-server</server_name>
  <uri>redmine://projects/123</uri>
  </access_mcp_resource>
  

  （123 を有効なプロジェクト ID に置き換えてください）。これにより、プロジェクトの詳細が JSON 形式で返されます。

ツール

• create_issue：このツールを使用すると、Redmine で新しい問題を作成できます。以下のパラメータを受け取ります。

  • title（必須）：問題のタイトル。
  • description（オプション）：問題の説明。
  • project_id（オプション）：プロジェクトの ID。

  例：

  POST http://localhost:3000/api/mcp
  Content-Type: application/json
  
  {
    "command": "create_issue",
    "params": {
      "title": "これはテスト問題です",
      "description": "これは問題の説明です。",
      "project_id": "123"
    }
  }
  

トラブルシューティング

• Node.js バージョンを確認する：互換性のあるバージョン（Node.js 18 以上）を使用していることを確認してください。
• ログを確認する：問題が発生した場合は、サーバのコンソール出力を確認して詳細情報を取得してください。
• Cline 設定を再読み込みする：設定を追加または変更した後は、Cline 拡張機能を再読み込みして変更を適用してください。

これで、Redmine をプロジェクトに簡単に統合し、Cline を利用して効率的な開発と管理を行うことができます。