Skip to main content

A Model Context Protocol (MCP) service for executing Windows terminal commands asynchronously

Project description

winterm-mcp

更新日期: 2026-01-16 版本: 0.1.4

Windows Terminal MCP Service - 专门支持 Windows 终端的异步命令执行工具。

功能特性

  • PowerShell 支持: 直接执行 PowerShell 命令(默认)
  • Cmd 支持: 可选执行 cmd 命令
  • 异步执行: 后台执行命令,立即返回 token
  • 状态查询: 查询命令执行状态和结果
  • 超时控制: 可设置超时时间(1-3600秒)
  • 工作目录: 指定执行目录
  • 自动编码: 自动处理 PowerShell (UTF-8) 和 Cmd (GBK) 编码

安装

cd winterm_mcp_standalone
pip install -e .

使用方法

MCP 配置

在 MCP 客户端配置中添加:

{
  "mcpServers": {
    "winterm": {
      "command": "uvx",
      "args": [
        "winterm-mcp"
      ]
    }
  }
}

环境配置

PowerShell 路径配置

在某些受限环境(如沙箱环境)中,系统 PATH 可能不包含 PowerShell 路径。winterm-mcp 会自动探测以下位置:

  1. C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe
  2. C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe
  3. C:\Program Files\PowerShell\7\pwsh.exe(PowerShell Core)
  4. C:\Program Files (x86)\PowerShell\7\pwsh.exe

如果 PowerShell 安装在非标准位置,可通过环境变量指定:

方式一:系统环境变量

# Windows CMD
set WINTERM_POWERSHELL_PATH=D:\CustomPath\powershell.exe

# Windows PowerShell
$env:WINTERM_POWERSHELL_PATH = "D:\CustomPath\powershell.exe"

方式二:MCP 配置

{
  "mcpServers": {
    "winterm": {
      "command": "uvx",
      "args": ["winterm-mcp"],
      "env": {
        "WINTERM_POWERSHELL_PATH": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
      }
    }
  }
}

工具接口

run_command

异步执行 Windows 终端命令。

参数:

  • command (string): 要执行的命令(必填,1-1000字符)
  • shell_type (string, optional): Shell 类型,powershellcmd,默认 powershell
  • timeout (integer, optional): 超时秒数(1-3600),默认 30
  • working_directory (string, optional): 工作目录(可选,默认当前目录)

返回:

{
  "token": "uuid-string",
  "status": "pending",
  "message": "submitted"
}

query_command_status

查询命令执行状态和结果。

参数:

  • token (string): 命令 token

返回:

{
  "token": "uuid-string",
  "status": "completed",
  "exit_code": 0,
  "stdout": "command output",
  "stderr": "",
  "execution_time": 0.123,
  "timeout_occurred": false
}

使用示例

PowerShell 命令

# 获取当前日期
run_command("Get-Date")

# 列出进程
run_command("Get-Process | Select-Object -First 5")

# 构建项目
run_command("dotnet build", timeout=60, working_directory="d:/project")

Cmd 命令

# 列出目录
run_command("dir", shell_type="cmd")

# Ping 测试
run_command("ping 127.0.0.1 -n 4", shell_type="cmd")

查询命令状态

# 提交命令
result = run_command("Get-Process")
token = result["token"]

# 查询状态
status = query_command_status(token)
if status["status"] == "completed":
    print(status["stdout"])

技术架构

  • 框架: FastMCP
  • 并发: 多线程异步执行
  • 编码: 自动处理 UTF-8 和 GBK
  • 平台: Windows

与 runcmd-mcp 的区别

特性 runcmd-mcp winterm-mcp
Shell 类型 仅 cmd PowerShell + Cmd
Windows 支持 部分 完整
编码处理 固定 自动适配
平台 跨平台 Windows 专用

许可证

MIT License

贡献

欢迎提交 Issue 和 Pull Request。

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

winterm_mcp-0.1.4.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

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

winterm_mcp-0.1.4-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file winterm_mcp-0.1.4.tar.gz.

File metadata

  • Download URL: winterm_mcp-0.1.4.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for winterm_mcp-0.1.4.tar.gz
Algorithm Hash digest
SHA256 43e7cbb6bf56d75092c968e698261a01420666a83be79911d715595a827556a0
MD5 9a8c557894b697f1a2fde4d5d043d13c
BLAKE2b-256 d0fa44bd598704a333762a9ef40cd946515761841b924ef50d8b3e3a1e760277

See more details on using hashes here.

File details

Details for the file winterm_mcp-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: winterm_mcp-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for winterm_mcp-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6acc60eed7da04b441c69afd3c86c89d88265356752463e1a9821e0e3a92fe35
MD5 6b8a86810b77d6963bf3980101799b25
BLAKE2b-256 e2e5a00dcca55ae8efc0b99e27cbf2a396c394c1b111777e15e6ae9e8c2cad54

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