Windows-MCP

使用说明(Markdown 格式)

  • 项目简介

    • Windows-MCP 是一个在 Windows 上运行的 MCP 服务器实现。它通过 FastMCP 框架暴露一组面向 LLM 的工具,允许远程或本地的 MCP 客户端读取系统资源、执行外部工具、获取桌面状态等,从而为 LLM 代理提供可运营的桌面上下文与自动化能力。
  • 主要功能点

    • 本地模式与远程模式:支持直接在本机运行并暴露工具,以及通过 dashboard 以代理形式在云端执行 Windows 自动化任务。
    • 多传输协议:支持标准输入输出(stdio)、Server-Sent Events(SSE)以及流式 HTTP 转发,适配不同网络环境与安全需求。
    • 工具集合(MCP Tools):包含应用管理、PowerShell 命令执行、文件系统操作、快照/桌面状态、UI 操作(点击、输入、滚动、移动)、剪贴板、进程管理、通知、注册表等多种能力,面向 LLM 客户端的调用。
    • 认证与代理(Remote 模式):在远程模式下通过 AuthClient 与 Windows-MCP Dashboard 进行身份对接,使用代理后端(StreamableHttpTransport)与云端进行通讯。
    • 资源与上下文:通过桌面状态树、交互元素、滚动区域等信息,向 LLM 提供可用的上下文数据,便于进行推理与决策。
    • 可扩展性与安全性:设计考虑会话管理、能力声明、传输层选择和日志/遥测等要素,便于在企业环境中扩展与审计。
  • 安装步骤

    • 依赖与环境
      • 操作系统:Windows(7–11 及以上版本),Python 3.13+,并安装 uv(Astra 的包管理工具)来运行 MCP 服务器。
    • 安装方式一(推荐,直接从 PyPI 安装并运行)
      • 安装 Python 3.13 及以上版本。
      • 安装 uv 工具(Astra 提供的包管理工具)。
      • 安装 Windows-MCP:通过 PyPI 安装并运行。
      • 运行命令示例:uvx windows-mcp
    • 安装方式二(从源码运行)
      • 克隆仓库并进入目录
      • 使用 uv 直接运行指定的 MCP 包
      • 运行命令示例:uv <路径> run windows-mcp
    • 客户端配置无需在 MCP 端进行修改,服务器端的额外配置见下方“服务器配置”部分。
  • 服务器配置(给 MCP 客户端的连接信息,配置信息以 JSON 形式示例,含服务器名称、启动命令与参数)

    • 说明:MCP 客户端需要知道如何启动服务器以建立连接。配置示例中的 serverName 对应自定义名称,command 与 args 指定启动服务器的命令与参数。MCP 客户端本身不需要理解服务器实现细节。
    • 配置示例(JSON,单个服务器条目): { "servers": { "windows-mcp": { "name": "Windows-MCP", "command": "uvx", "args": [ "windows-mcp" ] // 如使用本地源码运行,替换为: // "command": "uv", // "args": ["--directory", "<path-to-windows-mcp>", "run", "windows-mcp"] } } }
    • 说明
      • 如果你使用最新的 PyPI 版本并通过 uvx 启动,命令和参数如上述示例的第一组;若从源码启动,命令应为 uv,参数中包含源码路径与运行指令。
      • 客户端配置仅用于启动与连接,不需要在 MCP 客户端实现中嵌入服务器实现细节。
  • 基本使用方法

    • 本地使用
      • 向 MCP 客户端暴露的工具集合发起请求,客户端通过 JSON-RPC 与服务器交互,获取资源、执行工具或获取桌面状态的结果。
    • 远程使用
      • 将服务器配置为远程模式(通过 DASHBOARD API_KEY、SANDBOX_ID 等环境变量),并通过代理传输完成远端执行。
    • 常见流程
      • 启动 Windows-MCP 服务器(本地/远程任一模式)。
      • 使用 MCP 客户端调用工具(如 FileSystem、Snapshot、Click、Type、PowerShell、Registry 等)。
      • 如遇需要,切换传输模式(stdio、SSE、streamable-http),以适配网络环境。
    • 安全与扩展
      • 如要关闭数据遥测、调整日志与调试选项,请在配置中进行相应设置。
      • 服务器支持扩展新的工具集和资源接口,便于集成更多 Windows 场景。

服务器信息