Ios Simulator MCP

🚀 iOS Simulator MCP Server

An MCP (Model Context Protocol) server for interacting with iOS simulators. This server allows you to interact with iOS simulators by retrieving information about the simulator, controlling UI interactions, and inspecting UI elements.

https://github.com/user-attachments/assets/453ebe7b-cc93-4ac2-b08d-0f8ac8339ad3

🚀 Quick Start

The iOS Simulator MCP Server is designed to facilitate interaction with iOS simulators. It provides a range of features to help you manage and control the simulator environment effectively.

✨ Features

• Retrieve the ID of the currently launched iOS simulator.
• Interact with the simulator UI:
  • Get the currently processing activity.
  • Obtain context information about the current activity.
  • Control the response to the current activity.
• Inspect and modify the simulator state.
• Collect and analyze simulator performance data.

✨ Characteristics

• Support multiple iOS simulator versions.
• Efficient state management and context tracking.
• Flexible event handling mechanism.
• Detailed logging and debugging options.

📦 Installation

Prerequisites

• Node.js version >= 8.0.0
• npm or yarn package manager
• Installed and configured iOS simulator toolchain

Installation Instructions

Installation with Cursor

1. Quick installation using NPX:

   npx ios-simulator-mcp --install
   

2. Local build and installation (optional):

   git clone https://github.com/joshuayoes/ios-simulator-mcp.git
   cd ios-simulator-mcp
   npm install
   npm run build
   

Installation with Claude Code

1. Quickly add the server using NPX:

   claude mcp add ios-simulator --command npx --args "-y,ios-simulator-mcp"
   

2. Local build and addition (optional):

   git clone https://github.com/joshuayoes/ios-simulator-mcp.git
   cd ios-simulator-mcp
   npm install
   npm run build
   claude mcp add ios-simulator --command node --args "/full/path/to/build/index.js"
   

💻 Usage Examples

Example 1: Basic Interaction

const { SimulatorMcpServer } = require('ios-simulator-mcp');

// Create a server instance
const server = new SimulatorMcpServer({
  port: 3001,
  mode: 'development',
  logging: true
});

// Start the server
server.start().then(() => {
  console.log('Server has started and is listening on port 3001');
}).catch(err => {
  console.error('Error starting the server:', err);
});

Example 2: Custom Event Handling

const { SimulatorMcpServer } = require('ios-simulator-mcp');

// Create and configure a server instance
const server = new SimulatorMcpServer({
  port: 3001,
  events: {
    'custom-event': (context) => {
      // Custom event handling logic
      console.log('Custom event detected:', context);
      return { status: 'handled', response: 'Custom event has been handled' };
    }
  }
});

// Start the server
server.start().then(() => {
  console.log('Server has started and is listening on port 3001');
}).catch(err => {
  console.error('Error starting the server:', err);
});

📚 Documentation

Configuration

Environment Variables

You can configure the behavior of the MCP server by setting the following environment variables:

📄 License

MIT