MCP Xcode Diagnostics

🚀 Xcode 診斷 MCP 插件

此插件用於從 Xcode 構建日誌中提取和查看錯誤與警告信息。它能連接到 Xcode 構建系統，提取、解析並展示 Swift 項目的診斷信息，助力 AI 助手快速識別代碼問題，無需手動搜索構建日誌。

🚀 快速開始

在使用此插件前，需確保滿足以下先決條件：

• macOS 操作系統
• 安裝了 Xcode
• Python 3.6+

同時，因為插件基於日誌級別工作，所以必須在運行此工具之前讓 Xcode 先嚐試進行一次構建。

✨ 主要特性

• 提取診斷信息：可從 Xcode 構建日誌中提取錯誤和警告信息。
• 解析結構化數據：對診斷信息進行結構化解析，便於後續處理和展示。
• 集成到 MCP 環境：支持與 MCP 框架無縫集成，提供統一接口。

📦 安裝指南

從 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

💻 使用示例

基礎用法

xc_diag

xc_diag 是用於診斷和分析 Xcode 構建問題的工具，使用示例如下：

xc_diag --project <項目路徑> [--config <配置文件>]

參數說明：

• --project：必選參數，指定要分析的 Xcode 項目路徑。
• --config：可選參數，指定自定義的診斷配置文件。

xc_report

xc_report 是用於生成構建報告的工具，使用示例如下：

xc_report --build-output <構建日誌路徑>

參數說明：

• --build-output：必選參數，指定包含構建結果的日誌路徑。

高級用法

以下是使用 xc_diag 工具並指定配置文件的示例：

xc_diag --project /path/to/your/project --config /path/to/your/config.json

📚 詳細文檔

支持的診斷類型

插件支持以下類型的錯誤和警告：

• 構建錯誤：語法錯誤、編譯器報錯等。
• 警告信息：編譯器警告、潛在問題提示等。
• 併發警告：與 Swift 併發編程相關的警告，例如競態條件檢測。

侷限性

儘管插件功能強大，但仍有一些限制：

• 日誌依賴：完全依賴於 Xcode 的構建日誌輸出格式，若日誌格式發生變化可能導致解析失敗。
• 資源消耗：處理大量構建日誌時可能會佔用較多內存和 CPU 資源。

調試信息

插件在以下位置記錄調試信息：

• 日誌文件：/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 協議進行開源。