Windows-MCP

<div align="center"> <h1>🪟 Windows-MCP</h1>

<a href="https://github.com/CursorTouch/Windows-MCP/blob/main/LICENSE"> <img src="https://img.shields.io/badge/license-MIT-green" alt="License"> </a> <img src="https://img.shields.io/badge/python-3.13%2B-blue" alt="Python"> <img src="https://img.shields.io/badge/platform-Windows%207–11-blue" alt="Platform: Windows 7 to 11"> <img src="https://img.shields.io/github/last-commit/CursorTouch/Windows-MCP" alt="Last Commit"> <br> <a href="https://x.com/CursorTouch"> <img src="https://img.shields.io/badge/follow-%40CursorTouch-1DA1F2?logo=twitter&style=flat" alt="Follow on Twitter"> </a> <a href="https://discord.com/invite/Aue9Yj2VzS"> <img src="https://img.shields.io/badge/Join%20on-Discord-5865F2?logo=discord&logoColor=white&style=flat" alt="Join us on Discord"> </a>

</div>

<br>

Windows-MCP is a lightweight, open-source project that enables seamless integration between AI agents and the Windows operating system. Acting as an MCP server bridges the gap between LLMs and the Windows operating system, allowing agents to perform tasks such as file navigation, application control, UI interaction, QA testing, and more.

mcp-name: io.github.CursorTouch/Windows-MCP

Updates

• Added VM support for Windows-MCP. Check (windowsmcp.io)[https://windowsmcp.io/] for more details.
• Windows-MCP reached 2M+ Users in Claude Desktop Extensiosn.
• Try out 🪟Windows-Use, an agent built using Windows-MCP.
• Windows-MCP is now available on PyPI (thus supports uvx windows-mcp)
• Windows-MCP is added to MCP Registry

Supported Operating Systems

• Windows 7
• Windows 8, 8.1
• Windows 10
• Windows 11

🎥 Demos

https://github.com/user-attachments/assets/d0e7ed1d-6189-4de6-838a-5ef8e1cad54e

https://github.com/user-attachments/assets/d2b372dc-8d00-4d71-9677-4c64f5987485

✨ Key Features

• Seamless Windows Integration
  Interacts natively with Windows UI elements, opens apps, controls windows, simulates user input, and more.

• Use Any LLM (Vision Optional) Unlike many automation tools, Windows-MCP doesn't rely on any traditional computer vision techniques or specific fine-tuned models; it works with any LLMs, reducing complexity and setup time.

• Rich Toolset for UI Automation
  Includes tools for basic keyboard, mouse operation and capturing window/UI state.

• Lightweight & Open-Source
  Minimal dependencies and easy setup with full source code available under MIT license.

• Customizable & Extendable
  Easily adapt or extend tools to suit your unique automation or AI integration needs.

• Real-Time Interaction
  Typical latency between actions (e.g., from one mouse click to the next) ranges from 0.2 to 0.9 secs, and may slightly vary based on the number of active applications and system load, also the inferencing speed of the llm.

• DOM Mode for Browser Automation
  Special use_dom=True mode for State-Tool that focuses exclusively on web page content, filtering out browser UI elements for cleaner, more efficient web automation.

🛠️Installation

Note: When you install this MCP server for the first time it may take a minute or two because of installing the dependencies in pyproject.toml. In the first run the server may timeout ignore it and restart it.

Prerequisites

• Python 3.13+

• UV (Package Manager) from Astra, install with pip install uv or curl -LsSf https://astral.sh/uv/install.sh | sh

• English as the default language in Windows preferred else disable the App-Tool in the MCP Server for Windows with other languages. <details> <summary>Install in Claude Desktop</summary>

  1. Install Claude Desktop and

npm install -g @anthropic-ai/mcpb

2. Configure the extension:

Option A: Install from PyPI (Recommended)

Use uvx to run the latest version directly from PyPI.

Add this to your claude_desktop_config.json:

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

Option B: Install from Source

1. Clone the repository:

git clone https://github.com/CursorTouch/Windows-MCP.git
cd Windows-MCP

2. Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "windows-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "<path to the windows-mcp directory>",
        "run",
        "windows-mcp"
      ]
    }
  }
}

3. Open Claude Desktop and enjoy! 🥳

4. Enjoy 🥳.

Claude Desktop MSIX (Windows Store)

The MSIX-packaged Claude Desktop virtualizes %APPDATA%. Config lives at: %LOCALAPPDATA%\Packages\Claude_pzs8sxrjxfjjc\LocalCache\Roaming\Claude\claude_desktop_config.json (not %APPDATA%\Claude\). The "Edit Config" button may open the wrong file.

Electron apps also do not inherit PATH, so uv/uvx can fail with spawn ENOENT. Use the full absolute path to uv.exe:

{
  "mcpServers": {
    "windows-mcp": {
      "command": "C:\\Users\\<user>\\.local\\bin\\uv.exe",
      "args": [
        "--directory",
        "C:\\Users\\<user>\\AppData\\Local\\Packages\\Claude_pzs8sxrjxfjjc\\LocalCache\\Roaming\\Claude\\Claude Extensions\\ant.dir.cursortouch.windows-mcp",
        "run",
        "windows-mcp"
      ]
    }
  }
}

Replace <user> with your username. To find uv.exe, run where uv in a terminal; common location is %USERPROFILE%\.local\bin\uv.exe. For PyPI install, use args: ["run", "windows-mcp"] instead of --directory/path. Save as UTF-8 without BOM (PowerShell Set-Content -Encoding UTF8 adds a BOM that breaks the JSON parser).

For additional Claude Desktop integration troubleshooting, see the MCP documentation. </details>

<details> <summary>Install in Perplexity Desktop</summary>

1. Install Perplexity Desktop:

2. Clone the repository.

git clone https://github.com/CursorTouch/Windows-MCP.git

cd Windows-MCP

3. Open Perplexity Desktop:

Go to Settings->Connectors->Add Connector->Advanced

4. Enter the name as Windows-MCP, then paste the following JSON in the text area.

Option A: Install from PyPI (Recommended)

{
  "command": "uvx",
  "args": [
    "windows-mcp"
  ]
}

Option B: Install from Source

{
  "command": "uv",
  "args": [
    "--directory",
    "<path to the windows-mcp directory>",
    "run",
    "windows-mcp"
  ]
}

5. Click Save and Enjoy 🥳.

For additional Claude Desktop integration troubleshooting, see the Perplexity MCP Support. The documentation includes helpful tips for checking logs and resolving common issues. </details>

<details> <summary> Install in Gemini CLI</summary>

1. Install Gemini CLI:

npm install -g @google/gemini-cli

2. Configure the server in %USERPROFILE%/.gemini/settings.json:

3. Navigate to %USERPROFILE%/.gemini in File Explorer and open settings.json.

4. Add the windows-mcp config in the settings.json and save it.

{
  "theme": "Default",
  ...
  "mcpServers": {
    "windows-mcp": {
      "command": "uvx",
      "args": [
        "windows-mcp"
      ]
    }
  }
}

Note: To run from source, replace the command with uv and args with ["--directory", "<path>", "run", "windows-mcp"].

5. Rerun Gemini CLI in terminal. Enjoy 🥳 </details>

<details> <summary>Install in Qwen Code</summary>

1. Install Qwen Code:

npm install -g @qwen-code/qwen-code@latest

2. Configure the server in %USERPROFILE%/.qwen/settings.json:

3. Navigate to %USERPROFILE%/.qwen/settings.json.

4. Add the windows-mcp config in the settings.json and save it.

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

Note: To run from source, replace the command with uv and args with ["--directory", "<path>", "run", "windows-mcp"].

5. Rerun Qwen Code in terminal. Enjoy 🥳 </details>

<details> <summary>Install in Codex CLI</summary>

1. Install Codex CLI:

npm install -g @openai/codex

2. Configure the server in %USERPROFILE%/.codex/config.toml:

3. Navigate to %USERPROFILE%/.codex/config.toml.

4. Add the windows-mcp config in the config.toml and save it.

[mcp_servers.windows-mcp]
command="uvx"
args=[
  "windows-mcp"
]

Note: To run from source, replace the command with uv and args with ["--directory", "<path>", "run", "windows-mcp"].

5. Rerun Codex CLI in terminal. Enjoy 🥳 </details>

---

🖥️ Modes

Windows-MCP supports two operating modes: Local (default) and Remote.

Local Mode (Default)

In local mode, Windows-MCP runs directly on your Windows machine and exposes its tools to the connected MCP client. This is the standard setup for personal use.

# Runs with stdio transport (default)
uvx windows-mcp

# Or with SSE/Streamable HTTP for network access
uvx windows-mcp --transport sse --host localhost --port 8000
uvx windows-mcp --transport streamable-http --host localhost --port 8000

No additional environment variables are needed. The MCP client connects directly to the server.

Remote Mode

In remote mode, Windows-MCP acts as a proxy that connects to the windowsmcp.io enabling cloud-hosted Windows automation. This is designed for scenarios where the MCP client is remote and connects through the dashboard, which routes requests to a Windows VM running Windows-MCP.

Required environment variables:

Variable	Description
MODE	Set to remote
SANDBOX_ID	The sandbox/VM identifier from the dashboard
API_KEY	Your Windows-MCP API key

Example configuration:

{
  "mcpServers": {
    "windows-mcp": {
      "command": "uvx",
      "args": [
        "windows-mcp"
      ],
      "env": {
        "MODE": "remote",
        "SANDBOX_ID": "your-sandbox-id",
        "API_KEY": "your-api-key"
      }
    }
  }
}

Transport Options

Transport	Flag	Use Case
stdio (default)	--transport stdio	Direct connection from MCP clients like Claude Desktop, Cursor, etc.
sse	--transport sse --host HOST --port PORT	Network-accessible via Server-Sent Events
streamable-http	--transport streamable-http --host HOST --port PORT	Network-accessible via HTTP streaming (recommended for production)

---

🔨MCP Tools

MCP Client can access the following tools to interact with Windows:

• Click: Click on the screen at the given coordinates.
• Type: Type text on an element (optionally clears existing text).
• Scroll: Scroll vertically or horizontally on the window or specific regions.
• Move: Move mouse pointer or drag (set drag=True) to coordinates.
• Shortcut: Press keyboard shortcuts (Ctrl+c, Alt+Tab, etc).
• Wait: Pause for a defined duration.
• Screenshot: Fast screenshot-first desktop capture with cursor position, active/open windows, and an image. Skips UI tree extraction for speed and should be the default first call when you mainly need visual context. Supports display=[0] or display=[0,1] to capture specific screens.
• Snapshot: Full desktop state capture for workflows that need interactive element ids, scrollable regions, or use_dom=True browser extraction. Supports use_vision=True for including screenshots and display=[0] or display=[0,1] for limiting all returned Snapshot information to specific screens.
• App: To launch an application from the start menu, resize or move the window and switch between apps.
• Shell: To execute PowerShell commands.
• Scrape: To scrape the entire webpage for information.
• MultiSelect: Select multiple items (files, folders, checkboxes) with optional Ctrl key.
• MultiEdit: Enter text into multiple input fields at specified coordinates.
• Clipboard: Read or set Windows clipboard content.
• Process: List running processes or terminate them by PID or name.
• Notification: Send a Windows toast notification with a title and message.
• Registry: Read, write, delete, or list Windows Registry values and keys.

🤝 Connect with Us

Stay updated and join our community:

• 📢 Follow us on X for the latest news and updates

• 💬 Join our Discord Community

Star History

👥 Contributors

Thanks to all the amazing people who have contributed to Windows-MCP! 🎉

<a href="https://github.com/CursorTouch/Windows-MCP/graphs/contributors"> <img src="https://contrib.rocks/image?repo=CursorTouch/Windows-MCP" /> </a>

We appreciate every contribution, whether it's code, documentation, bug reports, or feature suggestions. Want to contribute? Check out our Contributing Guidelines!

🔒 Security

Important: Windows-MCP operates with full system access and can perform irreversible operations. Please review our comprehensive security guidelines before deployment.

For detailed security information, including:

• Tool-specific risk assessments
• Deployment recommendations
• Vulnerability reporting procedures
• Compliance and auditing guidelines

Please read our Security Policy.

📊 Telemetry

Windows-MCP collects usage data to help improve the MCP server. No personal information, no tool arguments, no outputs are tracked.

To disable telemetry, add the following to your MCP client configuration:

{
  "mcpServers": {
    "windows-mcp": {
      "command": "uvx",
      "args": [
        "windows-mcp"
      ],
      "env": {
        "ANONYMIZED_TELEMETRY": "false"
      }
    }
  }
}

For detailed information on what data is collected and how it is handled, please refer to the Telemetry and Data Privacy section in our Security Policy.

📝 Limitations

• Selecting specific sections of the text in a paragraph, as the MCP is relying on a11y tree. (⌛ Working on it.)
• Type-Tool is meant for typing text, not programming in IDE because of it types program as a whole in a file. (⌛ Working on it.)
• This MCP server can't be used to play video games 🎮.

🪪 License

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

🙏 Acknowledgements

Windows-MCP makes use of several excellent open-source projects that power its Windows automation features:

• UIAutomation

• PyAutoGUI

Huge thanks to the maintainers and contributors of these libraries for their outstanding work and open-source spirit.

🤝Contributing

Contributions are welcome! Please see CONTRIBUTING for setup instructions and development guidelines.

Made with ❤️ by CursorTouch

Citation

@software{
  author       = {CursorTouch},
  title        = {Windows-MCP: Lightweight open-source project for integrating LLM agents with Windows},
  year         = {2024},
  publisher    = {GitHub},
  url={https://github.com/CursorTouch/Windows-MCP}
}