windows-mcp 0.5.2__py3-none-any.whl

windows_mcp-0.5.2.dist-info/METADATA

@@ -0,0 +1,388 @@
+Metadata-Version: 2.4
+Name: windows-mcp
+Version: 0.5.2
+Summary: Lightweight MCP Server for interacting with Windows Operating System.
+Project-URL: homepage, https://github.com/CursorTouch
+Author-email: Jeomon George <jeogeoalukka@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 JEOMON GEORGE
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE.md
+Keywords: ai,ai agent,desktop,mcp,windows
+Requires-Python: >=3.13
+Requires-Dist: click>=8.2.1
+Requires-Dist: fastmcp>=2.8.1
+Requires-Dist: fuzzywuzzy>=0.18.0
+Requires-Dist: humancursor>=1.1.5
+Requires-Dist: ipykernel>=6.30.0
+Requires-Dist: live-inspect>=0.1.1
+Requires-Dist: markdownify>=1.1.0
+Requires-Dist: pdfplumber>=0.11.7
+Requires-Dist: pillow>=11.2.1
+Requires-Dist: psutil>=7.0.0
+Requires-Dist: pyautogui>=0.9.54
+Requires-Dist: pygetwindow>=0.0.9
+Requires-Dist: python-levenshtein>=0.27.1
+Requires-Dist: pywinauto>=0.6.9
+Requires-Dist: requests>=2.32.3
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: twine>=6.2.0
+Requires-Dist: uiautomation>=2.0.24
+Description-Content-Type: text/markdown
+
+[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/cursortouch-windows-mcp-badge.png)](https://mseep.ai/app/cursortouch-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
+
+- Windows-MCP is added to [MCP Registry](https://github.com/modelcontextprotocol/registry)
+- Try out 🪟[Windows-Use](https://github.com/CursorTouch/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.
+
+## 🛠️Installation
+
+### 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 highly preferred or disable the `App-Tool` in the MCP Server for Windows with other languages.
+
+<details>
+  <summary>Install in Claude Desktop</summary>
+
+  1. Install [Claude Desktop](https://claude.ai/download) and
+
+```shell
+npm install -g @anthropic-ai/mcpb
+```
+
+  2. Clone the repository.
+
+```shell
+git clone https://github.com/CursorTouch/Windows-MCP.git
+
+cd Windows-MCP
+```
+
+  3. Build Desktop Extension `MCPB`:
+
+```shell
+npx @anthropic-ai/mcpb pack
+```
+
+  4. Open Claude Desktop:
+
+Go to `Settings->Extensions->Advance Settings->Install Extension` (locate the `.mcpb` file)-> Install
+
+  5. Enjoy 🥳.
+
+For additional Claude Desktop integration troubleshooting, see the [MCP documentation](https://modelcontextprotocol.io/quickstart/server#claude-for-desktop-integration-issues). The documentation includes helpful tips for checking logs and resolving common issues.
+</details>
+
+<details>
+  <summary>Install in Perplexity Desktop</summary>
+
+  1. Install [Perplexity Desktop](https://apps.microsoft.com/detail/xp8jnqfbqh6pvf):
+
+  2. Clone the repository.
+
+```shell
+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.
+
+```json
+{
+  "command": "uv",
+  "args": [
+    "--directory",
+    "<path to the windows-mcp directory>",
+    "run",
+    "main.py"
+  ]
+}
+```
+
+5. Click `Save` and Enjoy 🥳.
+
+For additional Claude Desktop integration troubleshooting, see the [Perplexity MCP Support](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity). The documentation includes helpful tips for checking logs and resolving common issues.
+</details>
+
+<details>
+  <summary> Install in Gemini CLI</summary>
+
+  1. Install Gemini CLI:
+
+```shell
+npm install -g @google/gemini-cli
+```
+
+  2. Clone the repository.
+
+```shell
+git clone https://github.com/CursorTouch/Windows-MCP.git
+
+cd Windows-MCP
+```
+
+  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.
+
+```json
+{
+  "theme": "Default",
+  ...
+//MCP Server Config
+  "mcpServers": {
+    "windows-mcp": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "<path to the windows-mcp directory>",
+        "run",
+        "main.py"
+      ]
+    }
+  }
+}
+```
+
+  5. Rerun Gemini CLI in terminal. Enjoy 🥳
+</details>
+
+<details>
+  <summary>Install in Qwen Code</summary>
+  1. Install Qwen Code:
+
+```shell
+npm install -g @qwen-code/qwen-code@latest
+```
+  2. Clone the repository.
+
+```shell
+git clone https://github.com/CursorTouch/Windows-MCP.git
+
+cd Windows-MCP
+```
+
+  3. Navigate to `%USERPROFILE%/.qwen/settings.json`.
+
+  4. Add the `windows-mcp` config in the `settings.json` and save it.
+
+```json
+{
+//MCP Server Config
+  "mcpServers": {
+    "windows-mcp": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "<path to the windows-mcp directory>",
+        "run",
+        "main.py"
+      ]
+    }
+  }
+}
+```
+
+  5. Rerun Qwen Code in terminal. Enjoy 🥳
+</details>
+
+<details>
+  <summary>Install in Codex CLI</summary>
+  1. Install Codex CLI:
+
+```shell
+npm install -g @openai/codex
+```
+  2. Clone the repository.
+
+```shell
+git clone https://github.com/CursorTouch/Windows-MCP.git
+
+cd Windows-MCP
+```
+  3. Navigate to `%USERPROFILE%/.codex/config.toml`.
+
+  4. Add the `windows-mcp` config in the `config.toml` and save it.
+
+```toml
+[mcp_servers.windows-mcp]
+command="uv"
+args=[
+  "--directory",
+  "<path to the windows-mcp directory>",
+  "run",
+  "main.py"
+]
+```
+
+  5. Rerun Codex CLI in terminal. Enjoy 🥳
+</details>
+
+---
+
+## 🔨MCP Tools
+
+MCP Client 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).
+- `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).
+- `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..
+- `App-Tool`: To launch an application from the start menu, resize or move the window and switch between apps.
+- `Shell-Tool`: To execute PowerShell commands.
+- `Scrape-Tool`: To scrape the entire webpage for information.
+
+## 🤝 Connect with Us
+Stay updated and join our community:
+
+- 📢 Follow us on [X](https://x.com/CursorTouch) for the latest news and updates
+
+- 💬 Join our [Discord Community](https://discord.com/invite/Aue9Yj2VzS)
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=CursorTouch/Windows-MCP&type=Date)](https://www.star-history.com/#CursorTouch/Windows-MCP&Date)
+
+## ⚠️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.
+
+## 🔒 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](SECURITY.md).
+
+## 📝 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](LICENSE) file for details.
+
+## 🙏 Acknowledgements
+
+Windows-MCP makes use of several excellent open-source projects that power its Windows automation features:
+
+- [UIAutomation](https://github.com/yinkaisheng/Python-UIAutomation-for-Windows)
+
+- [PyAutoGUI](https://github.com/asweigart/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](CONTRIBUTING) for setup instructions and development guidelines.
+
+Made with ❤️ by [CursorTouch](https://github.com/CursorTouch)
+
+## Citation
+
+```bibtex
+@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}
+}
+```

windows_mcp-0.5.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+main.py,sha256=Bg_iHXmNxIE1uUioBf0OMEolNkYisGCManA9tpLzv5w,9630
+src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/desktop/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/desktop/config.py,sha256=7rAb64pmC275PpNRXVOyOf0Psu089AOosRC8T5kVGWA,384
+src/desktop/service.py,sha256=yzB1SFS2h1fSxMHsYOwa0mJLTOSdIyDWAmfex-DX3dM,18295
+src/desktop/views.py,sha256=vDPPUfD8vNkCS_4-vc-bA4tqG-klqDtznypAQJCN4TA,1515
+src/tree/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/tree/config.py,sha256=k-Mjo_yIn0d1AzcEW_bxiaXyBFxBZZSyy7hCNQ3XVp0,1010
+src/tree/service.py,sha256=5RIaabVBwmdKSsmaxTV8UW2f6VFwmyeJTvNWhoudTeM,21864
+src/tree/utils.py,sha256=6hbxdIQPrAY-I3jcHsRqodHlxboTQj2GnLA71bf1lqY,911
+src/tree/views.py,sha256=DVgB8x7Mg9NaZL5xZzhOAzgLuwFw6DWFTLK5hIxWsvk,3232
+windows_mcp-0.5.2.dist-info/METADATA,sha256=Vp5YyAirr8qtj7SMekByPhW8Fx9PbpamHVFsD2X1xlY,12380
+windows_mcp-0.5.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+windows_mcp-0.5.2.dist-info/entry_points.txt,sha256=NMSKckn68nbiSSmQ9eFiP8cmPrDSR_vzeYE-Zqmhn_o,42
+windows_mcp-0.5.2.dist-info/licenses/LICENSE.md,sha256=U1UM4Xi_IX-jHnHjGT0rETNia-Ck8gd92iSQMqQ6a8Y,1089
+windows_mcp-0.5.2.dist-info/RECORD,,

windows_mcp-0.5.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

windows_mcp-0.5.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+windows-mcp = main:main

windows_mcp-0.5.2.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 JEOMON GEORGE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.