remote-debug-mcp 0.2.0__py3-none-any.whl

remote_debug_mcp/__init__.py

@@ -0,0 +1,3 @@
+from remote_debug_mcp.server import main
+
+__all__ = ["main"]

remote_debug_mcp/__main__.py

@@ -0,0 +1,5 @@
+import asyncio
+from remote_debug_mcp.server import main
+
+if __name__ == "__main__":
+    asyncio.run(main())

remote_debug_mcp/config.example.yaml

@@ -0,0 +1,30 @@
+# 远程调试连接配置文件（示例）
+# 复制为 config.yaml 并填入真实参数
+#
+# save_config 工具是配置唯一入库入口：
+#   - 无参调用：保存当前内存配置到文件
+#   - 带 connections 参数：合并条目后写入文件
+#   - 无配置文件时：LLM 询问用户参数，调用 save_config 创建
+#   - setup_com2tcp 完成后：LLM 调用 save_config 持久化 com2tcp 配置
+
+connections:
+  - name: "my-pc"
+    type: ssh
+    host: "192.168.1.100"
+    port: 22
+    username: "your-username"
+    password: "your-password"
+    # key_file: "/path/to/key"  # 可选，密钥认证
+
+  - name: "com2tcp_COM4_5200"
+    type: com2tcp
+    ssh: "my-pc"           # 关联的 SSH 配置名（用于解析 host）
+    com_port: "COM4"
+    telnet_port: 5200
+    baud: 115200
+    # 以下为可选参数（均有默认值）
+    # username: ""          # Telnet 登录用户名
+    # password: ""          # Telnet 登录密码
+    # connect_timeout: 15   # 连接超时（秒）
+    # buffer_max_size: 65536  # 缓冲区大小（字节，默认 64KB）
+    # max_retries: 3        # 自动重连次数

remote_debug_mcp/config_loader.py

@@ -0,0 +1,216 @@
+"""
+配置文件加载器，读取 config.yaml 中的连接参数。
+支持 SSH 连接和 com2tcp 串口映射配置。
+"""
+import os
+from dataclasses import dataclass, field
+from typing import Optional
+
+
+@dataclass
+class SSHConfig:
+    name: str
+    host: str
+    port: int = 22
+    username: str = ""
+    password: str = ""
+    key_file: str = ""
+
+
+@dataclass
+class Com2TcpConfig:
+    name: str
+    ssh: str
+    com_port: str
+    telnet_port: int = 5200
+    baud: int = 115200
+    username: str = ""
+    password: str = ""
+    connect_timeout: int = 15
+    buffer_max_size: int = 65536
+    max_retries: int = 3
+
+
+@dataclass
+class AppConfig:
+    ssh_connections: list[SSHConfig] = field(default_factory=list)
+    com2tcp_connections: list[Com2TcpConfig] = field(default_factory=list)
+
+    def get_ssh(self, name: str) -> Optional[SSHConfig]:
+        for c in self.ssh_connections:
+            if c.name == name:
+                return c
+        return None
+
+    def get_com2tcp(self, name: str) -> Optional[Com2TcpConfig]:
+        for c in self.com2tcp_connections:
+            if c.name == name:
+                return c
+        return None
+
+
+def _parse_yaml_simple(content: str) -> AppConfig:
+    """简版 YAML 解析器，无需 PyYAML 依赖。"""
+    config = AppConfig()
+    current_section = None
+    current_entry = {}
+    in_connections = False
+
+    for raw_line in content.split("\n"):
+        line = raw_line.rstrip()
+        if not line or line.strip().startswith("#"):
+            continue
+
+        stripped = line.strip()
+
+        if stripped == "connections:":
+            in_connections = True
+            continue
+
+        if not in_connections:
+            continue
+
+        if stripped.startswith("- name:"):
+            if current_entry:
+                _add_entry(config, current_entry)
+                current_entry = {}
+            name_part = stripped.split(":", 1)[1].strip()
+            if "#" in name_part:
+                name_part = name_part[:name_part.index("#")].strip()
+            current_entry["name"] = name_part.strip().strip('"')
+
+        elif ":" in stripped and not stripped.startswith("-"):
+            key, _, val = stripped.partition(":")
+            key = key.strip()
+            val = val.strip()
+            if "#" in val:
+                val = val[:val.index("#")].strip()
+            val = val.strip('"').strip("'")
+            if key in ("port", "telnet_port", "baud", "connect_timeout", "buffer_max_size", "max_retries"):
+                current_entry[key] = int(val) if val else 0
+            else:
+                current_entry[key] = val
+
+    if current_entry:
+        _add_entry(config, current_entry)
+
+    return config
+
+
+def _add_entry(config: AppConfig, entry: dict):
+    name = entry.get("name", "")
+    etype = entry.get("type", "ssh")
+    if etype == "ssh":
+        config.ssh_connections.append(SSHConfig(
+            name=name,
+            host=entry.get("host", ""),
+            port=entry.get("port", 22),
+            username=entry.get("username", ""),
+            password=entry.get("password", ""),
+            key_file=entry.get("key_file", ""),
+        ))
+    elif etype == "com2tcp":
+        config.com2tcp_connections.append(Com2TcpConfig(
+            name=name,
+            ssh=entry.get("ssh", ""),
+            com_port=entry.get("com_port", ""),
+            telnet_port=entry.get("telnet_port", 5200),
+            baud=entry.get("baud", 115200),
+            username=entry.get("username", ""),
+            password=entry.get("password", ""),
+            connect_timeout=entry.get("connect_timeout", 15),
+            buffer_max_size=entry.get("buffer_max_size", 65536),
+            max_retries=entry.get("max_retries", 3),
+        ))
+
+
+def _find_config_path(path: str) -> str:
+    """搜索配置文件路径，返回第一个存在的文件路径。"""
+    source_dir = os.path.dirname(os.path.abspath(__file__))
+    repo_root = os.path.join(source_dir, "..", "..", "..")
+    search_paths = [
+        path,
+        os.path.join(source_dir, path),
+        os.path.join(source_dir, "..", path),
+        os.path.join(repo_root, path),
+        os.path.join(repo_root, "src", "remote_debug_mcp", path),
+        os.path.join(os.path.expanduser("~"), ".config", "remote-debug-mcp", path),
+    ]
+    for p in search_paths:
+        if os.path.exists(p):
+            return p
+    return search_paths[0]  # default to cwd
+
+
+def load_config(path: str = "config.yaml") -> AppConfig:
+    """加载配置文件，自动搜索多个路径。"""
+    found = _find_config_path(path)
+    if os.path.exists(found):
+        with open(found, "r", encoding="utf-8") as f:
+            return _parse_yaml_simple(f.read())
+    raise FileNotFoundError(f"Config file not found: {path}")
+
+
+def _build_yaml(config: AppConfig) -> str:
+    """将 AppConfig 序列化为 YAML 字符串。"""
+    lines = ["# 远程调试连接配置文件",
+             "# 支持 SSH 连接和 com2tcp 串口映射配置",
+             "",
+             "connections:"]
+    for c in config.ssh_connections:
+        lines.append(f"  - name: {c.name}")
+        lines.append("    type: ssh")
+        lines.append(f"    host: \"{c.host}\"")
+        lines.append(f"    port: {c.port}")
+        lines.append(f"    username: \"{c.username}\"")
+        lines.append(f"    password: \"{c.password}\"")
+        if c.key_file:
+            lines.append(f"    key_file: \"{c.key_file}\"")
+        lines.append("")
+    for c in config.com2tcp_connections:
+        lines.append(f"  - name: {c.name}")
+        lines.append("    type: com2tcp")
+        lines.append(f"    ssh: \"{c.ssh}\"")
+        lines.append(f"    com_port: \"{c.com_port}\"")
+        lines.append(f"    telnet_port: {c.telnet_port}")
+        lines.append(f"    baud: {c.baud}")
+        if c.username:
+            lines.append(f"    username: \"{c.username}\"")
+        if c.password:
+            lines.append(f"    password: \"{c.password}\"")
+        if c.connect_timeout != 15:
+            lines.append(f"    connect_timeout: {c.connect_timeout}")
+        if c.buffer_max_size != 65536:
+            lines.append(f"    buffer_max_size: {c.buffer_max_size}")
+        if c.max_retries != 3:
+            lines.append(f"    max_retries: {c.max_retries}")
+        lines.append("")
+    return "\n".join(lines) + "\n"
+
+
+def save_config(config: AppConfig, path: str = "config.yaml") -> str:
+    """保存当前配置到 YAML 文件。"""
+    output_path = os.path.join(os.getcwd(), path)
+    with open(output_path, "w", encoding="utf-8") as f:
+        f.write(_build_yaml(config))
+    ssh_count = len(config.ssh_connections)
+    c2t_count = len(config.com2tcp_connections)
+    return (f"Config saved: {output_path}\n"
+            f"  SSH connections: {ssh_count}\n"
+            f"  com2tcp entries: {c2t_count}")
+
+
+_config: Optional[AppConfig] = None
+
+
+def get_config(path: str = "config.yaml") -> AppConfig:
+    global _config
+    if _config is None:
+        _config = load_config(path)
+    return _config
+
+
+def reload_config(path: str = "config.yaml") -> AppConfig:
+    global _config
+    _config = load_config(path)
+    return _config