Ios Simulator

🚀 Project Introduction

This tool is a low-level server that uses idb to control iOS simulators. It supports interacting with iOS simulators through natural language processing (NLP) or direct commands.

✨ Features

• Multi-session Support: It can connect to multiple iOS simulators simultaneously.
• Comprehensive Command Set: It supports all the features of the idb CLI tool.
• Natural Language Processing: It supports issuing commands through natural language (e.g., "Open Safari browser").
• MCP Integration: It can be integrated with the Model Context Protocol as an application plugin for LLMs.

📦 Installation

Install using npm:

npm install mcp-server-simulator-ios-idb

Then run the server:

node index.js

💻 Usage Examples

Basic Usage

1. Add to MCP Configuration

Create or update the .env file in the project's root directory and add the following content:

MCP_SERVERS=ios-simulator
IOS_SIMULATOR_SERVER_PATH=/path/to/mcp-server-simulator-ios-idb/dist/index.js

2. Use in LLM Application

Connect to the server with the following code:

const result = await useMcpTool({
    serverName: "ios-simulator",
    toolName: "process-instruction",
    arguments: {
        instruction: "Open Safari browser"
    }
});

Advanced Usage

Command List

1. Basic Control Commands

• Start the simulator

  start_simulator
  

• Stop the simulator

  stop_simulator
  

• Restart the simulator

  restart_simulator
  

2. Screenshot and Screen Recording

• Take a screenshot

  take_screenshot /path/to/output.png
  

• Start screen recording

  start_recording /path/to/output.mp4
  

• Stop screen recording

  stop_recording
  

3. Access Logs

• Get system logs

  get_system_logs
  

• Get logs of a specific app

  get_app_logs com.example.app
  

4. Debugging Features

• Start a debugging session

  start_debug com.example.app
  

• Stop a debugging session

  stop_debug
  

• Check the debugging status

  debug_status
  

5. General Operations

• Describe screen elements

  describe_elements
  

• Describe the element at a specified coordinate point

  describe_point 100,200
  

• Input text

  input_text "Hello World"
  

🔧 Technical Details

The system consists of three main components:

1. IDBManager: A low-level component that directly interacts with iOS simulators using the idb protocol.
2. NLParser: A component that interprets natural language instructions and converts them into structured commands.
3. MCPOrchestrator: A central component that coordinates NLP parsing and IDBManager operations.

📄 Acknowledgments

Thanks to the facebook/idb project, which made this tool possible. Special thanks to all contributors in the open-source community.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.