PyAutoGUI MCP server

Enables automated GUI testing and control across operating systems by wrapping PyAutoGUI to perform mouse movements, keyboard input, screenshot capture, and image recognition tasks.
Back to servers
Setup instructions
Provider
He Tao
Release date
Apr 02, 2025
Language
Python
Package
Stats
1.5K downloads
26 stars

MCP PyAutoGUI Server is a Model Context Protocol server that provides automated GUI testing and control capabilities across Windows, macOS, and Linux. It enables AI assistants to control mouse movements, simulate keyboard input, take screenshots, find images on screen, and gather screen information.

Features

  • Control mouse movements and clicks
  • Simulate keyboard input
  • Take screenshots
  • Find images on screen
  • Get screen information
  • Cross-platform support (Windows, macOS, Linux)

Available Tools

Mouse Control

  • Move mouse to specific coordinates
  • Click at current or specified position
  • Drag and drop operations
  • Get current mouse position

Keyboard Control

  • Type text
  • Press individual keys
  • Hotkey combinations

Screen Operations

  • Take screenshots
  • Get screen size
  • Find image locations on screen
  • Get pixel colors

Installation

Prerequisites

  • Python 3.12+
  • PyAutoGUI (will be installed automatically)

Install Package

Install the MCP PyAutoGUI Server using pip:

pip install mcp-pyautogui-server

Configuration

Claude Desktop Configuration

To integrate with Claude Desktop, you need to modify the Claude configuration file located at:

On MacOS:

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

On Windows:

%APPDATA%/Claude/claude_desktop_config.json

Configuration Examples

For published servers, add the following to your configuration file:

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

For development or unpublished servers, use:

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

Usage

Once configured, the MCP PyAutoGUI Server provides various tools that Claude can use to interact with your GUI. The server automatically handles requests from Claude to control mouse movements, keyboard inputs, and screen operations.

Example Use Cases

  • Automated testing of desktop applications
  • Creating demonstrations or tutorials
  • Handling repetitive GUI tasks
  • Screen analysis and image recognition

The server runs in the background and responds to commands from Claude, allowing the AI assistant to interact with your desktop environment directly through the exposed mouse, keyboard, and screen operation tools.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mcp-pyautogui-server" '{"command":"uvx","args":["mcp-pyautogui-server"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect

Want to 10x your AI skills?

Get a free account and learn to code + market your apps using AI (with or without vibes!).

Nah, maybe later