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

winterm_mcp/__init__.py

@@ -1,9 +1,32 @@
-"""
-winterm-mcp - Windows Terminal MCP Service
-"""
-
-from .service import __version__, get_version, setup_logging
-
-__author__ = "winterm-mcp contributors"
-
-__all__ = ["__version__", "get_version", "setup_logging"]
+"""
+winterm-mcp - Windows Terminal MCP Service
+"""
+
+from .service import __version__, get_version, setup_logging, CommandService
+from .models import CommandInfo, QueryStatusResponse, VersionInfo, RunCommandParams
+from .store import CommandStore
+from .utils import find_powershell, find_cmd, resolve_executable_path, strip_ansi_codes
+from .constants import NAME, VERSION, ENV_POWERSHELL_PATH, ENV_CMD_PATH, ENV_PYTHON_PATH
+
+__author__ = "winterm-mcp contributors"
+
+__all__ = [
+    "__version__",
+    "get_version",
+    "setup_logging",
+    "CommandService",
+    "CommandInfo",
+    "QueryStatusResponse",
+    "VersionInfo",
+    "RunCommandParams",
+    "CommandStore",
+    "find_powershell",
+    "find_cmd",
+    "resolve_executable_path",
+    "strip_ansi_codes",
+    "NAME",
+    "VERSION",
+    "ENV_POWERSHELL_PATH",
+    "ENV_CMD_PATH",
+    "ENV_PYTHON_PATH",
+]

winterm_mcp/__main__.py

@@ -3,7 +3,7 @@ winterm-mcp 主入口
 """
 
 from .server import app, init_service
-from .service import RunCmdService, setup_logging, __version__
+from .service import CommandService, setup_logging, __version__
 import logging
 import os
 import tempfile
@@ -13,27 +13,28 @@ 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(
+        f"WINTERM_POWERSHELL_PATH: "
+        f"{os.environ.get('WINTERM_POWERSHELL_PATH', '(not set)')}"
+    )
     logger.info("=" * 60)
-    
-    service = RunCmdService()
+
+    service = CommandService()
     init_service(service)
-    
+
     logger.info("Service initialized, starting MCP server...")
     app.run()
 

winterm_mcp/constants.py

@@ -0,0 +1,32 @@
+"""
+常量定义 - winterm-mcp
+"""
+
+NAME = "winterm-mcp"
+VERSION = "0.1.7"
+
+ENV_POWERSHELL_PATH = "WINTERM_POWERSHELL_PATH"
+ENV_CMD_PATH = "WINTERM_CMD_PATH"
+ENV_PYTHON_PATH = "WINTERM_PYTHON_PATH"
+ENV_LOG_LEVEL = "WINTERM_LOG_LEVEL"
+
+POWERSHELL_PATHS = [
+    r"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe",
+    r"C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe",
+]
+
+PWSH_PATHS = [
+    r"C:\Program Files\PowerShell\7\pwsh.exe",
+    r"C:\Program Files (x86)\PowerShell\7\pwsh.exe",
+]
+
+CMD_PATHS = [
+    r"C:\Windows\System32\cmd.exe",
+]
+
+PTY_COLS = 80
+PTY_ROWS = 30
+
+MIN_TIMEOUT = 1
+MAX_TIMEOUT = 3600
+DEFAULT_TIMEOUT = 30

winterm_mcp/models.py

@@ -0,0 +1,73 @@
+"""
+数据模型定义 - winterm-mcp
+"""
+
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Literal, Any
+
+
+@dataclass
+class CommandInfo:
+    """
+    命令信息数据类
+    """
+    token: str
+    executable: str
+    args: list[str]
+    command: str
+    shell_type: Literal["powershell", "cmd", "executable"]
+    status: Literal["pending", "running", "completed", "not_found", "terminated"]
+    start_time: datetime
+    timeout: int
+    working_directory: str | None
+    stdout: str
+    stderr: str
+    exit_code: int | None
+    execution_time: int | None
+    timeout_occurred: bool
+    pty_process: Any | None
+    enable_streaming: bool
+    last_output_timestamp: int = field(default_factory=lambda: int(datetime.now().timestamp() * 1000))
+
+
+@dataclass
+class QueryStatusResponse:
+    """
+    状态查询响应数据类
+    """
+    token: str
+    status: str
+    exit_code: int | None = None
+    stdout: str | None = None
+    stderr: str | None = None
+    execution_time: int | None = None
+    timeout_occurred: bool | None = None
+    message: str | None = None
+
+
+@dataclass
+class VersionInfo:
+    """
+    版本信息数据类
+    """
+    version: str
+    service_status: str
+    python_version: str
+    platform: str
+    arch: str
+    env: dict[str, str | None]
+
+
+@dataclass
+class RunCommandParams:
+    """
+    执行命令参数数据类
+    """
+    command: str
+    executable: str | None = None
+    args: list[str] | None = None
+    shell_type: Literal["powershell", "cmd", "executable"] = "executable"
+    timeout: int = 30
+    working_directory: str | None = None
+    enable_streaming: bool = False

winterm_mcp/server.py

@@ -1,173 +1,285 @@
-from __future__ import annotations
-
-from typing import Annotated, Optional, Dict, Any
-from mcp.server.fastmcp import FastMCP
-from .service import RunCmdService, get_version, setup_logging, __version__
-from pydantic import Field
-
-CommandStr = Annotated[
-    str,
-    Field(
-        description="要执行的命令字符串",
-        min_length=1,
-        max_length=1000,
-    ),
-]
-
-ShellTypeStr = Annotated[
-    str,
-    Field(
-        description="Shell 类型 (powershell 或 cmd)，默认 powershell",
-        pattern="^(powershell|cmd)$",
-    ),
-]
-
-TimeoutInt = Annotated[
-    Optional[int],
-    Field(
-        description="超时秒数 (1-3600)，默认 30 秒",
-        ge=1,
-        le=3600,
-        default=30,
-    ),
-]
-
-WorkingDirectoryStr = Annotated[
-    Optional[str],
-    Field(
-        description="工作目录（可选，默认为当前目录）",
-        default=None,
-        max_length=1000,
-    ),
-]
-
-app = FastMCP("winterm-mcp")
-
-_service: Optional[RunCmdService] = None
-
-
-def init_service(service: RunCmdService) -> None:
-    global _service
-    _service = service
-
-
-def _svc() -> RunCmdService:
-    if _service is None:
-        raise RuntimeError(
-            "Service not initialized. " "Call init_service() before running the server."
-        )
-    return _service
-
-
-@app.tool(
-    name="run_command",
-    description=(
-        "异步执行Windows终端命令，立即返回 token。"
-        "命令将在后台执行，可通过 query_command_status 查询结果。"
-    ),
-    annotations={
-        "title": "异步命令执行器",
-        "readOnlyHint": False,
-        "destructiveHint": True,
-        "idempotentHint": False,
-        "openWorldHint": True,
-    },
-)
-def run_command(
-    command: CommandStr,
-    shell_type: ShellTypeStr = "powershell",
-    timeout: TimeoutInt = 30,
-    working_directory: WorkingDirectoryStr = None,
-) -> Dict[str, Any]:
-    """
-    异步执行Windows终端命令
-
-    Args:
-        command: 要执行的命令
-        shell_type: Shell 类型 (powershell 或 cmd)，默认 powershell
-        timeout: 超时秒数 (1-3600)，默认 30 秒
-        working_directory: 工作目录（可选，默认为当前目录）
-
-    Returns:
-        包含token和状态信息的字典
-    """
-    try:
-        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)}
-
-
-@app.tool(
-    name="query_command_status",
-    description=("查询命令执行状态和结果。" "返回命令的当前状态、退出码、输出等信息。"),
-    annotations={
-        "title": "命令状态查询器",
-        "readOnlyHint": True,
-        "destructiveHint": False,
-        "idempotentHint": True,
-        "openWorldHint": False,
-    },
-)
-def query_command_status(token: str) -> Dict[str, Any]:
-    """
-    查询命令执行状态和结果
-
-    Args:
-        token: 任务 token (GUID 字符串)
-
-    Returns:
-        包含命令状态和结果的字典
-    """
-    try:
-        result = _svc().query_command_status(token)
-        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__}
+from __future__ import annotations
+
+from typing import Annotated, Optional, Dict, Any
+from mcp.server.fastmcp import FastMCP
+from .service import CommandService, get_version, __version__
+from pydantic import Field
+
+CommandStr = Annotated[
+    str,
+    Field(
+        description="要执行的命令字符串",
+        min_length=1,
+        max_length=1000,
+    ),
+]
+
+ShellTypeStr = Annotated[
+    str,
+    Field(
+        description="Shell 类型 (powershell, cmd, executable)，默认 executable",
+        pattern="^(powershell|cmd|executable)$",
+    ),
+]
+
+TimeoutInt = Annotated[
+    Optional[int],
+    Field(
+        description="超时秒数 (1-3600)，默认 30 秒",
+        ge=1,
+        le=3600,
+        default=30,
+    ),
+]
+
+WorkingDirectoryStr = Annotated[
+    Optional[str],
+    Field(
+        description="工作目录（可选，默认为当前目录）",
+        default=None,
+        max_length=1000,
+    ),
+]
+
+ExecutableStr = Annotated[
+    Optional[str],
+    Field(
+        description="可执行文件路径（仅当 shell_type 为 executable 时使用）",
+        default=None,
+    ),
+]
+
+ArgsList = Annotated[
+    Optional[list[str]],
+    Field(
+        description="可执行文件参数列表（仅当 shell_type 为 executable 时使用）",
+        default=None,
+    ),
+]
+
+app = FastMCP("winterm-mcp")
+
+_service: Optional[CommandService] = None
+
+
+def init_service(service: CommandService) -> None:
+    global _service
+    _service = service
+
+
+def _svc() -> CommandService:
+    if _service is None:
+        raise RuntimeError(
+            "Service not initialized. "
+            "Call init_service() before running the server."
+        )
+    return _service
+
+
+@app.tool(
+    name="run_command",
+    description=(
+        "异步执行Windows终端命令，立即返回 token。"
+        "命令将在后台执行，可通过 query_command_status 查询结果。"
+    ),
+    annotations={
+        "title": "异步命令执行器",
+        "readOnlyHint": False,
+        "destructiveHint": True,
+        "idempotentHint": False,
+        "openWorldHint": True,
+    },
+)
+def run_command(
+    command: CommandStr,
+    shell_type: ShellTypeStr = "executable",
+    timeout: TimeoutInt = 30,
+    working_directory: WorkingDirectoryStr = None,
+    executable: ExecutableStr = None,
+    args: ArgsList = None,
+    enable_streaming: bool = False,
+) -> Dict[str, Any]:
+    """
+    异步执行Windows终端命令
+
+    Args:
+        command: 要执行的命令
+        shell_type: Shell 类型 (powershell, cmd, executable)，默认 executable
+        timeout: 超时秒数 (1-3600)，默认 30 秒
+        working_directory: 工作目录（可选，默认为当前目录）
+        executable: 可执行文件路径（仅当 shell_type 为 executable 时使用）
+        args: 可执行文件参数列表（仅当 shell_type 为 executable 时使用）
+        enable_streaming: 启用实时流式输出
+
+    Returns:
+        包含token和状态信息的字典
+    """
+    try:
+        token = _svc().run_command(
+            command,
+            executable,
+            args,
+            shell_type,
+            timeout,
+            working_directory,
+            enable_streaming,
+        )
+        return {"token": token, "status": "pending", "message": "submitted"}
+    except Exception as e:
+        return {"error": str(e)}
+
+
+@app.tool(
+    name="query_command_status",
+    description=("查询命令执行状态和结果。" "返回命令的当前状态、退出码、输出等信息。"),
+    annotations={
+        "title": "命令状态查询器",
+        "readOnlyHint": True,
+        "destructiveHint": False,
+        "idempotentHint": True,
+        "openWorldHint": False,
+    },
+)
+def query_command_status(token: str) -> Dict[str, Any]:
+    """
+    查询命令执行状态和结果
+
+    Args:
+        token: 任务 token (GUID 字符串)
+
+    Returns:
+        包含命令状态和结果的字典
+    """
+    try:
+        result = _svc().query_command_status(token)
+        return result
+    except Exception as e:
+        return {"error": str(e)}
+
+
+@app.tool(
+    name="enhanced_query_command_status",
+    description=(
+        "增强版命令状态查询，支持流式输出。"
+        "可以指定时间戳，只返回该时间戳之后的输出。"
+    ),
+    annotations={
+        "title": "增强版命令状态查询器",
+        "readOnlyHint": True,
+        "destructiveHint": False,
+        "idempotentHint": True,
+        "openWorldHint": False,
+    },
+)
+def enhanced_query_command_status(
+    token: str,
+    since_timestamp: Optional[int] = None,
+) -> Dict[str, Any]:
+    """
+    增强版命令状态查询，支持流式输出
+
+    Args:
+        token: 任务 token (GUID 字符串)
+        since_timestamp: 时间戳（毫秒），只返回此时间戳之后的输出
+
+    Returns:
+        包含命令状态和结果的字典
+    """
+    try:
+        result = _svc().enhanced_query_command_status(token, since_timestamp)
+        return result
+    except Exception as e:
+        return {"error": str(e)}
+
+
+@app.tool(
+    name="send_command_input",
+    description=(
+        "向正在运行的命令发送输入。"
+        "用于交互式命令，例如需要用户输入的程序。"
+    ),
+    annotations={
+        "title": "命令输入发送器",
+        "readOnlyHint": False,
+        "destructiveHint": False,
+        "idempotentHint": False,
+        "openWorldHint": False,
+    },
+)
+def send_command_input(
+    token: str,
+    input: str,
+    append_newline: bool = True,
+) -> Dict[str, Any]:
+    """
+    向正在运行的命令发送输入
+
+    Args:
+        token: 任务 token (GUID 字符串)
+        input: 要发送的输入内容
+        append_newline: 是否在输入后追加换行符，默认 True
+
+    Returns:
+        包含操作结果的字典
+    """
+    try:
+        result = _svc().send_command_input(token, input, append_newline)
+        return result
+    except Exception as e:
+        return {"error": str(e)}
+
+
+@app.tool(
+    name="terminate_command",
+    description=(
+        "终止正在运行的命令。"
+        "强制停止命令执行，适用于长时间运行的命令。"
+    ),
+    annotations={
+        "title": "命令终止器",
+        "readOnlyHint": False,
+        "destructiveHint": True,
+        "idempotentHint": False,
+        "openWorldHint": False,
+    },
+)
+def terminate_command(token: str) -> Dict[str, Any]:
+    """
+    终止正在运行的命令
+
+    Args:
+        token: 任务 token (GUID 字符串)
+
+    Returns:
+        包含操作结果的字典
+    """
+    try:
+        result = _svc().terminate_command(token)
+        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:
+        包含版本号和服务状态的字典
+    """
+    try:
+        result = _svc().get_version_info()
+        return result
+    except Exception as e:
+        return {"error": str(e), "version": __version__}