Swift MCP Gui

🚀 Swift MCP GUI Server

A Model Context Protocol (MCP) server that enables control of Mac OS X via SwiftAutoGUI. This server provides tools for programmatically controlling the mouse and keyboard through an MCP client.

🚀 Quick Start

✨ Features

This server offers tools to control macOS, including mouse movement, mouse clicks, keyboard input, and scrolling operations.

📦 Installation

1. Clone this repository:

git clone https://github.com/NakaokaRei/swift-mcp-gui.git
cd swift-mcp-gui

2. Install the package:

swift package experimental-install

3. Add the following command to your MCP client configuration:

{
  "mcpServers" : {
    "swift-mcp-gui" : {
      "command" : "/Users/USERNAME/.swiftpm/bin/swift-mcp-gui"
    }
  }
}

💻 Usage Examples

The server provides the following tools for controlling macOS:

Basic Usage

• Mouse Movement:

{
  "tool": "moveMouse",
  "parameters": {
    "x": 100.0,
    "y": 200.0
  }
}

• Mouse Click:

{
  "tool": "mouseClick",
  "parameters": {
    "button": "left"
  }
}

• Keyboard Input:

{
  "tool": "sendKeys",
  "parameters": {
    "keys": ["command", "c"]
  }
}

• Scrolling Operation:

{
  "tool": "scroll",
  "parameters": {
    "direction": "down",
    "clicks": 3
  }
}

📚 Documentation

• Mouse Movement:

  • Tool Name: moveMouse
  • Input Parameters:
    • x: Double (x-coordinate)
    • y: Double (y-coordinate)
  • Function: Moves the mouse cursor to the specified coordinates.

• Mouse Click:

  • Tool Name: mouseClick
  • Input Parameters:
    • button: String ("left" or "right" for left or right button)
  • Function: Performs a mouse click at the current cursor position.

• Keyboard Input:

  • Tool Name: sendKeys
  • Input Parameters:
    • keys: Array of String (strings representing keyboard keys)
  • Function: Sends keyboard shortcuts or key combinations.
  • Example Keys: "command", "control", "option", "shift", "return", "space", "a", "1", etc.

• Scrolling Operation:

  • Tool Name: scroll
  • Input Parameters:
    • direction: String ("up", "down", "left", "right" for scrolling direction)
    • clicks: Int (number of scroll clicks)
  • Function: Performs a scrolling operation in the specified direction.

⚠️ Important Note

This server has full control over your mouse and keyboard. Please run it with caution and only connect to trusted MCP clients.

📄 License

MIT License