MCP Xcode Diagnostics

🚀 Xcode Diagnostic MCP Plugin

This MCP (Model Control Protocol) plugin is used to extract and view error and warning information from Xcode build logs. It helps AI assistants quickly identify code issues without manually searching through build logs.

🚀 Quick Start

Before running this tool, you must let Xcode attempt a build first because the plugin operates at the log level.

✨ Features

• Extract Diagnostic Information: The plugin can extract error and warning information from Xcode build logs.
• Parse Structured Data: It provides structured parsing of diagnostic information for easy subsequent processing and display.
• Integrate into MCP Environment: It supports seamless integration with the MCP framework, offering a unified interface.

📦 Installation

Install from PyPI

The easiest way to install the MCP-Xcode-Diagnostics plugin:

pip install mcp-xcode-diagnostics

Install from GitHub

Clone the repository from GitHub and install:

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

Install from Source Code

Install directly from the source code:

python setup.py install

📚 Documentation

Supported Diagnostic Types

The plugin supports the following types of errors and warnings:

• Build Errors: Syntax errors, compiler errors, etc.
• Warning Messages: Compiler warnings, potential problem hints, etc.
• Concurrency Warnings: Warnings related to Swift concurrent programming, such as race condition detection.

Limitations

Although the plugin is powerful, it still has some limitations:

• Log Dependency: It completely depends on the output format of Xcode's build logs. If the log format changes, parsing may fail.
• Resource Consumption: Processing a large number of build logs may consume more memory and CPU resources.

MCP Tools

xc_diag

xc_diag is a tool for diagnosing and analyzing Xcode build issues, supporting the following parameters:

xc_diag --project <Project Path> [--config <Configuration File>]

Parameter Description

• --project: Required parameter, specifying the path of the Xcode project to be analyzed.
• --config: Optional parameter, specifying a custom diagnostic configuration file.

xc_report

xc_report is a tool for generating build reports:

xc_report --build-output <Build Log Path>

Parameter Description

• --build-output: Required parameter, specifying the path of the log containing the build results.

Debug Information

The plugin records debug information in the following locations:

• Log File: /var/log/mcp-xcode-diagnostics.log
• Error Report: /tmp/mcp-xcode-diagnostics-error-<timestamp>.log

💻 Usage Examples

Basic Usage

Here is an example output in JSON format:

{
  "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
}

Advanced Usage

The plugin comes with a test suite to verify the parsing function:

# Run all tests
python -m unittest test_xcode_diagnostics.py

📄 License

This open-source project is licensed under the MIT License.

⚠️ Important Note

Since the plugin operates at the log level, you must let Xcode attempt a build before running this tool.

💡 Usage Tip

The plugin completely depends on the output format of Xcode's build logs. If the log format changes, parsing may fail. Also, processing a large number of build logs may consume more memory and CPU resources.