MCP Ios Simulator Screenshot

🚀 iOS Simulator Screenshot MCP Server

A server that uses the Model Context Protocol (MCP) to capture screenshots from an iOS simulator.

🚀 Quick Start

This project implements a server based on the MCP protocol to capture the current iOS simulator screen and save it to a specified directory.

✨ Features

• Capture screenshots from the iOS simulator using the MCP protocol.
• Customize output file names, directories, and image resizing.
• Provide detailed output information upon success or failure.

📦 Installation

Cline and Roo Code

For Cline and Roo Code, the basic format is as follows:

{
  "mcpServers": {
    "mcp-ios-simulator-screenshot": {
      "command": "npx",
      "args": ["-y", "mcp-ios-simulator-screenshot"]
    }
  }
}

If you clone the repository, you can use the following configuration:

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

Cursor and Claude Desktop

For Cursor and Claude Desktop, you need to specify --output-dir and the output directory:

{
  "mcpServers": {
    "mcp-ios-simulator-screenshot": {
      "command": "npx",
      "args": [
        "mcp-ios-simulator-screenshot",
        "--output-dir",
        "/path/to/your/output/directory"
      ]
    }
  }
}

📚 Documentation

MCP Tool Parameters - get_screenshot

Capture a screenshot from the iOS simulator and save it to the specified directory.

Output Format

On success:

{
  "success": true,
  "message": "iOS simulator screenshot saved successfully",
  "filePath": ".screenshots/simulator_2025-04-10T16-51-16-755Z.png",
  "metadata": {
    "width": 1170,
    "height": 2532,
    "format": "png",
    "size": 382946,
    "timestamp": "2025-04-10T16:51:16.755Z"
  },
  "serverConfig": {
    "commandLineArgs": {
      "outputDir": "/Users/username/Desktop" // Only included if --output-dir is specified
    }
  }
}

Note: The serverConfig.commandLineArgs.outputDir field is only included in the response if the --output-dir parameter is specified when starting the server.

On failure:

{
  "success": false,
  "message": "Failed to capture iOS simulator screenshot: [Error message]",
  "error": {
    "code": "ENOENT",
    "command": "xcrun simctl io booted screenshot --type=png -",
    "stderr": "No matching devices."
  }
}

Troubleshooting

⚠️ Important Note

• If you cannot capture a screenshot: - Check if the iOS simulator is running. - Check if the Xcode command-line tools are installed. - Check if you can directly execute the xcrun simctl io booted screenshot command.
• If you encounter a permission error: - Check if the output directory has write permissions.

Requirements

• Node.js 16.0.0 or higher
• macOS (required for the iOS simulator)
• Xcode command-line tools

Technology Stack

• TypeScript
• MCP Protocol

License

[Specify license information here]

💻 Usage Examples

Basic Usage

1. Clone the repository:

git clone [Repository URL]
cd mcp-ios-simulator-screenshot

2. Install dependencies:

npm install

3. Start the server:

node build/index.js

4. Use an MCP client to call the get_screenshot method.

Advanced Usage

Use Postman or curl to send a request:

curl http://localhost:port/mcp/methods/get_screenshot

Ensure that you configure the correct parameters and output directory.