Redmine Mcp

What is Redmine Mcp

redmine_mcp is a Ruby-based MCP server implementation that connects AI with Redmine, enabling AI to interact with Redmine tickets securely.

Use cases

Use cases include automating ticket retrieval for AI analysis, generating reports based on Redmine data, and enhancing project management workflows through AI insights.

How to use

To use redmine_mcp, set up a Docker environment with Ruby 3.3, and connect your AI to the MCP server. Specify the Redmine ticket ID for the AI to retrieve and understand the ticket content.

Key features

Key features include secure access to Redmine tickets, allowing AI to comprehend ticket details while ensuring confidentiality and preventing data leaks.

Where to use

redmine_mcp can be used in project management, software development, and any field that utilizes Redmine for tracking tasks and issues.

概要

このプロジェクトはAIがredmineと接続するためのRubyのMCPサーバ実装になります

機能

このMCPを通して以下の機能を実装することを期待しています

• Redmineチケットの参照
  • AIに対してRedmineチケットのIDを指定することによってAIがRedmineの内容を理解する
  • Redmineのチケットの内容は機密性が高いので外部に漏れないようにする

開発環境

• ruby
  • バージョン: 3.3
  • docker環境で動作する
• 開発時の接続先Redmine
  • docker環境

使用方法

MCPサーバーの準備

1. GitHubリポジトリからプロジェクトを取得

   git clone https://github.com/keiichi-omosu/redmine_mcp.git
   cd redmine_mcp
   

2. 必要なRuby Gemをインストール

   bundle install
   

3. 環境変数の設定
   以下の環境変数を設定する必要があります：

   • REDMINE_URL: RedmineサーバーのURL (例: “http://localhost:8080”)
   • REDMINE_API_KEY: RedmineのAPIキー

VS Code拡張との連携（stdio版）

1. VS Codeで使用する場合は、以下の設定を.vscode/mcp.jsonに追加します：

   {
     "servers": {
       "redminemcp": {
         "type": "stdio",
         "command": "ruby",
         "args": [
           "[プロジェクトへのフルパス]/stdio_server.rb"
         ],
         "env": {
           "REDMINE_URL": "http://localhost:8080",
           "REDMINE_API_KEY": "あなたのRedmine APIキー"
         }
       }
     }
   }
   

2. または、Claude拡張機能を使用している場合は、以下の設定をグローバル設定ファイルに追加します：

   {
     "mcpServers": {
       "redmine": {
         "disabled": false,
         "timeout": 60,
         "command": "ruby",
         "args": [
           "/path/to/redmine_mcp/stdio_server.rb"
         ],
         "env": {
           "REDMINE_URL": "http://localhost:8080",
           "REDMINE_API_KEY": "あなたのRedmine APIキー"
         },
         "transportType": "stdio"
       }
     }
   }
   

AIからの使用方法

MCPサーバーが正しく設定されると、AIはRedmineチケット情報を取得するツールにアクセスできるようになります。
以下のようにして、AIにチケット情報を取得させることができます：

1. AI（例：GitHub Copilot、Claude AI）との会話で、Redmineチケットの参照が必要な場合、以下のように依頼します：

   Redmineのチケット#123の内容を確認して、実装してください。
   

2. AIはget_redmine_ticketツールを使用して、チケット情報を安全に取得し、情報を基に回答します。

MCPサーバーのテスト方法

サーバーが正しく動作しているか確認するには、以下のコマンドを実行します：

cd /path/to/redmine_mcp
echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_redmine_ticket","arguments":{"ticket_id":"123"}}}' | ./test_stdio_server.sh

正常に動作していれば、指定したチケット情報がJSON形式で返されます。

自動テストの実行方法

本プロジェクトではminitestを使用した自動テストが実装されています。以下の方法でテストを実行できます：

1. すべてのテストを実行

   bundle exec rake test
   

2. ユニットテストのみ実行

   bundle exec rake test_unit
   

3. 統合テストのみ実行

   bundle exec rake test_integration
   

4. 特定のテストファイルのみ実行

   bundle exec rake test_file TEST=test/unit/jsonrpc_helper_test.rb
   

テスト実行時には、以下の環境変数を設定することができます：

• REDMINE_URL: テスト用RedmineサーバーのURL（デフォルト: “http://localhost:8080”）
• REDMINE_API_KEY: テスト用RedmineのAPIキー（デフォルト: “test_api_key”）

新しいテストの追加方法

新しいテストを追加する場合は、以下の手順で行います：

1. ユニットテストの場合は test/unit/ ディレクトリに、統合テストの場合は test/integration/ ディレクトリにテストファイルを作成します。
2. ファイル名は必ず _test.rb で終わるようにします（例: my_module_test.rb）。
3. テストファイルの先頭で require 'test_helper' を記述します。
4. Minitest::Test を継承したテストクラスを作成します。
5. テストメソッドは test_ で始まる名前にします。

例：

require 'test_helper'
require 'my_module'

class MyModuleTest < Minitest::Test
  def test_my_function
    result = MyModule.my_function
    assert_equal expected, result
  end
end

セキュリティについて

このツールはRedmineチケットの情報をAIに安全に提供します。APIキーは環境変数として保存され、外部に漏れないように注意してください。
チケット情報はMCPプロトコルを通じてのみ提供され、情報の機密性が保たれます。