MCP Xray Python

✈️ QAオートパイロット: JiraとGemini用のモデルコンテキストプロトコル（MCP）

このコマンドラインツール（CLI）は、モデルコンテキストプロトコル（MCP）の概念を実装しています。Jira（知識サーバーとして）とGoogle Gemini（Vertex AI経由）を接続するブリッジとして機能し、テストケースの生成を行います。

自動操縦装置のアナロジー

私は商用航空機のパイロットとして、自動操縦装置が航空機を単独で操縦することはないことを知っています。パイロットは依然として操縦席に座り、システムを監視し、飛行計画を管理し、重要な決定を下します。自動操縦装置は重い作業や繰り返し作業を担当し、パイロットが戦略的な作業に集中できるようにします。

このプロジェクトは、同じ原則を品質保証（QA）に適用しています。

問題点は何か？

Jiraでのテストケースの手動作成は、ソフトウェアのライフサイクルにおいて最も必要でありながら、最も退屈な作業の1つです。QAアナリストが探索的テスト、自動化戦略の設計、複雑なリスク分析など、より影響力のある作業に費やすことができる貴重な時間を消費します。

解決策: MCPとしての「QAオートパイロット」

モデルコンテキストプロトコル（MCP）の概念（モデルが知識サーバーに接続できるようにする）に触発され、このツールはQAアナリストを置き換えることを目的とせず、強化することを目指しています。

このツールは、1つのコマンドで実行されるインテリジェントなブリッジとして機能します。

1. ターミナルからJiraのユーザーストーリー（HU）IDを受け取ります。
2. MCPとして機能し、JiraのAPI（「知識サーバー」）に接続して、完全なコンテキスト（説明、受け入れ基準）を抽出します。
3. モデルに問い合わせ、そのコンテキストをQA用のプロンプトとともにGoogle Geminiに送信します。
4. 詳細なテストケースのセット（Gherkin形式）を生成します。
5. Jira/Xrayに自動的に「テスト」タイプのイシューを作成し、元のHUにリンクします。

結果として、QAアナリスト（「パイロット」）は、何時間もかけてテストケース（TC）を作成する代わりに、生成されたTCを確認、調整、承認するだけで済み、大量の時間と労力を節約できます。

🚀 クイックスタート

このプロジェクトをローカルマシンで設定して実行するには、以下の手順に従ってください。

1. 前提条件

• Python 3.10以上
• XrayがインストールされたJira Cloudアカウント
• AtlassianでAPIトークンを作成する権限
• Vertex AI APIが有効になっているGoogle Cloudプロジェクトと認証資格情報（サービスアカウントのJSONファイル）

2. インストール

このリポジトリをクローンします。

git clone https://github.com/tu-usuario/mcp-xray-python.git
cd mcp-xray-python

仮想環境を作成します。

python -m venv venv

仮想環境をアクティブ化します。

• macOS/Linuxの場合:

source venv/bin/activate

• Windowsの場合:

.\venv\Scripts\activate

依存関係をインストールします。

pip install -r requirements.txt

3. 資格情報の設定

このプロジェクトは、機密情報を安全に管理するために.envファイルを使用しています。 サンプルファイルのコピーを作成します。

cp .env.example .env

.envファイルをテキストエディタで開き、すべての変数を入力します。

# JIRAの設定
JIRA_URL="https://tu-instancia.atlassian.net"
JIRA_USER="tu-email-de-jira@dominio.com"
JIRA_API_TOKEN="TU_API_TOKEN_DE_JIRA_AQUI"
JIRA_PROJECT_KEY="PROJ" # Jiraのプロジェクトキー (例: 'TEST')

# Google Vertex AI (Gemini)の設定
VERTEX_AI_PROJECT_ID="tu-id-de-proyecto-gcp"
VERTEX_AI_LOCATION="us-central1" # または使用しているリージョン

# Google Cloudの資格情報JSONファイルへのパス
# このパスが正しいことを確認してください
GOOGLE_APPLICATION_CREDENTIALS="./ruta/a/tu/archivo-credenciales.json"

# Geminiモデルの設定
GEMINI_MODEL_NAME="gemini-1.5-pro" # または好みのモデル

💻 使用例

基本的な使用法

仮想環境（venv）がアクティブ化され、.envファイルが設定されたら、JiraのイシューIDを指定してrun_mcp.pyスクリプトを実行するだけです。

python run_mcp.py --issue ALL-8296

高度な使用法

古いテストを削除する（単にラベル付けするのではなく）例:

python run_mcp.py --issue ALL-8296 --delete-obsolete

📚 ドキュメント

アーキテクチャと作業フロー

アプリケーションのフローは以下の通りです。

1. 開始: QAアナリストがターミナルからrun_mcp.pyスクリプトを実行し、イシューIDを渡します（例: python run_mcp.py --issue PROJ-123）。
2. 抽出（Jira）: スクリプトはsrc/core/jira.pyモジュールを使用してJiraのAPIに接続し、PROJ-123の詳細（タイトル、説明、受け入れ基準）を取得します。
3. 生成（Gemini）: スクリプトはこの情報をsrc/core/llm.pyモジュールに渡し、プロンプトを構築してVertex AIのGemini APIに送信します。
4. 応答（Gemini）: Geminiは構造化された応答（例: Gherkin形式のTCリストを含むJSON）を返します。
5. 作成（Jira/Xray）: スクリプトはこれらのTCを取得し、再びsrc/core/jira.pyを使用して、Jiraに各テストケースに対応する「テスト」タイプのイシューを作成し、元のHUに自動的にリンクします。
6. 終了: スクリプトはターミナルに確認メッセージを表示します。QAアナリストはJiraで作成されたTCを確認できます。

単体テスト

このプロジェクトには、主要モジュールのコードの品質と安定性を保証するための単体テストのセットが含まれています。

1. 開発用依存関係のインストール: pytestがインストールされていることを確認してください（requirements.txtに含まれています）。

pip install -r requirements.txt

2. テストの実行: プロジェクトのルートディレクトリから、次のコマンドを実行します。

pytest

🤝 コントリビューション

コントリビューションは大歓迎です！このツールを改善するアイデア、Geminiのプロンプトを最適化する方法、または新しい機能を追加する方法がある場合は、以下の手順に従ってください。

1. プロジェクトをフォークします。
2. フィーチャーブランチを作成します（git checkout -b feature/MejoraIncreible）。
3. 変更をコミットします（git commit -m 'Añade MejoraIncreible'）。
4. ブランチにプッシュします（git push origin feature/MejoraIncreible）。
5. プルリクエストを開きます。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細については、LICENSEファイルを参照してください。