Skip to content
Back to search

Windows-MCP.Net

A .NET-based Windows desktop automation MCP (Model Context Protocol) server that provides AI assistants with the ability to interact with the Windows desktop environment.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/shuyu-labs--windows-mcp-net/badge.svg)](/listings/shuyu-labs--windows-mcp-net)

HTML

<a href="/listings/shuyu-labs--windows-mcp-net"><img src="/api/listings/shuyu-labs--windows-mcp-net/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 487 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Windows MCP.Net
  2. [English](README.en.md) | **中文**
  3. 一个基于 .NET 的 Windows 桌面自动化 MCP (Model Context Protocol) 服务器,为 AI 助手提供与 Windows 桌面环境交互的能力。
  4. ## 📋 目录
  5. - [功能特性](#-功能特性)
  6. - [使用场景](#-使用场景)
  7. - [演示截图](#-演示截图)
  8. - [技术栈](#️-技术栈)
  9. - [API文档](#-api-文档)
  10. - [项目结构](#️-项目结构)
  11. - [功能扩展建议](#-功能扩展建议)
  12. - [配置](#-配置)
  13. - [贡献指南](#-贡献指南)
  14. - [更新日志](#-更新日志)
  15. - [支持](#-支持)
  16. ## 🚀 快速开始
  17. ### 前置要求
  18. - Windows 操作系统
  19. - .NET 10.0 Runtime 或更高版本
  20. **重要提示**: 本项目需要 .NET 10 才能运行,请先确保你的本地安装了 .NET 10。如果尚未安装,请访问 [.NET 10 下载页面](https://dotnet.microsoft.com/zh-cn/download/dotnet/10.0) 进行下载和安装。
  21. ### 1. MCP 客户端配置
  22. 在您的 MCP 客户端配置中添加以下配置:
  23. #### 使用全局安装的工具(推荐)
  24. ```json
  25. {
  26. "mcpServers": {
  27. "WindowsMCP.Net": {
  28. "type": "stdio",
  29. "command": "dnx",
  30. "args": ["WindowsMCP.Net@", "--yes"],
  31. "env": {}
  32. }
  33. }
  34. }
  35. ```
  36. #### 使用项目源码直接运行(开发模式)
  37. **方式一:工作区配置**
  38. 在项目根目录创建 `.vscode/mcp.json` 文件:
  39. ```json
  40. {
  41. "mcpServers": {
  42. "Windows-MCP.Net-Dev": {
  43. "type": "stdio",
  44. "command": "dotnet",
  45. "args": ["run", "--project", "src/Windows-MCP.Net.csproj"],
  46. "cwd": "${workspaceFolder}",
  47. "env": {}
  48. }
  49. }
  50. }
  51. ```
  52. **方式二:用户配置**
  53. 通过VS Code命令面板运行 `MCP: Open User Configuration`,添加:
  54. ```json
  55. {
  56. "mcpServers": {
  57. "Windows-MCP.Net-Local": {
  58. "type": "stdio",
  59. "command": "dotnet",
  60. "args": ["run", "--project", "src/Windows-MCP.Net.csproj"],
  61. "env": {}
  62. }
  63. }
  64. }
  65. ```
  66. > **注意**: 使用项目源码方式便于开发调试,修改代码后无需重新安装即可生效。VS Code 1.102+ 版本支持MCP服务器的自动发现和管理。
  67. ### 2. 安装和运行
  68. #### 方式一:全局安装(推荐)
  69. ```bash
  70. dotnet tool install --global WindowsMCP.Net
  71. ```
  72. #### 方式二:从源码运行
  73. ```bash
  74. # 克隆仓库
  75. git clone https://github.com/AIDotNet/Windows-MCP.Net.git
  76. cd Windows-MCP.Net
  77. # 构建项目
  78. dotnet build
  79. # 运行项目
  80. dotnet run --project src/Windows-MCP.Net.csproj
  81. ```
  82. ### 3. 开始使用
  83. 配置完成后,重启您的MCP客户端,即可开始使用Windows桌面自动化功能!
  84. ## 🚀 功能特性
  85. ### 核心功能
  86. - **应用程序启动**: 通过名称从开始菜单启动应用程序
  87. - **PowerShell 集成**: 执行 PowerShell 命令并返回结果
  88. - **桌面状态捕获**: 获取当前桌面状态,包括活动应用、UI 元素等
  89. - **剪贴板操作**: 复制和粘贴文本内容
  90. - **鼠标操作**: 点击、拖拽、移动鼠标光标
  91. - **键盘操作**: 文本输入、按键操作、快捷键组合
  92. - **窗口管理**: 调整窗口大小、位置,切换应用程序
  93. - **滚动操作**: 在指定坐标进行滚动操作
  94. - **网页抓取**: 获取网页内容并转换为 Markdown 格式
  95. - **浏览器操作**: 在默认浏览器中打开指定URL
  96. - **截图功能**: 截取屏幕并保存到临时目录
  97. - **文件系统操作**: 文件和目录的创建、读取、写入、复制、移动、删除等操作
  98. - **OCR文字识别**: 从屏幕或指定区域提取文字,查找文字位置
  99. - **系统控制**: 调节屏幕亮度、系统音量、屏幕分辨率等系统设置
  100. - **等待控制**: 在操作间添加延迟
  101. ### 支持的工具
  102. ## Desktop 桌面操作工具
  103. | 工具名称 | 功能描述 |
  104. |---------|----------|
  105. | **LaunchTool** | 从开始菜单启动应用程序 |
  106. | **PowershellTool** | 执行 PowerShell 命令并返回状态码 |
  107. | **StateTool** | 捕获桌面状态信息,包括应用程序和UI元素 |
  108. | **ClipboardTool** | 剪贴板复制和粘贴操作 |
  109. | **ClickTool** | 鼠标点击操作(支持左键、右键、中键,单击、双击、三击) |
  110. | **TypeTool** | 在指定坐标输入文本,支持清除和回车 |
  111. | **ResizeTool** | 调整窗口大小和位置 |
  112. | **SwitchTool** | 切换到指定应用程序窗口 |
  113. | **ScrollTool** | 在指定坐标或当前鼠标位置滚动 |
  114. | **DragTool** | 从源坐标拖拽到目标坐标 |
  115. | **MoveTool** | 移动鼠标光标到指定坐标 |
  116. | **ShortcutTool** | 执行键盘快捷键组合 |
  117. | **KeyTool** | 按下单个键盘按键 |
  118. | **WaitTool** | 暂停执行指定秒数 |
  119. | **ScrapeTool** | 抓取网页内容并转换为Markdown格式 |
  120. | **ScreenshotTool** | 截取屏幕并保存到临时目录,返回图片路径 |
  121. | **OpenBrowserTool** | 在默认浏览器中打开指定URL |
  122. ## FileSystem 文件系统工具
  123. | 工具名称 | 功能描述 |
  124. |---------|----------|
  125. | **ReadFileTool** | 读取指定文件的内容 |
  126. | **WriteFileTool** | 向文件写入内容 |
  127. | **CreateFileTool** | 创建新文件并写入指定内容 |
  128. | **CopyFileTool** | 复制文件到指定位置 |
  129. | **MoveFileTool** | 移动或重命名文件 |
  130. | **DeleteFileTool** | 删除指定文件 |
  131. | **GetFileInfoTool** | 获取文件信息(大小、创建时间等) |
  132. | **ListDirectoryTool** | 列出目录中的文件和子目录 |
  133. | **CreateDirectoryTool** | 创建新目录 |
  134. | **DeleteDirectoryTool** | 删除目录及其内容 |
  135. | **SearchFilesTool** | 在指定目录中搜索文件 |
  136. ## OCR 图像识别工具
  137. | 工具名称 | 功能描述 |
  138. |---------|----------|
  139. | **ExtractTextFromScreenTool** | 使用OCR从整个屏幕提取文字 |
  140. | **ExtractTextFromRegionTool** | 使用OCR从屏幕指定区域提取文字 |
  141. | **FindTextOnScreenTool** | 使用OCR在屏幕上查找指定文字 |
  142. | **GetTextCoordinatesTool** | 获取屏幕上文字的坐标位置 |
  143. | **ExtractTextFromFileTool** | 使用OCR从图像文件中提取文字 |
  144. ## UI元素识别工具
  145. | 工具名称 | 功能描述 |
  146. |---------|----------|
  147. | **FindElementByTextTool** | 通过文本内容查找UI元素 |
  148. | **FindElementByClassNameTool** | 通过类名查找UI元素 |
  149. | **FindElementByAutomationIdTool** | 通过自动化ID查找UI元素 |
  150. | **GetElementPropertiesTool** | 获取指定坐标元素的属性信息 |
  151. | **WaitForElementTool** | 等待指定元素出现在界面上 |
  152. ## SystemControl 系统控制工具
  153. | 工具名称 | 功能描述 |
  154. |---------|----------|
  155. | **BrightnessTool** | 调节屏幕亮度,支持增减和设置具体百分比 |
  156. | **VolumeTool** | 调节系统音量,支持增减和设置具体百分比 |
  157. | **ResolutionTool** | 设置屏幕分辨率(高、中、低三档) |
  158. ## 💡 使用场景
  159. ### 🤖 AI助手桌面自动化
  160. - **智能客服机器人**: AI助手可以自动操作Windows应用程序,帮助用户完成复杂的桌面任务
  161. - **语音助手集成**: 结合语音识别,通过语音指令控制桌面应用程序
  162. - **智能办公助手**: AI助手自动处理日常办公任务,如文档整理、邮件发送等
  163. ### 📊 办公自动化
  164. - **数据录入自动化**: 自动从网页或文档中提取数据并录入到Excel或其他应用程序
  165. - **报告生成**: 自动收集系统信息、截图,生成格式化的报告文档
  166. - **批量文件处理**: 自动整理、重命名、分类大量文件和文档
  167. - **邮件自动化**: 自动发送定期报告、通知邮件
  168. ### 🧪 软件测试与质量保证
  169. - **UI自动化测试**: 模拟用户操作,自动测试桌面应用程序的功能
  170. - **回归测试**: 自动执行重复性测试用例,确保软件质量
  171. - **性能监控**: 自动收集应用程序性能数据,生成监控报告
  172. - **Bug复现**: 自动重现用户报告的问题,辅助开发人员调试
  173. ### 🎯 业务流程自动化
  174. - **客户服务**: 自动处理客户请求,更新CRM系统
  175. - **订单处理**: 自动从多个渠道收集订单信息并录入系统
  176. - **库存管理**: 自动更新库存数据,生成补货提醒
  177. - **财务对账**: 自动对比不同系统的财务数据,标记差异
  178. ### 🔍 数据采集与分析
  179. - **网页数据抓取**: 自动从多个网站收集产品价格、新闻等信息
  180. - **竞品分析**: 定期收集竞争对手的产品信息和价格数据
  181. - **市场调研**: 自动收集和整理市场数据,生成分析报告
  182. - **社交媒体监控**: 监控品牌提及,自动收集用户反馈
  183. ### 🎮 游戏与娱乐
  184. - **游戏辅助**: 自动执行重复性游戏任务(请遵守游戏规则)
  185. - **直播助手**: 自动管理直播软件,切换场景,发送消息
  186. - **媒体管理**: 自动整理音乐、视频文件,更新媒体库
  187. ### 🏥 医疗与健康
  188. - **病历录入**: 自动将纸质病历转换为电子格式
  189. - **医疗图像分析**: 结合OCR技术,自动提取医疗报告中的关键信息
  190. - **预约管理**: 自动处理患者预约请求,更新医院管理系统
  191. ### 🏫 教育与培训
  192. - **在线考试**: 自动批改选择题,生成成绩报告
  193. - **课程管理**: 自动更新课程信息,发送通知给学生
  194. - **学习进度跟踪**: 自动记录学生的学习活动,生成进度报告
  195. ### 🏭 制造业与物流
  196. - **生产数据采集**: 自动从生产设备收集数据,更新ERP系统
  197. - **质量检测**: 结合图像识别,自动检测产品质量
  198. - **物流跟踪**: 自动更新货物状态,发送跟踪信息给客户
  199. ### 🔧 系统运维
  200. - **服务器监控**: 自动检查服务器状态,生成监控报告
  201. - **日志分析**: 自动分析系统日志,识别异常模式
  202. - **备份管理**: 自动执行数据备份,验证备份完整性
  203. - **软件部署**: 自动化软件安装和配置流程
  204. ## 📸 演示截图
  205. ### 文本输入演示
  206. 通过 TypeTool 在记事本中自动输入文本:
  207. ![文本输入演示](assets/NotepadWriting.png)
  208. ### 网页搜索演示
  209. 使用 ScrapeTool 打开并搜索网页内容:
  210. ![网页搜索演示](assets/OpenWebSearch.png)
  211. ### 📹 演示视频
  212. 完整的桌面自动化操作演示:
  213. [网页搜索演示](assets/video.mp4)
  214. ## 🛠️ 技术栈
  215. - **.NET 10.0**: 基于最新的 .NET 框架
  216. - **Model Context Protocol**: 使用 MCP 协议进行通信
  217. - **Microsoft.Extensions.Hosting**: 应用程序托管框架
  218. - **Serilog**: 结构化日志记录
  219. - **HtmlAgilityPack**: HTML 解析和网页抓取
  220. - **ReverseMarkdown**: HTML 到 Markdown 转换
  221. ## 🏗️ 项目结构
  222. ```
  223. src/
  224. ├── Windows-MCP.Net/ # 主项目
  225. │ ├── .mcp/ # MCP 服务器配置
  226. │ │ └── server.json # 服务器配置文件
  227. │ ├── Exceptions/ # 自定义异常类(待扩展)
  228. │ ├── Interface/ # 服务接口定义
  229. │ │ ├── IDesktopService.cs # 桌面服务接口
  230. │ │ ├── IFileSystemService.cs # 文件系统服务接口
  231. │ │ └── IOcrService.cs # OCR服务接口
  232. │ ├── Models/ # 数据模型(待扩展)
  233. │ ├── Prompts/ # 提示模板(待扩展)
  234. │ ├── Services/ # 核心服务实现
  235. │ │ ├── DesktopService.cs # 桌面操作服务
  236. │ │ ├── FileSystemService.cs # 文件系统服务
  237. │ │ └── OcrService.cs # OCR服务
  238. │ ├── Tools/ # MCP 工具实现
  239. │ │ ├── Desktop/ # 桌面操作工具
  240. │ │ │ ├── ClickTool.cs # 点击工具
  241. │ │ │ ├── ClipboardTool.cs # 剪贴板工具
  242. │ │ │ ├── DragTool.cs # 拖拽工具
  243. │ │ │ ├── GetWindowInfoTool.cs # 窗口信息工具
  244. │ │ │ ├── KeyTool.cs # 按键工具
  245. │ │ │ ├── LaunchTool.cs # 启动应用工具
  246. │ │ │ ├── MoveTool.cs # 鼠标移动工具
  247. │ │ │ ├── OpenBrowserTool.cs # 浏览器打开工具
  248. │ │ │ ├── PowershellTool.cs # PowerShell执行工具
  249. │ │ │ ├── ResizeTool.cs # 窗口调整工具
  250. │ │ │ ├── ScrapeTool.cs # 网页抓取工具
  251. │ │ │ ├── ScreenshotTool.cs # 截图工具
  252. │ │ │ ├── ScrollTool.cs # 滚动工具
  253. │ │ │ ├── ShortcutTool.cs # 快捷键工具
  254. │ │ │ ├── StateTool.cs # 桌面状态工具
  255. │ │ │ ├── SwitchTool.cs # 应用切换工具
  256. │ │ │ ├── TypeTool.cs # 文本输入工具
  257. │ │ │ ├── UIElementTool.cs # UI元素操作工具
  258. │ │ │ └── WaitTool.cs # 等待工具
  259. │ │ ├── FileSystem/ # 文件系统工具
  260. │ │ │ ├── CopyFileTool.cs # 文件复制工具
  261. │ │ │ ├── CreateDirectoryTool.cs # 目录创建工具
  262. │ │ │ ├── CreateFileTool.cs # 文件创建工具
  263. │ │ │ ├── DeleteDirectoryTool.cs # 目录删除工具
  264. │ │ │ ├── DeleteFileTool.cs # 文件删除工具
  265. │ │ │ ├── GetFileInfoTool.cs # 文件信息工具
  266. │ │ │ ├── ListDirectoryTool.cs # 目录列表工具
  267. │ │ │ ├── MoveFileTool.cs # 文件移动工具
  268. │ │ │ ├── ReadFileTool.cs # 文件读取工具
  269. │ │ │ ├── SearchFilesTool.cs # 文件搜索工具
  270. │ │ │ └── WriteFileTool.cs # 文件写入工具
  271. │ │ └── OCR/ # OCR识别工具
  272. │ │ ├── ExtractTextFromRegionTool.cs # 区域文本提取工具
  273. │ │ ├── ExtractTextFromScreenTool.cs # 屏幕文本提取工具
  274. │ │ ├── FindTextOnScreenTool.cs # 屏幕文本查找工具
  275. │ │ └── GetTextCoordinatesTool.cs # 文本坐标获取工具
  276. │ ├── Program.cs # 程序入口点
  277. │ └── Windows-MCP.Net.csproj # 项目文件
  278. └── Windows-MCP.Net.Test/ # 测试项目
  279. ├── DesktopToolsExtendedTest.cs # 桌面工具扩展测试
  280. ├── FileSystemToolsExtendedTest.cs # 文件系统工具扩展测试
  281. ├── OCRToolsExtendedTest.cs # OCR工具扩展测试
  282. ├── ToolTest.cs # 工具基础测试
  283. ├── UIElementToolTest.cs # UI元素工具测试
  284. └── Windows-MCP.Net.Test.csproj # 测试项目文件
  285. ```
  286. ## 🚧 功能扩展建议
  287. ### 计划中的功能
  288. #### 高级UI识别与交互
  289. - **UI元素识别增强**: 支持更多UI框架(WPF、WinForms、UWP)
  290. - **OCR文字识别优化**: 多语言支持,提升识别准确率
  291. - **智能等待机制**: 动态等待元素加载完成
  292. #### 文件系统操作增强
  293. - **高级文件搜索**: 支持内容搜索、正则表达式匹配
  294. - **批量文件操作**: 支持批量复制、移动、重命名
  295. - **文件监控**: 实时监控文件系统变化
  296. #### 系统监控与性能分析
  297. - **系统资源监控**: CPU、内存、磁盘、网络使用情况
  298. - **进程管理**: 进程列表获取、性能监控、进程控制
  299. - **性能分析报告**: 生成详细的系统性能报告
  300. #### 多媒体处理能力
  301. - **音频控制**: 系统音量控制、音频设备管理
  302. - **图像处理**: 图片缩放、裁剪、格式转换
  303. - **屏幕录制**: 支持屏幕录制和回放
  304. #### 网络与通信功能
  305. - **网络诊断**: Ping、端口扫描、连通性测试
  306. - **HTTP客户端**: 支持RESTful API调用
  307. - **WiFi管理**: WiFi网络扫描和连接管理
  308. #### 安全性与权限管理
  309. - **权限检查**: 用户权限验证和管理
  310. - **数据加密**: 敏感数据加密存储
  311. - **操作审计**: 完整的操作日志和审计追踪
  312. ### 开发路线图
  313. #### 第一阶段(高优先级)- 核心功能增强
  314. - ✅ UI元素识别工具(已完成Windows API实现)
  315. - 🔄 文件管理工具增强
  316. - 📋 系统监控工具
  317. - 🔒 基础安全工具
  318. #### 第二阶段(中优先级)- 功能扩展
  319. - 📋 OCR文字识别优化
  320. - 📋 高级文件搜索
  321. - 📋 音频控制工具
  322. - 📋 网络诊断工具
  323. - 📋 Excel操作支持
  324. #### 第三阶段(低优先级)- 高级功能
  325. - 📋 图像处理工具
  326. - 📋 任务调度系统
  327. - 📋 数据库操作支持
  328. - 📋 宏录制与回放
  329. ## 🔧 配置
  330. ### 日志配置
  331. 项目使用 Serilog 进行日志记录,日志文件保存在 `logs/` 目录下:
  332. - 控制台输出:实时日志显示
  333. - 文件输出:按天滚动,保留 31 天
  334. - 日志级别:Debug 及以上
  335. ### 环境变量
  336. | 变量名 | 描述 | 默认值 |
  337. |--------|------|--------|
  338. | `ASPNETCORE_ENVIRONMENT` | 运行环境 | `Production` |
  339. ## 📝 许可证
  340. 本项目基于 MIT 许可证开源。详情请参阅 [LICENSE](LICENSE) 文件。
  341. ## 🔗 相关链接
  342. - [Model Context Protocol](https://modelcontextprotocol.io/)
  343. - [.NET 文档](https://docs.microsoft.com/dotnet/)
  344. - [Windows API 文档](https://docs.microsoft.com/windows/win32/)
  345. ## 🤝 贡献指南
  346. 我们欢迎社区贡献!如果您想为项目做出贡献,请遵循以下步骤:
  347. ### 开发环境设置
  348. 1. **克隆仓库**
  349. ```bash
  350. git clone https://github.com/AIDotNet/Windows-MCP.Net.git
  351. cd Windows-MCP.Net
  352. ```
  353. 2. **安装依赖**
  354. ```bash
  355. dotnet restore
  356. ```
  357. 3. **运行测试**
  358. ```bash
  359. dotnet test
  360. ```
  361. 4. **构建项目**
  362. ```bash
  363. dotnet build
  364. ```
  365. ### 贡献流程
  366. 1. Fork 本仓库
  367. 2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
  368. 3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
  369. 4. 推送到分支 (`git push origin feature/AmazingFeature`)
  370. 5. 创建 Pull Request
  371. ### 代码规范
  372. - 遵循 C# 编码规范
  373. - 为新功能添加单元测试
  374. - 更新相关文档
  375. - 确保所有测试通过
  376. ### 问题报告
  377. 在报告问题时,请提供:
  378. - 操作系统版本
  379. - .NET 版本
  380. - 详细的错误信息
  381. - 重现步骤
  382. ## 📞 支持
  383. 如果您遇到问题或有建议,请:
  384. 1. 查看 [Issues](https://github.com/xuzeyu91/Windows-MCP.Net/issues)
  385. 2. 创建新的 Issue
  386. 3. 参与讨论
  387. 4. 查看 [Wiki](https://github.com/xuzeyu91/Windows-MCP.Net/wiki) 获取更多帮助
  388. ---
  389. **注意**: 本工具需要适当的 Windows 权限来执行桌面自动化操作。请确保在受信任的环境中使用。
  390. **免责声明**: 使用本工具进行自动化操作时,请遵守相关法律法规和软件使用协议。开发者不承担因误用工具而产生的任何责任。

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.