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.

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

Supported Operating Systems

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

Installation

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

🏁 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",
  "selectedAuthType": "oauth-personal",
//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 active apps and interactive, textual and scrollable elements along with screenshot of the desktop.
  • Screenshot-Tool: Capture a screenshot of the desktop.
  • 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

windows_mcp_server-0.1.2.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

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

windows_mcp_server-0.1.2-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file windows_mcp_server-0.1.2.tar.gz.

File metadata

  • Download URL: windows_mcp_server-0.1.2.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for windows_mcp_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a2fcb6323f49b9ed86c21d1048bc95a8adb7f72fbd31aef062a1ed8031e5bdc5
MD5 b583baa2289eebebb529fd56767ca505
BLAKE2b-256 6a2ee98883ad7e02d4410f643365d432e4252e659c3d23266b9c7075b89baa21

See more details on using hashes here.

File details

Details for the file windows_mcp_server-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for windows_mcp_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 066f6beff0f52a3ee167c2252621bad4418934a853ed2f26de9a5bc44ec4f6ff
MD5 e01c41caa2513ebb598e1686f9249a1f
BLAKE2b-256 76ab21ed46f9d0f1160b06259e7743c7b3d51d717b06133e6e1366b1f9d01389

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