winterm-mcp 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

winterm_mcp/__init__.py

@@ -2,5 +2,8 @@
 winterm-mcp - Windows Terminal MCP Service
 """
 
-__version__ = "0.1.1"
+from .service import __version__, get_version, setup_logging
+
 __author__ = "winterm-mcp contributors"
+
+__all__ = ["__version__", "get_version", "setup_logging"]

winterm_mcp/__main__.py

@@ -3,15 +3,38 @@ winterm-mcp 主入口
 """
 
 from .server import app, init_service
-from .service import RunCmdService
+from .service import RunCmdService, setup_logging, __version__
+import logging
+import os
+import tempfile
 
 
 def main():
     """
     主函数，启动 MCP 服务器
     """
+    # 初始化日志
+    setup_logging(logging.INFO)
+    
+    logger = logging.getLogger("winterm-mcp")
+    
+    # 获取日志文件路径并记录
+    log_file = os.environ.get("WINTERM_LOG_FILE") or os.path.join(
+        tempfile.gettempdir(), "winterm-mcp.log"
+    )
+    
+    logger.info("=" * 60)
+    logger.info(f"winterm-mcp v{__version__} starting...")
+    logger.info(f"Log file: {log_file}")
+    logger.info(f"Temp dir: {tempfile.gettempdir()}")
+    logger.info(f"Working dir: {os.getcwd()}")
+    logger.info(f"WINTERM_POWERSHELL_PATH: {os.environ.get('WINTERM_POWERSHELL_PATH', '(not set)')}")
+    logger.info("=" * 60)
+    
     service = RunCmdService()
     init_service(service)
+    
+    logger.info("Service initialized, starting MCP server...")
     app.run()
 
 

winterm_mcp/server.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import Annotated, Optional, Dict, Any
 from mcp.server.fastmcp import FastMCP
-from .service import RunCmdService
+from .service import RunCmdService, get_version, setup_logging, __version__
 from pydantic import Field
 
 CommandStr = Annotated[
@@ -54,8 +54,7 @@ def init_service(service: RunCmdService) -> None:
 def _svc() -> RunCmdService:
     if _service is None:
         raise RuntimeError(
-            "Service not initialized. "
-            "Call init_service() before running the server."
+            "Service not initialized. " "Call init_service() before running the server."
         )
     return _service
 
@@ -93,9 +92,7 @@ def run_command(
         包含token和状态信息的字典
     """
     try:
-        token = _svc().run_command(
-            command, shell_type, timeout, working_directory
-        )
+        token = _svc().run_command(command, shell_type, timeout, working_directory)
         return {"token": token, "status": "pending", "message": "submitted"}
     except Exception as e:
         return {"error": str(e)}
@@ -127,3 +124,50 @@ def query_command_status(token: str) -> Dict[str, Any]:
         return result
     except Exception as e:
         return {"error": str(e)}
+
+
+@app.tool(
+    name="get_version",
+    description="获取 winterm-mcp 服务的版本信息和运行状态。",
+    annotations={
+        "title": "版本信息",
+        "readOnlyHint": True,
+        "destructiveHint": False,
+        "idempotentHint": True,
+        "openWorldHint": False,
+    },
+)
+def get_version_tool() -> Dict[str, Any]:
+    """
+    获取 winterm-mcp 版本信息
+    
+    Returns:
+        包含版本号和服务状态的字典
+    """
+    import os
+    import sys
+    
+    try:
+        # 尝试获取 PowerShell 路径信息
+        ps_path = None
+        ps_error = None
+        try:
+            from .service import _find_powershell
+            ps_path = _find_powershell()
+        except FileNotFoundError as e:
+            ps_error = str(e)
+        
+        return {
+            "version": get_version(),
+            "service_status": "running",
+            "python_version": sys.version,
+            "platform": sys.platform,
+            "powershell_path": ps_path,
+            "powershell_error": ps_error,
+            "env": {
+                "WINTERM_POWERSHELL_PATH": os.environ.get("WINTERM_POWERSHELL_PATH"),
+                "WINTERM_LOG_LEVEL": os.environ.get("WINTERM_LOG_LEVEL"),
+            }
+        }
+    except Exception as e:
+        return {"error": str(e), "version": __version__}

winterm_mcp/service.py

@@ -6,8 +6,161 @@ import subprocess
 import threading
 import uuid
 import time
+import os
+import shutil
+import logging
 from datetime import datetime
-from typing import Dict, Optional, Any
+from typing import Dict, Optional, Any, List
+
+# 版本号
+__version__ = "0.1.5"
+
+# 配置日志
+logger = logging.getLogger("winterm-mcp")
+
+
+def setup_logging(level: int = logging.INFO) -> None:
+    """
+    配置日志输出
+    
+    Args:
+        level: 日志级别，默认 INFO
+    
+    日志输出位置：
+    1. 控制台 (stderr)
+    2. 文件: %TEMP%/winterm-mcp.log 或 /tmp/winterm-mcp.log
+    
+    可通过环境变量配置：
+    - WINTERM_LOG_LEVEL: 日志级别 (DEBUG/INFO/WARNING/ERROR/CRITICAL)
+    - WINTERM_LOG_FILE: 自定义日志文件路径
+    """
+    import tempfile
+    
+    formatter = logging.Formatter(
+        "[%(asctime)s] [%(name)s] [%(levelname)s] %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S"
+    )
+    
+    # 控制台输出
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+    
+    # 文件输出
+    log_file = os.environ.get("WINTERM_LOG_FILE")
+    if not log_file:
+        # 默认日志文件路径
+        log_file = os.path.join(tempfile.gettempdir(), "winterm-mcp.log")
+    
+    try:
+        file_handler = logging.FileHandler(log_file, encoding="utf-8")
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+        logger.info(f"Log file: {log_file}")
+    except Exception as e:
+        logger.warning(f"Failed to create log file {log_file}: {e}")
+    
+    logger.setLevel(level)
+    
+    # 检查环境变量设置日志级别
+    env_level = os.environ.get("WINTERM_LOG_LEVEL", "").upper()
+    if env_level in ("DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"):
+        logger.setLevel(getattr(logging, env_level))
+
+
+# PowerShell 可执行文件的标准路径（按优先级排序）
+POWERSHELL_PATHS: List[str] = [
+    r"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe",
+    r"C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe",
+]
+
+# PowerShell Core (pwsh) 的常见路径
+PWSH_PATHS: List[str] = [
+    r"C:\Program Files\PowerShell\7\pwsh.exe",
+    r"C:\Program Files (x86)\PowerShell\7\pwsh.exe",
+]
+
+# 环境变量名称
+ENV_POWERSHELL_PATH = "WINTERM_POWERSHELL_PATH"
+
+
+def _find_powershell() -> str:
+    """
+    查找可用的 PowerShell 可执行文件路径
+
+    查找顺序：
+    1. 环境变量 WINTERM_POWERSHELL_PATH（用户自定义）
+    2. Windows PowerShell 标准路径
+    3. PowerShell Core 标准路径
+    4. PATH 环境变量中的 powershell/pwsh（兼容正常环境）
+
+    Returns:
+        PowerShell 可执行文件的绝对路径
+
+    Raises:
+        FileNotFoundError: 如果找不到 PowerShell
+    """
+    logger.debug("Starting PowerShell path discovery...")
+    
+    # 1. 检查用户配置的环境变量
+    custom_path = os.environ.get(ENV_POWERSHELL_PATH)
+    if custom_path:
+        logger.debug(f"Found env var {ENV_POWERSHELL_PATH}={custom_path}")
+        if os.path.isfile(custom_path):
+            logger.info(f"Using custom PowerShell path: {custom_path}")
+            return custom_path
+        else:
+            logger.warning(
+                f"Custom PowerShell path not found: {custom_path}, "
+                "falling back to standard paths"
+            )
+
+    # 2. 检查 Windows PowerShell 标准路径
+    for path in POWERSHELL_PATHS:
+        logger.debug(f"Checking standard path: {path}")
+        if os.path.isfile(path):
+            logger.info(f"Found Windows PowerShell: {path}")
+            return path
+
+    # 3. 检查 PowerShell Core 标准路径
+    for path in PWSH_PATHS:
+        logger.debug(f"Checking PowerShell Core path: {path}")
+        if os.path.isfile(path):
+            logger.info(f"Found PowerShell Core: {path}")
+            return path
+
+    # 4. 尝试 PATH 环境变量（兼容正常环境）
+    logger.debug("Checking PATH environment variable...")
+    ps_path = shutil.which("powershell")
+    if ps_path:
+        logger.info(f"Found PowerShell in PATH: {ps_path}")
+        return ps_path
+
+    pwsh_path = shutil.which("pwsh")
+    if pwsh_path:
+        logger.info(f"Found pwsh in PATH: {pwsh_path}")
+        return pwsh_path
+
+    # 所有方法都失败
+    checked_paths = POWERSHELL_PATHS + PWSH_PATHS
+    error_msg = (
+        f"PowerShell not found. "
+        f"Set {ENV_POWERSHELL_PATH} environment variable or "
+        f"ensure PowerShell is installed. "
+        f"Checked paths: {', '.join(checked_paths)}"
+    )
+    logger.error(error_msg)
+    raise FileNotFoundError(error_msg)
+
+
+def get_version() -> str:
+    """
+    获取 winterm-mcp 版本号
+    
+    Returns:
+        版本号字符串
+    """
+    return __version__
 
 
 class RunCmdService:
@@ -18,6 +171,24 @@ class RunCmdService:
     def __init__(self):
         self.commands: Dict[str, Dict[str, Any]] = {}
         self.lock = threading.Lock()
+        self._powershell_path: Optional[str] = None
+
+    def _get_powershell_path(self) -> str:
+        """
+        获取 PowerShell 可执行文件路径（带缓存）
+
+        首次调用时查找并缓存路径，后续调用直接返回缓存值。
+
+        Returns:
+            PowerShell 可执行文件的绝对路径
+
+        Raises:
+            FileNotFoundError: 如果找不到 PowerShell
+        """
+        if self._powershell_path is None:
+            self._powershell_path = _find_powershell()
+            logger.debug(f"PowerShell path cached: {self._powershell_path}")
+        return self._powershell_path
 
     def run_command(
         self,
@@ -39,6 +210,12 @@ class RunCmdService:
             命令执行的token
         """
         token = str(uuid.uuid4())
+        
+        logger.info(
+            f"Submitting command: token={token}, shell={shell_type}, "
+            f"timeout={timeout}, cwd={working_directory}"
+        )
+        logger.debug(f"Command content: {command[:100]}{'...' if len(command) > 100 else ''}")
 
         cmd_info = {
             "token": token,
@@ -80,6 +257,7 @@ class RunCmdService:
         """
         try:
             start_time = time.time()
+            logger.debug(f"[{token}] Starting command execution...")
 
             with self.lock:
                 if token in self.commands:
@@ -88,19 +266,25 @@ class RunCmdService:
             encoding = "gbk"
 
             if shell_type == "powershell":
-                # 添加 -ExecutionPolicy Bypass 避免执行策略阻塞
-                # 添加 -NoLogo 减少启动输出
+                # 使用绝对路径调用 PowerShell，避免 PATH 环境变量限制
+                ps_path = self._get_powershell_path()
+                logger.info(f"[{token}] Using PowerShell: {ps_path}")
                 cmd_args = [
-                    "powershell",
+                    ps_path,
                     "-NoProfile",
                     "-NoLogo",
                     "-NonInteractive",
-                    "-ExecutionPolicy", "Bypass",
-                    "-Command", command
+                    "-ExecutionPolicy",
+                    "Bypass",
+                    "-Command",
+                    command,
                 ]
             else:
+                logger.debug(f"[{token}] Using cmd.exe")
                 cmd_args = ["cmd", "/c", command]
 
+            logger.debug(f"[{token}] Executing: {cmd_args}")
+            
             result = subprocess.run(
                 cmd_args,
                 capture_output=True,
@@ -112,6 +296,13 @@ class RunCmdService:
             )
 
             execution_time = time.time() - start_time
+            
+            logger.info(
+                f"[{token}] Command completed: exit_code={result.returncode}, "
+                f"time={execution_time:.3f}s"
+            )
+            logger.debug(f"[{token}] stdout: {result.stdout[:200] if result.stdout else '(empty)'}")
+            logger.debug(f"[{token}] stderr: {result.stderr[:200] if result.stderr else '(empty)'}")
 
             with self.lock:
                 if token in self.commands:
@@ -125,8 +316,24 @@ class RunCmdService:
                         }
                     )
 
+        except FileNotFoundError as e:
+            execution_time = time.time() - start_time
+            logger.error(f"[{token}] PowerShell not found: {e}")
+            with self.lock:
+                if token in self.commands:
+                    self.commands[token].update(
+                        {
+                            "status": "completed",
+                            "stdout": "",
+                            "stderr": f"PowerShell not found: {e}",
+                            "exit_code": -2,
+                            "execution_time": execution_time,
+                            "timeout_occurred": False,
+                        }
+                    )
         except subprocess.TimeoutExpired:
             execution_time = time.time() - start_time
+            logger.warning(f"[{token}] Command timed out after {timeout}s")
             with self.lock:
                 if token in self.commands:
                     self.commands[token].update(
@@ -143,6 +350,7 @@ class RunCmdService:
                     )
         except Exception as e:
             execution_time = time.time() - start_time
+            logger.error(f"[{token}] Command failed with exception: {e}")
             with self.lock:
                 if token in self.commands:
                     self.commands[token].update(
@@ -166,8 +374,11 @@ class RunCmdService:
         Returns:
             包含命令状态的字典
         """
+        logger.debug(f"Querying status for token: {token}")
+        
         with self.lock:
             if token not in self.commands:
+                logger.warning(f"Token not found: {token}")
                 return {
                     "token": token,
                     "status": "not_found",
@@ -175,6 +386,7 @@ class RunCmdService:
                 }
 
             cmd_info = self.commands[token].copy()
+            logger.debug(f"[{token}] Status: {cmd_info['status']}")
 
             if cmd_info["status"] == "running":
                 return {"token": cmd_info["token"], "status": "running"}

{winterm_mcp-0.1.3.dist-info → winterm_mcp-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winterm-mcp
-Version: 0.1.3
+Version: 0.1.5
 Summary: A Model Context Protocol (MCP) service for executing Windows terminal commands asynchronously
 Author-email: winterm-mcp contributors <maintainer@example.com>
 License: MIT
@@ -27,8 +27,8 @@ Dynamic: license-file
 
 # winterm-mcp
 
-**更新日期**: 2026-01-16  
-**版本**: 0.1.1
+**更新日期**: 2026-01-16
+**版本**: 0.1.4
 
 Windows Terminal MCP Service - 专门支持 Windows 终端的异步命令执行工具。
 
@@ -58,8 +58,50 @@ pip install -e .
 ```json
 {
   "mcpServers": {
-    "winterm-mcp": {
-      "command": "winterm-mcp"
+    "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 安装在非标准位置，可通过环境变量指定：
+
+**方式一：系统环境变量**
+
+```bash
+# Windows CMD
+set WINTERM_POWERSHELL_PATH=D:\CustomPath\powershell.exe
+
+# Windows PowerShell
+$env:WINTERM_POWERSHELL_PATH = "D:\CustomPath\powershell.exe"
+```
+
+**方式二：MCP 配置**
+
+```json
+{
+  "mcpServers": {
+    "winterm": {
+      "command": "uvx",
+      "args": ["winterm-mcp"],
+      "env": {
+        "WINTERM_POWERSHELL_PATH": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
+      }
     }
   }
 }

winterm_mcp-0.1.5.dist-info/RECORD

@@ -0,0 +1,10 @@
+winterm_mcp/__init__.py,sha256=SKtzW0lc0ixl5FUdEaJA6J7tryL-JYTvsPG8wUi5Dxk,222
+winterm_mcp/__main__.py,sha256=5K6N5K-ooaAb1X17EmEQUid8zne-A457NAGCT33qGIg,1097
+winterm_mcp/server.py,sha256=wKoCItWQBG4b2cODluWfk8ABjmXlDlFxVyK4tD7NBiY,4541
+winterm_mcp/service.py,sha256=T7nlrKZDTqudScm-eEhDi72JRN82qxU3C9l_rOzMpOw,13213
+winterm_mcp-0.1.5.dist-info/licenses/LICENSE,sha256=GPZ4VAbf_gxeFMSUHCmNQING30GK0kNduK8EJIO5-gc,1081
+winterm_mcp-0.1.5.dist-info/METADATA,sha256=PCRDUAN9ZtgRcxl-9PkH44jDBxwP6IAiHKBBsHyCd5I,5106
+winterm_mcp-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+winterm_mcp-0.1.5.dist-info/entry_points.txt,sha256=0OGioH1DKGxuxvSFD1OCRcbLoutfqdEPmJy_j2GhJTA,113
+winterm_mcp-0.1.5.dist-info/top_level.txt,sha256=S7w96DR3MB-CMIuXLnrMOvs5ApqPF-2PsAcfVCphCHw,12
+winterm_mcp-0.1.5.dist-info/RECORD,,

winterm_mcp-0.1.3.dist-info/RECORD

@@ -1,10 +0,0 @@
-winterm_mcp/__init__.py,sha256=2Z5_ooE56FyBhidVPwkvcWPyl4ONfzi5ZRmmg2RvUm4,120
-winterm_mcp/__main__.py,sha256=aCm888vzPOYtBDLtV02zAKkjIhrFAd2xB-TZAl4qHCc,300
-winterm_mcp/server.py,sha256=JEZc6NJeOrMuZejV6aho1UINZEOTDWNor3YYEdzPWCI,3204
-winterm_mcp/service.py,sha256=x0Ve8VS_ZodSNaZbDkO-pkFGui_6v_ooam_3WezcKxc,5995
-winterm_mcp-0.1.3.dist-info/licenses/LICENSE,sha256=GPZ4VAbf_gxeFMSUHCmNQING30GK0kNduK8EJIO5-gc,1081
-winterm_mcp-0.1.3.dist-info/METADATA,sha256=43DUZ9PYyPZXGJ4Qo8_0CiH8YwBNLH80NN7jjHDdcKg,4052
-winterm_mcp-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-winterm_mcp-0.1.3.dist-info/entry_points.txt,sha256=0OGioH1DKGxuxvSFD1OCRcbLoutfqdEPmJy_j2GhJTA,113
-winterm_mcp-0.1.3.dist-info/top_level.txt,sha256=S7w96DR3MB-CMIuXLnrMOvs5ApqPF-2PsAcfVCphCHw,12
-winterm_mcp-0.1.3.dist-info/RECORD,,