MCP Xcode Diagnostics

🚀 Xcode 診断 MCP プラグイン

この MCP (Model Control Protocol) プラグインは、Xcode のビルドログからエラーと警告情報を抽出し、表示するために使用されます。Xcode のビルドシステムに接続し、Swift プロジェクト内の診断情報（エラーと警告）を抽出、解析、表示します。このプラグインにより、AI アシスタントは手動でビルドログを検索することなく、迅速にコードの問題を識別できます。

⚠️ 重要提示

このプラグインはログレベルで動作するため、このツールを実行する前に、Xcode で一度ビルドを試行する必要があります。

🚀 クイックスタート

この MCP プラグインを使用することで、Xcode のビルドログからエラーや警告情報を簡単に抽出できます。以下のセクションでは、インストール方法や使用方法などを詳しく説明します。

✨ 主な機能

• 診断情報の抽出：プラグインは Xcode のビルドログからエラーと警告情報を抽出できます。
• 構造化データの解析：診断情報を構造化して解析し、後続の処理と表示を容易にします。
• MCP 環境への統合：MCP フレームワークとのシームレスな統合をサポートし、統一されたインターフェースを提供します。

📦 インストール

前提条件

• macOS オペレーティングシステム
• Xcode がインストールされていること
• Python 3.6 以上

インストール方法

PyPI からのインストール

MCP-Xcode-Diagnostics プラグインをインストールする最も簡単な方法は、以下のコマンドを実行することです。

pip install mcp-xcode-diagnostics

GitHub からのインストール

GitHub からリポジトリをクローンしてインストールします。

git clone https://github.com/yourusername/mcp-xcode-diagnostics.git
cd mcp-xcode-diagnostics
pip install .

ソースコードからのインストール

ソースコードから直接インストールするには、以下のコマンドを実行します。

python setup.py install

📚 ドキュメント

サポートされる診断タイプ

このプラグインは、以下のタイプのエラーと警告をサポートしています。

• ビルドエラー：構文エラー、コンパイラエラーなど。
• 警告情報：コンパイラ警告、潜在的な問題の警告など。
• 並行警告：Swift の並行プログラミングに関連する警告、例えば競合状態の検出など。

制限事項

このプラグインは強力な機能を持っていますが、いくつかの制限があります。

• ログ依存性：Xcode のビルドログの出力形式に完全に依存しているため、ログ形式が変更されると解析に失敗する可能性があります。
• リソース消費：大量のビルドログを処理する場合、多くのメモリと CPU リソースを消費する可能性があります。

MCP ツール

xc_diag

xc_diag は、Xcode のビルド問題を診断および分析するためのツールで、以下のパラメータをサポートしています。

xc_diag --project <プロジェクトパス> [--config <設定ファイル>]

パラメータの説明

• --project：必須パラメータで、分析対象の Xcode プロジェクトのパスを指定します。
• --config：オプションパラメータで、カスタムの診断設定ファイルを指定します。

xc_report

xc_report は、ビルドレポートを生成するためのツールです。

xc_report --build-output <ビルドログパス>

パラメータの説明

• --build-output：必須パラメータで、ビルド結果を含むログのパスを指定します。

デバッグ情報

プラグインは以下の場所にデバッグ情報を記録します。

• ログファイル：/var/log/mcp-xcode-diagnostics.log
• エラーレポート：/tmp/mcp-xcode-diagnostics-error-<timestamp>.log

サンプル出力

以下は、JSON 形式のサンプル出力です。

{
  "errors": [
    {
      "message": "Use of undeclared identifier 'tableViewCell'",
      "file": "MainViewController.swift",
      "line": 23,
      "column": 15
    }
  ],
  "warnings": [
    {
      "message": "Missing Swift header for public class PodsDummy_Pods_Pods_Swift",
      "file": "_Pods-Swift.h",
      "line": 5
    }
  ],
  "error_count": 1,
  "warning_count": 1
}

テスト

プラグインには、解析機能を検証するためのテストスイートが付属しています。

# すべてのテストを実行する
python -m unittest test_xcode_diagnostics.py

📄 ライセンス

このオープンソースプロジェクトは、MIT ライセンスの下で公開されています。