Skip to main content

Lightweight MCP Server for interacting with Windows Operating System.

Project description

🪟 Windows-MCP

License Python Platform: Windows 7 to 11 Last Commit
Follow on Twitter Join us on Discord

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.

Updates

  • Try out 🪟Windows-Use!!, an agent built using Windows-MCP.
  • Windows-MCP is now featured as Desktop Extension in Claude Desktop.

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.7 to 2.5 secs, and may slightly vary based on the number of active applications and system load, also the inferencing speed of the llm.

Prerequisites

  • Python 3.13+
  • Anthropic Claude Desktop app or other MCP Clients
  • UV (Package Manager) from Astra, install with pip install uv
  • DXT (Desktop Extension) from Antropic, install with npm install -g @anthropic-ai/dxt
  • English as the default language in Windows or disable the Launch-Tool and Resize-Tool in the MCP Server for Windows with other languages.

🏁 Getting Started

Gemini CLI

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

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

{
  "theme": "Default",
  ...
//MCP Server Config
  "mcpServers": {
    "windows-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "<path to the windows-mcp directory>",
        "run",
        "main.py"
      ]
    }
  }
}
  1. Rerun Gemini CLI in terminal. Enjoy 🥳

Claude Desktop

  1. Clone the repository.
git clone https://github.com/CursorTouch/Windows-MCP.git
cd Windows-MCP
  1. Build Desktop Extension DXT:
npx @anthropic-ai/dxt pack
  1. Open Claude Desktop:

Go to Claude Desktop: Settings->Extensions->Install Extension (locate the .dxt file)-> Install

Finally Enjoy 🥳.

For additional Claude Desktop integration troubleshooting, see the MCP documentation. The documentation includes helpful tips for checking logs and resolving common issues.


🛠️MCP Tools

Claude can access the following tools to interact with Windows:

  • Click-Tool: Click on the screen at the given coordinates.
  • Type-Tool: Type text on an element (optionally clears existing text).
  • Clipboard-Tool: Copy or paste using the system clipboard.
  • Scroll-Tool: Scroll vertically or horizontally on the window or specific regions.
  • Drag-Tool: Drag from one point to another.
  • Move-Tool: Move mouse pointer.
  • Shortcut-Tool: Press keyboard shortcuts (Ctrl+c, Alt+Tab, etc).
  • Key-Tool: Press a single key.
  • Wait-Tool: Pause for a defined duration.
  • State-Tool: Combined snapshot of default language, browser, active apps and interactive, textual and scrollable elements along with screenshot of the desktop.
  • Resize-Tool: Used to change the window size or location of an app.
  • Launch-Tool: To launch an application from the start menu.
  • Shell-Tool: To execute PowerShell commands.
  • Scrape-Tool: To scrape the entire webpage for information.

Star History

Star History Chart

⚠️Caution

This MCP interacts directly with your Windows operating system to perform actions. Use with caution and avoid deploying it in environments where such risks cannot be tolerated.

📝 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.)

🪪License

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

🤝Contributing

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

Made with ❤️ by Jeomon George

Citation

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_windows_mcp-0.1.1.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_windows_mcp-0.1.1-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_windows_mcp-0.1.1.tar.gz.

File metadata

File hashes

Hashes for iflow_mcp_windows_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 117835032e0bb105a216e3a7c3251e713e7698cccb49492d629073ce7437e7ee
MD5 ded96fc2299192deb5b19439a84b04da
BLAKE2b-256 4c9baea70d1b24192224c6045af61f5efeb10f70301441b4f51d8d2fcd96ba4c

See more details on using hashes here.

File details

Details for the file iflow_mcp_windows_mcp-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_windows_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c94375b0ebbbde16e2af6ee29958f1306dfc9bd05543c490a5d9a8f1cbe81e8
MD5 33f7e247d16e7f076cee348c62a1a6a0
BLAKE2b-256 7dc9f42b35c091ef932d803c9411df1b3c4881889957983f500e185e7fdc643c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page