Xcode

🚀 Xcode-MCP Tool Documentation

Xcode-MCP is a powerful command-line tool designed to simplify the development, testing, and distribution processes of macOS and iOS applications. By integrating various Xcode tools and modern device control functions, it helps developers improve their work efficiency.

✨ Features

Core Tools

• xcode-list-schemes: Lists all available schemes in the project.
• xcode-test: Executes tests and generates result reports.
• xcode-archive: Creates an IPA package for distribution.
• xcode-clean: Removes build caches and temporary files.
• xcode-run-simulator: Runs the application on a specified iOS simulator.
• xcode-run-device: Runs the application on a connected physical device.

💻 Usage Examples

Basic Usage

Testing Process:

1. List all schemes in the project:

   xcode-list-schemes --project /Users/username/Projects/MyApp.xcodeproj
   

2. Select a scheme and execute tests:

   xcode-test --project /Users/username/Projects/MyApp.xcodeproj --scheme MyApp --configuration Debug
   

3. Package the application for distribution:

   xcode-archive --project /Users/username/Projects/MyApp.xcodeproj --scheme MyApp --configuration Release --output /Users/username/Desktop/MyApp.ipa
   

Advanced Usage

Example Workflow Using LLM: User Prompt to Claude:

I need to check my Xcode project, run some tests, and then package it for distribution.

1. First, use the xcode-list-schemes tool to list all schemes in my project at /Users/username/Projects/MyApp.xcodeproj.
2. After seeing the schemes, run tests for the first available scheme on the iPhone 14 simulator.
3. Then, package the application using the Release configuration.

Expected Workflow:

1. Claude executes the xcode-list-schemes tool to get all schemes:

   Project path: /Users/username/Projects/MyApp.xcodeproj
   

2. Select the first available scheme and run tests:

   Project path: /Users/username/Projects/MyApp.xcodeproj
   Scheme: MyApp
   Destination: platform=iOS Simulator,name=iPhone 14
   

3. Package the application for distribution:

   Project path: /Users/username/Projects/MyApp.xcodeprj
   Scheme: MyApp
   Configuration: Release
   ArchivePath: /Users/username/Desktop/MyApp.ipa
   

⚠️ Important Note

This tool can execute Xcode-related commands, which poses certain security risks. Please note the following points:

• Only for trusted projects: Use this tool only in trusted Xcode projects.
• Be cautious with unknown sources: Be vigilant about projects from unknown sources.
• Avoid sensitive information: Do not include sensitive information in build parameters.

📦 Installation

System Requirements

• Node.js 16 or higher
• npm 6 or higher
• Xcode 14 or higher (for all features)
• Xcode 16 or higher (required for devicectl and physical device functions)

Local Development and Testing

# Clone the repository
git clone https://github.com/yourusername/xcode-mcp.git
cd xcode-mcp

# Install dependencies
npm install

# Start the development server
npm run dev

# Build the project
npm run build

# Run tests
npm test

Code Submission

1. Create a feature branch:

   git checkout -b feature/new-feature
   

2. Commit changes:

   git add .
   git commit -m "Add new feature"
   

3. Push to the remote repository:

   git push origin feature/new-feature
   

4. Create a Pull Request.

📚 Documentation

References

• Xcode Documentation
• devicectl Documentation
• npm Official Documentation

By following these steps, you can effectively use the Xcode-MCP tool to manage your development process. For further assistance, please feel free to check our issue tracking page or submit a new issue directly on GitHub.

Thank you for choosing the Xcode-MCP tool! We hope it will bring convenience to your development work.