MCP Server Ios Simulator

🚀 iOS Simulator MCP Server

This project offers an MCP (Model Context Protocol) server for controlling and managing iOS simulators. Through this server, operations such as starting and shutting down simulators, installing and launching applications, taking screenshots, and performing coordinate clicks can be achieved.

🚀 Quick Start

Prerequisites

• Node.js (Version requirement: v14.17.0 or higher)
• npm (Version requirement: 6.14.0 or higher)

Installation

# Install project dependencies
npm install

# Compile TypeScript code
npm run build

# Start the development server
npm start

✨ Features

Simulator Management

• Start and shut down iOS simulators.
• Support managing multiple simulators via UDID or custom session IDs.

Application Management

• Install applications on simulators.
• Start and terminate specified applications.

User Interaction

• Capture the simulator screen and save it as an image.
• Simulate a click operation at a specified coordinate position.

📚 Documentation

Configuration Guide

Environment Variable Configuration

Customize server behavior through the following environment variables:

• PORT: Set the server listening port, with a default value of 3000.
• DEBUG: Enable debug mode, with optional values of true or false, and a default value of false.

Log Management

Support adjusting the log output level and format through a configuration file or environment variables. Refer to the config/logger.ts file for detailed configuration.

Usage Guide

Using the CLI Tool Directly

1. List all available iOS simulators:

   npm run list-simulators
   

2. Start a simulator with a specified UDID:

   npm run start-simulator -- --udid "5272EA61-5796-4372-86FE-3B33831D5CC1"
   

3. Shut down a simulator with a specified UDID:

   npm run stop-simulator -- --udid "5272EA61-5796-4372-86FE-3B33831D5CC1"
   

Integration via the MCP Protocol

Integrate this server as an MCP tool into Claude Desktop:

1. Configure Claude Desktop:
   • Open Settings > Advanced.
   • Add the following configuration under "MCP Services":

   {
     "mcpServers": {
       "simulator": {
         "command": "node",
         "args": [
           "/path/to/your/mcp-server-ios-simulator/dist/index.js"
         ]
       }
     }
   }
   

2. Use MCP commands to control the simulator:
   • List all available iOS simulators.
   • Start a simulator with a specified UDID.
   • Capture the simulator screen.
   • Shut down a simulator with a specified UDID.

🔧 Technical Details

Project Architecture

+-------------------+     +-------------------+
|      User           |     |       Administrator |
+-------------------+     +-------------------+
          ↑                         ↓
+-------------------+     +-------------------+
|    CLI Tool         |<----->|  MCP Server      |
+-------------------+     +-------------------+
          ↓                         ↑
+-------------------+     +-------------------+
|   iOS Simulator     |     |  Simulator Management Library |
+-------------------+     +-------------------+

Project Structure

src/
├── simulator/       # Simulator management module
├── app/            # Application management module
├── logger/         # Log management module
└── server/         # HTTP server module

Development Guide

Contributing Code

1. Before submitting code, ensure that unit tests are passed via npm test.
2. Submit corresponding documentation and test cases for new features or fixes.

Issue Feedback

If you encounter any issues or have improvement suggestions, please submit an ISSUE in the GitHub repository.

📄 License

This project follows the MIT License. Please refer to the LICENSE file for detailed content.