windows-mcp 0.3.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. main.py +263 -0
  2. src/desktop/__init__.py +0 -0
  3. src/desktop/config.py +21 -0
  4. src/desktop/service.py +454 -0
  5. src/desktop/views.py +58 -0
  6. src/tree/__init__.py +0 -0
  7. src/tree/config.py +51 -0
  8. src/tree/service.py +444 -0
  9. src/tree/views.py +102 -0
  10. {windows_mcp-0.3.2.dist-info → windows_mcp-0.5.0.dist-info}/METADATA +387 -363
  11. windows_mcp-0.5.0.dist-info/RECORD +15 -0
  12. {windows_mcp-0.3.2.dist-info → windows_mcp-0.5.0.dist-info}/WHEEL +1 -2
  13. desktop/__init__.py +0 -247
  14. desktop/config.py +0 -11
  15. desktop/views.py +0 -40
  16. tree/__init__.py +0 -303
  17. tree/config.py +0 -17
  18. tree/views.py +0 -70
  19. windows_mcp-0.3.2.dist-info/RECORD +0 -13
  20. windows_mcp-0.3.2.dist-info/top_level.txt +0 -3
  21. /__init__.py → /src/__init__.py +0 -0
  22. {tree → src/tree}/utils.py +0 -0
  23. {windows_mcp-0.3.2.dist-info → windows_mcp-0.5.0.dist-info}/licenses/LICENSE.md +0 -0
{windows_mcp-0.3.2.dist-info → windows_mcp-0.5.0.dist-info}/METADATA RENAMED
@@ -1,363 +1,387 @@
1
- Metadata-Version: 2.4
2
- Name: windows-mcp
3
- Version: 0.3.2
4
- Summary: Lightweight MCP Server for interacting with Windows Operating System.
5
- Author-email: Jeomon George <jeogeoalukka@gmail.com>
6
- License: MIT License
7
-
8
- Copyright (c) 2025 JEOMON GEORGE
9
-
10
- Permission is hereby granted, free of charge, to any person obtaining a copy
11
- of this software and associated documentation files (the "Software"), to deal
12
- in the Software without restriction, including without limitation the rights
13
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
- copies of the Software, and to permit persons to whom the Software is
15
- furnished to do so, subject to the following conditions:
16
-
17
- The above copyright notice and this permission notice shall be included in all
18
- copies or substantial portions of the Software.
19
-
20
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
- SOFTWARE.
27
- Project-URL: homepage, https://github.com/CursorTouch
28
- Keywords: windows,mcp,ai,desktop,ai agent
29
- Requires-Python: >=3.13
30
- Description-Content-Type: text/markdown
31
- License-File: LICENSE.md
32
- Requires-Dist: click>=8.2.1
33
- Requires-Dist: fastmcp>=2.8.1
34
- Requires-Dist: fuzzywuzzy>=0.18.0
35
- Requires-Dist: humancursor>=1.1.5
36
- Requires-Dist: ipykernel>=6.30.0
37
- Requires-Dist: live-inspect>=0.1.1
38
- Requires-Dist: markdownify>=1.1.0
39
- Requires-Dist: pillow>=11.2.1
40
- Requires-Dist: psutil>=7.0.0
41
- Requires-Dist: pyautogui>=0.9.54
42
- Requires-Dist: pygetwindow>=0.0.9
43
- Requires-Dist: python-levenshtein>=0.27.1
44
- Requires-Dist: requests>=2.32.3
45
- Requires-Dist: uiautomation>=2.0.24
46
- Dynamic: license-file
47
-
48
- <div align="center">
49
- <h1>🪟 Windows-MCP</h1>
50
-
51
- <a href="https://github.com/CursorTouch/Windows-MCP/blob/main/LICENSE">
52
- <img src="https://img.shields.io/badge/license-MIT-green" alt="License">
53
- </a>
54
- <img src="https://img.shields.io/badge/python-3.13%2B-blue" alt="Python">
55
- <img src="https://img.shields.io/badge/platform-Windows%207–11-blue" alt="Platform: Windows 7 to 11">
56
- <img src="https://img.shields.io/github/last-commit/CursorTouch/Windows-MCP" alt="Last Commit">
57
- <br>
58
- <a href="https://x.com/CursorTouch">
59
- <img src="https://img.shields.io/badge/follow-%40CursorTouch-1DA1F2?logo=twitter&style=flat" alt="Follow on Twitter">
60
- </a>
61
- <a href="https://discord.com/invite/Aue9Yj2VzS">
62
- <img src="https://img.shields.io/badge/Join%20on-Discord-5865F2?logo=discord&logoColor=white&style=flat" alt="Join us on Discord">
63
- </a>
64
-
65
- </div>
66
-
67
- <br>
68
-
69
- **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.
70
-
71
- mcp-name: io.github.CursorTouch/Windows-MCP
72
-
73
- ## Updates
74
-
75
- - Try out 🪟[Windows-Use](https://github.com/CursorTouch/Windows-Use)!!, an agent built using Windows-MCP.
76
- - Windows-MCP is now featured as Desktop Extension in `Claude Desktop`.
77
-
78
- ### Supported Operating Systems
79
-
80
- - Windows 7
81
- - Windows 8, 8.1
82
- - Windows 10
83
- - Windows 11
84
-
85
- ## 🎥 Demos
86
-
87
- <https://github.com/user-attachments/assets/d0e7ed1d-6189-4de6-838a-5ef8e1cad54e>
88
-
89
- <https://github.com/user-attachments/assets/d2b372dc-8d00-4d71-9677-4c64f5987485>
90
-
91
- ## ✨ Key Features
92
-
93
- - **Seamless Windows Integration**
94
- Interacts natively with Windows UI elements, opens apps, controls windows, simulates user input, and more.
95
-
96
- - **Use Any LLM (Vision Optional)**
97
- 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.
98
-
99
- - **Rich Toolset for UI Automation**
100
- Includes tools for basic keyboard, mouse operation and capturing window/UI state.
101
-
102
- - **Lightweight & Open-Source**
103
- Minimal dependencies and easy setup with full source code available under MIT license.
104
-
105
- - **Customizable & Extendable**
106
- Easily adapt or extend tools to suit your unique automation or AI integration needs.
107
-
108
- - **Real-Time Interaction**
109
- 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.
110
-
111
- ## 🛠️Installation
112
-
113
- ### Prerequisites
114
-
115
- - Python 3.13+
116
- - UV (Package Manager) from Astra, install with `pip install uv` or `curl -LsSf https://astral.sh/uv/install.sh | sh`
117
- - `English` as the default language in Windows highly preferred or disable the `Launch-Tool` and `Switch-Tool` in the MCP Server for Windows with other languages.
118
-
119
- <details>
120
- <summary>Install in Claude Desktop</summary>
121
-
122
- 1. Install [Claude Desktop](https://claude.ai/download) and
123
-
124
- ```shell
125
- npm install -g @anthropic-ai/dxt
126
- ```
127
-
128
- 2. Clone the repository.
129
-
130
- ```shell
131
- git clone https://github.com/CursorTouch/Windows-MCP.git
132
-
133
- cd Windows-MCP
134
- ```
135
-
136
- 3. Build Desktop Extension `DXT`:
137
-
138
- ```shell
139
- npx @anthropic-ai/dxt pack
140
- ```
141
-
142
- 4. Open Claude Desktop:
143
-
144
- Go to `Settings->Extensions->Advance Settings->Install Extension` (locate the `.dxt` file)-> Install
145
-
146
- 5. Enjoy 🥳.
147
-
148
- 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.
149
- </details>
150
-
151
- <details>
152
- <summary>Install in Perplexity Desktop</summary>
153
-
154
- 1. Install [Perplexity Desktop](https://apps.microsoft.com/detail/xp8jnqfbqh6pvf):
155
-
156
- 2. Clone the repository.
157
-
158
- ```shell
159
- git clone https://github.com/CursorTouch/Windows-MCP.git
160
-
161
- cd Windows-MCP
162
- ```
163
-
164
- 3. Open Perplexity Desktop:
165
-
166
- Go to `Settings->Connectors->Add Connector->Advanced`
167
-
168
- 4. Enter the name as `Windows-MCP`, then paste the following JSON in the text area.
169
-
170
- ```json
171
- {
172
- "command": "uv",
173
- "args": [
174
- "--directory",
175
- "<path to the windows-mcp directory>",
176
- "run",
177
- "main.py"
178
- ]
179
- }
180
- ```
181
-
182
- 5. Click `Save` and Enjoy 🥳.
183
-
184
- 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.
185
- </details>
186
-
187
- <details>
188
- <summary> Install in Gemini CLI</summary>
189
-
190
- 1. Install Gemini CLI:
191
-
192
- ```shell
193
- npm install -g @google/gemini-cli
194
- ```
195
-
196
- 2. Clone the repository.
197
-
198
- ```shell
199
- git clone https://github.com/CursorTouch/Windows-MCP.git
200
-
201
- cd Windows-MCP
202
- ```
203
-
204
- 3. Navigate to `%USERPROFILE%/.gemini` in File Explorer and open `settings.json`.
205
-
206
- 4. Add the `windows-mcp` config in the `settings.json` and save it.
207
-
208
- ```json
209
- {
210
- "theme": "Default",
211
- ...
212
- //MCP Server Config
213
- "mcpServers": {
214
- "windows-mcp": {
215
- "command": "uv",
216
- "args": [
217
- "--directory",
218
- "<path to the windows-mcp directory>",
219
- "run",
220
- "main.py"
221
- ]
222
- }
223
- }
224
- }
225
- ```
226
-
227
- 5. Rerun Gemini CLI in terminal. Enjoy 🥳
228
- </details>
229
-
230
- <details>
231
- <summary>Install in Qwen Code</summary>
232
- 1. Install Qwen Code:
233
-
234
- ```shell
235
- npm install -g @qwen-code/qwen-code@latest
236
- ```
237
- 2. Clone the repository.
238
-
239
- ```shell
240
- git clone https://github.com/CursorTouch/Windows-MCP.git
241
-
242
- cd Windows-MCP
243
- ```
244
-
245
- 3. Navigate to `%USERPROFILE%/.qwen/settings.json`.
246
-
247
- 4. Add the `windows-mcp` config in the `settings.json` and save it.
248
-
249
- ```json
250
- {
251
- //MCP Server Config
252
- "mcpServers": {
253
- "windows-mcp": {
254
- "command": "uv",
255
- "args": [
256
- "--directory",
257
- "<path to the windows-mcp directory>",
258
- "run",
259
- "main.py"
260
- ]
261
- }
262
- }
263
- }
264
- ```
265
-
266
- 5. Rerun Qwen Code in terminal. Enjoy 🥳
267
- </details>
268
-
269
- <details>
270
- <summary>Install in Codex CLI</summary>
271
- 1. Install Codex CLI:
272
-
273
- ```shell
274
- npm install -g @openai/codex
275
- ```
276
- 2. Clone the repository.
277
-
278
- ```shell
279
- git clone https://github.com/CursorTouch/Windows-MCP.git
280
-
281
- cd Windows-MCP
282
- ```
283
- 3. Navigate to `%USERPROFILE%/.codex/config.toml`.
284
-
285
- 4. Add the `windows-mcp` config in the `config.toml` and save it.
286
-
287
- ```toml
288
- [mcp_servers.windows-mcp]
289
- command="uv"
290
- args=[
291
- "--directory",
292
- "<path to the windows-mcp directory>",
293
- "run",
294
- "main.py"
295
- ]
296
- ```
297
-
298
- 5. Rerun Codex CLI in terminal. Enjoy 🥳
299
- </details>
300
-
301
- ---
302
-
303
- ## 🔨MCP Tools
304
-
305
- MCP Client can access the following tools to interact with Windows:
306
-
307
- - `Click-Tool`: Click on the screen at the given coordinates.
308
- - `Type-Tool`: Type text on an element (optionally clears existing text).
309
- - `Clipboard-Tool`: Copy or paste using the system clipboard.
310
- - `Scroll-Tool`: Scroll vertically or horizontally on the window or specific regions.
311
- - `Drag-Tool`: Drag from one point to another.
312
- - `Move-Tool`: Move mouse pointer.
313
- - `Shortcut-Tool`: Press keyboard shortcuts (`Ctrl+c`, `Alt+Tab`, etc).
314
- - `Key-Tool`: Press a single key.
315
- - `Wait-Tool`: Pause for a defined duration.
316
- - `State-Tool`: Combined snapshot of default language, browser, active apps and interactive, textual and scrollable elements along with screenshot of the desktop.
317
- - `Resize-Tool`: Used to change the window size or location of an app.
318
- - `Launch-Tool`: To launch an application from the start menu.
319
- - `Shell-Tool`: To execute PowerShell commands.
320
- - `Scrape-Tool`: To scrape the entire webpage for information.
321
-
322
- ## 🤝 Connect with Us
323
- Stay updated and join our community:
324
-
325
- - 📢 Follow us on [X](https://x.com/CursorTouch) for the latest news and updates
326
-
327
- - 💬 Join our [Discord Community](https://discord.com/invite/Aue9Yj2VzS)
328
-
329
- ## Star History
330
-
331
- [![Star History Chart](https://api.star-history.com/svg?repos=CursorTouch/Windows-MCP&type=Date)](https://www.star-history.com/#CursorTouch/Windows-MCP&Date)
332
-
333
- ## ⚠️Caution
334
-
335
- 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.
336
-
337
- ## 📝 Limitations
338
-
339
- - Selecting specific sections of the text in a paragraph, as the MCP is relying on a11y tree. (⌛ Working on it.)
340
- - `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.)
341
- - This MCP server can't be used to play video games.
342
-
343
- ## 🪪License
344
-
345
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
346
-
347
- ## 🤝Contributing
348
-
349
- Contributions are welcome! Please see [CONTRIBUTING](CONTRIBUTING) for setup instructions and development guidelines.
350
-
351
- Made with ❤️ by [CursorTouch](https://github.com/CursorTouch)
352
-
353
- ## Citation
354
-
355
- ```bibtex
356
- @software{
357
- author = {CursorTouch},
358
- title = {Windows-MCP: Lightweight open-source project for integrating LLM agents with Windows},
359
- year = {2024},
360
- publisher = {GitHub},
361
- url={https://github.com/CursorTouch/Windows-MCP}
362
- }
363
- ```
1
+ Metadata-Version: 2.4
2
+ Name: windows-mcp
3
+ Version: 0.5.0
4
+ Summary: Lightweight MCP Server for interacting with Windows Operating System.
5
+ Project-URL: homepage, https://github.com/CursorTouch
6
+ Author-email: Jeomon George <jeogeoalukka@gmail.com>
7
+ License: MIT License
8
+
9
+ Copyright (c) 2025 JEOMON GEORGE
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+ License-File: LICENSE.md
29
+ Keywords: ai,ai agent,desktop,mcp,windows
30
+ Requires-Python: >=3.13
31
+ Requires-Dist: click>=8.2.1
32
+ Requires-Dist: fastmcp>=2.8.1
33
+ Requires-Dist: fuzzywuzzy>=0.18.0
34
+ Requires-Dist: humancursor>=1.1.5
35
+ Requires-Dist: ipykernel>=6.30.0
36
+ Requires-Dist: live-inspect>=0.1.1
37
+ Requires-Dist: markdownify>=1.1.0
38
+ Requires-Dist: pdfplumber>=0.11.7
39
+ Requires-Dist: pillow>=11.2.1
40
+ Requires-Dist: psutil>=7.0.0
41
+ Requires-Dist: pyautogui>=0.9.54
42
+ Requires-Dist: pygetwindow>=0.0.9
43
+ Requires-Dist: python-levenshtein>=0.27.1
44
+ Requires-Dist: pywinauto>=0.6.9
45
+ Requires-Dist: requests>=2.32.3
46
+ Requires-Dist: tabulate>=0.9.0
47
+ Requires-Dist: uiautomation>=2.0.24
48
+ Description-Content-Type: text/markdown
49
+
50
+ [![MseeP.ai Security Assessment Badge](https://mseep.net/pr/cursortouch-windows-mcp-badge.png)](https://mseep.ai/app/cursortouch-windows-mcp)
51
+
52
+ <div align="center">
53
+ <h1>🪟 Windows-MCP</h1>
54
+
55
+ <a href="https://github.com/CursorTouch/Windows-MCP/blob/main/LICENSE">
56
+ <img src="https://img.shields.io/badge/license-MIT-green" alt="License">
57
+ </a>
58
+ <img src="https://img.shields.io/badge/python-3.13%2B-blue" alt="Python">
59
+ <img src="https://img.shields.io/badge/platform-Windows%207–11-blue" alt="Platform: Windows 7 to 11">
60
+ <img src="https://img.shields.io/github/last-commit/CursorTouch/Windows-MCP" alt="Last Commit">
61
+ <br>
62
+ <a href="https://x.com/CursorTouch">
63
+ <img src="https://img.shields.io/badge/follow-%40CursorTouch-1DA1F2?logo=twitter&style=flat" alt="Follow on Twitter">
64
+ </a>
65
+ <a href="https://discord.com/invite/Aue9Yj2VzS">
66
+ <img src="https://img.shields.io/badge/Join%20on-Discord-5865F2?logo=discord&logoColor=white&style=flat" alt="Join us on Discord">
67
+ </a>
68
+
69
+ </div>
70
+
71
+ <br>
72
+
73
+ **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.
74
+
75
+ mcp-name: io.github.CursorTouch/Windows-MCP
76
+
77
+ ## Updates
78
+
79
+ - Windows-MCP is added to [MCP Registry](https://github.com/modelcontextprotocol/registry)
80
+ - Try out 🪟[Windows-Use](https://github.com/CursorTouch/Windows-Use)!!, an agent built using Windows-MCP.
81
+ - Windows-MCP is now featured as Desktop Extension in `Claude Desktop`.
82
+
83
+ ### Supported Operating Systems
84
+
85
+ - Windows 7
86
+ - Windows 8, 8.1
87
+ - Windows 10
88
+ - Windows 11
89
+
90
+ ## 🎥 Demos
91
+
92
+ <https://github.com/user-attachments/assets/d0e7ed1d-6189-4de6-838a-5ef8e1cad54e>
93
+
94
+ <https://github.com/user-attachments/assets/d2b372dc-8d00-4d71-9677-4c64f5987485>
95
+
96
+ ## ✨ Key Features
97
+
98
+ - **Seamless Windows Integration**
99
+ Interacts natively with Windows UI elements, opens apps, controls windows, simulates user input, and more.
100
+
101
+ - **Use Any LLM (Vision Optional)**
102
+ 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.
103
+
104
+ - **Rich Toolset for UI Automation**
105
+ Includes tools for basic keyboard, mouse operation and capturing window/UI state.
106
+
107
+ - **Lightweight & Open-Source**
108
+ Minimal dependencies and easy setup with full source code available under MIT license.
109
+
110
+ - **Customizable & Extendable**
111
+ Easily adapt or extend tools to suit your unique automation or AI integration needs.
112
+
113
+ - **Real-Time Interaction**
114
+ 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.
115
+
116
+ ## 🛠️Installation
117
+
118
+ ### Prerequisites
119
+
120
+ - Python 3.13+
121
+ - UV (Package Manager) from Astra, install with `pip install uv` or `curl -LsSf https://astral.sh/uv/install.sh | sh`
122
+ - `English` as the default language in Windows highly preferred or disable the `App-Tool` in the MCP Server for Windows with other languages.
123
+
124
+ <details>
125
+ <summary>Install in Claude Desktop</summary>
126
+
127
+ 1. Install [Claude Desktop](https://claude.ai/download) and
128
+
129
+ ```shell
130
+ npm install -g @anthropic-ai/mcpb
131
+ ```
132
+
133
+ 2. Clone the repository.
134
+
135
+ ```shell
136
+ git clone https://github.com/CursorTouch/Windows-MCP.git
137
+
138
+ cd Windows-MCP
139
+ ```
140
+
141
+ 3. Build Desktop Extension `MCPB`:
142
+
143
+ ```shell
144
+ npx @anthropic-ai/mcpb pack
145
+ ```
146
+
147
+ 4. Open Claude Desktop:
148
+
149
+ Go to `Settings->Extensions->Advance Settings->Install Extension` (locate the `.mcpb` file)-> Install
150
+
151
+ 5. Enjoy 🥳.
152
+
153
+ 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.
154
+ </details>
155
+
156
+ <details>
157
+ <summary>Install in Perplexity Desktop</summary>
158
+
159
+ 1. Install [Perplexity Desktop](https://apps.microsoft.com/detail/xp8jnqfbqh6pvf):
160
+
161
+ 2. Clone the repository.
162
+
163
+ ```shell
164
+ git clone https://github.com/CursorTouch/Windows-MCP.git
165
+
166
+ cd Windows-MCP
167
+ ```
168
+
169
+ 3. Open Perplexity Desktop:
170
+
171
+ Go to `Settings->Connectors->Add Connector->Advanced`
172
+
173
+ 4. Enter the name as `Windows-MCP`, then paste the following JSON in the text area.
174
+
175
+ ```json
176
+ {
177
+ "command": "uv",
178
+ "args": [
179
+ "--directory",
180
+ "<path to the windows-mcp directory>",
181
+ "run",
182
+ "main.py"
183
+ ]
184
+ }
185
+ ```
186
+
187
+ 5. Click `Save` and Enjoy 🥳.
188
+
189
+ 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.
190
+ </details>
191
+
192
+ <details>
193
+ <summary> Install in Gemini CLI</summary>
194
+
195
+ 1. Install Gemini CLI:
196
+
197
+ ```shell
198
+ npm install -g @google/gemini-cli
199
+ ```
200
+
201
+ 2. Clone the repository.
202
+
203
+ ```shell
204
+ git clone https://github.com/CursorTouch/Windows-MCP.git
205
+
206
+ cd Windows-MCP
207
+ ```
208
+
209
+ 3. Navigate to `%USERPROFILE%/.gemini` in File Explorer and open `settings.json`.
210
+
211
+ 4. Add the `windows-mcp` config in the `settings.json` and save it.
212
+
213
+ ```json
214
+ {
215
+ "theme": "Default",
216
+ ...
217
+ //MCP Server Config
218
+ "mcpServers": {
219
+ "windows-mcp": {
220
+ "command": "uv",
221
+ "args": [
222
+ "--directory",
223
+ "<path to the windows-mcp directory>",
224
+ "run",
225
+ "main.py"
226
+ ]
227
+ }
228
+ }
229
+ }
230
+ ```
231
+
232
+ 5. Rerun Gemini CLI in terminal. Enjoy 🥳
233
+ </details>
234
+
235
+ <details>
236
+ <summary>Install in Qwen Code</summary>
237
+ 1. Install Qwen Code:
238
+
239
+ ```shell
240
+ npm install -g @qwen-code/qwen-code@latest
241
+ ```
242
+ 2. Clone the repository.
243
+
244
+ ```shell
245
+ git clone https://github.com/CursorTouch/Windows-MCP.git
246
+
247
+ cd Windows-MCP
248
+ ```
249
+
250
+ 3. Navigate to `%USERPROFILE%/.qwen/settings.json`.
251
+
252
+ 4. Add the `windows-mcp` config in the `settings.json` and save it.
253
+
254
+ ```json
255
+ {
256
+ //MCP Server Config
257
+ "mcpServers": {
258
+ "windows-mcp": {
259
+ "command": "uv",
260
+ "args": [
261
+ "--directory",
262
+ "<path to the windows-mcp directory>",
263
+ "run",
264
+ "main.py"
265
+ ]
266
+ }
267
+ }
268
+ }
269
+ ```
270
+
271
+ 5. Rerun Qwen Code in terminal. Enjoy 🥳
272
+ </details>
273
+
274
+ <details>
275
+ <summary>Install in Codex CLI</summary>
276
+ 1. Install Codex CLI:
277
+
278
+ ```shell
279
+ npm install -g @openai/codex
280
+ ```
281
+ 2. Clone the repository.
282
+
283
+ ```shell
284
+ git clone https://github.com/CursorTouch/Windows-MCP.git
285
+
286
+ cd Windows-MCP
287
+ ```
288
+ 3. Navigate to `%USERPROFILE%/.codex/config.toml`.
289
+
290
+ 4. Add the `windows-mcp` config in the `config.toml` and save it.
291
+
292
+ ```toml
293
+ [mcp_servers.windows-mcp]
294
+ command="uv"
295
+ args=[
296
+ "--directory",
297
+ "<path to the windows-mcp directory>",
298
+ "run",
299
+ "main.py"
300
+ ]
301
+ ```
302
+
303
+ 5. Rerun Codex CLI in terminal. Enjoy 🥳
304
+ </details>
305
+
306
+ ---
307
+
308
+ ## 🔨MCP Tools
309
+
310
+ MCP Client can access the following tools to interact with Windows:
311
+
312
+ - `Click-Tool`: Click on the screen at the given coordinates.
313
+ - `Type-Tool`: Type text on an element (optionally clears existing text).
314
+ - `Scroll-Tool`: Scroll vertically or horizontally on the window or specific regions.
315
+ - `Drag-Tool`: Drag from one point to another.
316
+ - `Move-Tool`: Move mouse pointer.
317
+ - `Shortcut-Tool`: Press keyboard shortcuts (`Ctrl+c`, `Alt+Tab`, etc).
318
+ - `Wait-Tool`: Pause for a defined duration.
319
+ - `State-Tool`: Combined snapshot of default language, browser, active apps and interactive, textual and scrollable elements along with screenshot of the desktop..
320
+ - `App-Tool`: To launch an application from the start menu, resize or move the window and switch between apps.
321
+ - `Shell-Tool`: To execute PowerShell commands.
322
+ - `Scrape-Tool`: To scrape the entire webpage for information.
323
+
324
+ ## 🤝 Connect with Us
325
+ Stay updated and join our community:
326
+
327
+ - 📢 Follow us on [X](https://x.com/CursorTouch) for the latest news and updates
328
+
329
+ - 💬 Join our [Discord Community](https://discord.com/invite/Aue9Yj2VzS)
330
+
331
+ ## Star History
332
+
333
+ [![Star History Chart](https://api.star-history.com/svg?repos=CursorTouch/Windows-MCP&type=Date)](https://www.star-history.com/#CursorTouch/Windows-MCP&Date)
334
+
335
+ ## ⚠️Caution
336
+
337
+ 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.
338
+
339
+ ## 🔒 Security
340
+
341
+ **Important**: Windows-MCP operates with full system access and can perform irreversible operations. Please review our comprehensive security guidelines before deployment.
342
+
343
+ For detailed security information, including:
344
+ - Tool-specific risk assessments
345
+ - Deployment recommendations
346
+ - Vulnerability reporting procedures
347
+ - Compliance and auditing guidelines
348
+
349
+ Please read our [Security Policy](SECURITY.md).
350
+
351
+ ## 📝 Limitations
352
+
353
+ - Selecting specific sections of the text in a paragraph, as the MCP is relying on a11y tree. (⌛ Working on it.)
354
+ - `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.)
355
+ - This MCP server can't be used to play video games 🎮.
356
+
357
+ ## 🪪 License
358
+
359
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
360
+
361
+ ## 🙏 Acknowledgements
362
+
363
+ Windows-MCP makes use of several excellent open-source projects that power its Windows automation features:
364
+
365
+ - [UIAutomation](https://github.com/yinkaisheng/Python-UIAutomation-for-Windows)
366
+
367
+ - [PyAutoGUI](https://github.com/asweigart/pyautogui)
368
+
369
+ Huge thanks to the maintainers and contributors of these libraries for their outstanding work and open-source spirit.
370
+
371
+ ## 🤝Contributing
372
+
373
+ Contributions are welcome! Please see [CONTRIBUTING](CONTRIBUTING) for setup instructions and development guidelines.
374
+
375
+ Made with ❤️ by [CursorTouch](https://github.com/CursorTouch)
376
+
377
+ ## Citation
378
+
379
+ ```bibtex
380
+ @software{
381
+ author = {CursorTouch},
382
+ title = {Windows-MCP: Lightweight open-source project for integrating LLM agents with Windows},
383
+ year = {2024},
384
+ publisher = {GitHub},
385
+ url={https://github.com/CursorTouch/Windows-MCP}
386
+ }
387
+ ```