Pyautogui

🚀 mcp-pyautogui-server

A server based on the Model Context Protocol (MCP) that provides automated graphical user interface testing and control functions through PyAutoGUI.

✨ Features

• Control mouse movement and clicks.
• Simulate keyboard input.
• Take screenshots.
• Find images on the screen.
• Get screen information.
• Support multiple platforms (Windows, macOS, Linux).

🛠️ Tools

This server implements the following tools:

🖱️ Mouse Control

• Move the mouse to specific coordinates.
• Click at the current or specified position.
• Perform drag-and-drop operations.
• Get the current mouse position.

⌨️ Keyboard Control

• Input text.
• Press a single key.
• Use combination shortcuts.

🖥️ Screen Operations

• Take screenshots.
• Get the screen size.
• Find the position of an image on the screen.
• Get the pixel color.

📦 Installation

📋 Prerequisites

• Python 3.12+
• PyAutoGUI
• Other dependencies will be installed automatically.

🚀 Installation Steps

Install the package:

pip install mcp-pyautogui-server

⚙️ Claude Desktop Configuration

On MacOS:

~/Library/Application\ Support/Claude/claude_desktop_config.json

On Windows:

%APPDATA%/Claude/claude_desktop_config.json

Configuration for a development/unreleased server:

{
  "mcpServers": {
    "mcp-pyautogui-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/mcp-pyautogui-server",
        "run",
        "mcp-pyautogui-server"
      ]
    }
  }
}

Configuration for a released server:

{
  "mcpServers": {
    "mcp-pyautogui-server": {
      "command": "uvx",
      "args": [
        "mcp-pyautogui-server"
      ]
    }
  }
}

🔧 Development

🚀 Build and Publish

1. Synchronize dependencies and update the lock file:

uv sync

2. Build the package distribution:

uv build

3. Publish to PyPI:

uv publish

Note: Set PyPI credentials through environment variables or command-line parameters:

• Token: --token or UV_PUBLISH_TOKEN
• Username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

🐞 Debugging

For the best debugging experience, use the MCP inspector.

Start the MCP inspector via npm:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-pyautogui-server run mcp-pyautogui-server

The inspector will display a URL that you can access in your browser to start debugging.

📄 License

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