Redmine

🚀 Redmine MCP サーバー for Cline

このサーバーは、カスタムの MCP（モデルコンテキストプロトコル）サーバーで、Redmine と統合されています。Cline VS Code 拡張機能を通じて、Redmine プロジェクトや問題とやり取りすることができます。

🚀 クイックスタート

この Redmine MCP サーバーを使用することで、Cline VS Code 拡張機能を介して Redmine のプロジェクトや問題と簡単にやり取りできます。以下に、必要な手順を説明します。

✨ 主な機能

• Redmine との統合により、Cline VS Code 拡張機能を通じて Redmine のプロジェクトや問題にアクセスできます。
• 環境変数を設定することで、Redmine のホスト名と API キーを安全に管理できます。
• Cline の設定に追加することで、サーバーを簡単に起動できます。

📦 インストール

前提条件

• 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 ファイルを作成し、以下の内容を追加して、実際の 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 のプレースホルダーをパスの絶対パスに置き換えます。

   {
     "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 は自動的に変更を検出し、サーバーを起動します。

リソースとツール

リソース

• プロジェクト: 以下の URI を使用してプロジェクトにアクセスできます。

  redmine://projects
  redmine://projects/{project_id}
  

ツール

• 問題を作成する: 以下の JSON 設定を使用して、プロジェクト内で問題を作成できます。

  {
    "subject": "問題の件名",
    "description": "問題の説明"
  }
  

トラブルシューティング

• 接続が閉じられたエラー: Redmine インスタンスの REST API が有効になっていること、および API キーが正しいことを確認してください。
• サーバーログを確認する: 問題が発生した場合は、MCP サーバーのログファイルを確認して、詳細な情報を取得してください。

このガイドが Redmine MCP サーバーの使用に役立つことを願っています！