mcp-ssh-pty 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,149 @@
+# mcp-ssh-pty
+
+MCP Server for SSH remote command execution with PTY shell support.
+
+## Installation
+
+```bash
+npm install -g mcp-ssh-pty
+```
+
+### Add to Claude Code
+
+```bash
+claude mcp add ssh -- npx -y mcp-ssh-pty
+```
+
+## CLI Commands
+
+### List servers
+
+```bash
+mcp-ssh-pty list           # Auto-detect config level
+mcp-ssh-pty list --local   # Project level only
+mcp-ssh-pty list --global  # User level only
+mcp-ssh-pty list --all     # Show both levels
+```
+
+### Add server
+
+```bash
+# Interactive mode (will ask for config level)
+mcp-ssh-pty add
+
+# Save to project level
+mcp-ssh-pty add my-server -l -H 192.168.1.100 -u root -k ~/.ssh/id_rsa
+
+# Save to user level
+mcp-ssh-pty add my-server -g -H 192.168.1.100 -u root -p mypassword
+```
+
+### Remove server
+
+```bash
+mcp-ssh-pty remove my-server
+mcp-ssh-pty remove --local   # From project level
+mcp-ssh-pty remove --global  # From user level
+```
+
+### Test connection
+
+```bash
+mcp-ssh-pty test my-server
+```
+
+### Interactive configuration
+
+```bash
+mcp-ssh-pty config
+```
+
+```
+? 选择配置级别:
+❯ 📁 项目级别 (已存在)
+  🌐 用户级别 (新建)
+
+? 选择操作:
+❯ 📋 查看所有服务器
+  ➕ 添加服务器
+  ✏️  编辑服务器
+  🗑️  删除服务器
+  🔌 测试连接
+  🔄 切换配置级别
+  📁 显示配置文件路径
+  🚪 退出
+```
+
+## Configuration
+
+### Config file locations
+
+| Level | Path | Priority |
+|-------|------|----------|
+| Project | `./.claude/ssh-servers.json` | High |
+| User | `~/.claude/ssh-servers.json` | Low |
+| Custom | `SSH_MCP_CONFIG_PATH` env | Highest |
+
+Project level config overrides user level when exists.
+
+### Config format
+
+```json
+{
+  "servers": [
+    {
+      "name": "my-server",
+      "host": "192.168.1.100",
+      "port": 22,
+      "username": "root",
+      "privateKeyPath": "~/.ssh/id_rsa"
+    }
+  ]
+}
+```
+
+## MCP Usage
+
+### Connection
+
+```
+ssh({ action: "list" })
+ssh({ action: "connect", server: "my-server" })
+ssh({ action: "status" })
+ssh({ action: "disconnect" })
+```
+
+### Command Execution
+
+```
+ssh({ command: "ls -la" })
+ssh({ command: "whoami" })
+```
+
+### Interactive Programs
+
+```
+ssh({ command: "mysql -u root -p" })
+ssh({ command: "password123" })
+ssh({ command: "SHOW DATABASES;" })
+```
+
+### Read Buffer
+
+```
+ssh({ read: true })                # Last 20 lines
+ssh({ read: true, lines: -1 })     # All
+ssh({ read: true, lines: 100 })    # 100 lines
+```
+
+### Signal Control
+
+```
+ssh({ command: "tail -f /var/log/syslog" })
+ssh({ read: true })
+ssh({ signal: "SIGINT" })          # Ctrl+C
+```
+
+## License
+
+MIT

package/dist/cli.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+/**
+ * 创建 CLI 程序
+ */
+export declare function createCLI(): Command;
+export declare function runCLI(): Promise<void>;

package/dist/cli.js

@@ -0,0 +1,536 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { select, input, password, confirm } from "@inquirer/prompts";
+import { ConfigManager } from "./config.js";
+import { SSHManager } from "./ssh-manager.js";
+/**
+ * 获取 ConfigManager 实例
+ */
+function getConfigManager(scope) {
+    return new ConfigManager(undefined, scope);
+}
+/**
+ * 格式化服务器信息显示（隐藏敏感信息）
+ */
+function formatServer(server) {
+    const auth = server.privateKeyPath ? `key:${server.privateKeyPath}` : "password";
+    return `${server.name} (${server.username}@${server.host}:${server.port || 22}) [${auth}]`;
+}
+/**
+ * 格式化 scope 显示
+ */
+function formatScope(scope) {
+    return scope === "local" ? "📁 项目级别" : "🌐 用户级别";
+}
+/**
+ * list 命令
+ */
+async function listServers(options) {
+    if (options.all) {
+        // 显示两个级别的配置
+        console.log("=== 项目级别 (local) ===");
+        console.log(`路径: ${ConfigManager.getLocalPath()}`);
+        if (ConfigManager.localConfigExists()) {
+            const localManager = new ConfigManager(undefined, "local");
+            const localServers = localManager.listServers();
+            if (localServers.length === 0) {
+                console.log("(空)\n");
+            }
+            else {
+                localServers.forEach((s, i) => console.log(`  ${i + 1}. ${formatServer(s)}`));
+                console.log("");
+            }
+        }
+        else {
+            console.log("(不存在)\n");
+        }
+        console.log("=== 用户级别 (global) ===");
+        console.log(`路径: ${ConfigManager.getGlobalPath()}`);
+        if (ConfigManager.globalConfigExists()) {
+            const globalManager = new ConfigManager(undefined, "global");
+            const globalServers = globalManager.listServers();
+            if (globalServers.length === 0) {
+                console.log("(空)");
+            }
+            else {
+                globalServers.forEach((s, i) => console.log(`  ${i + 1}. ${formatServer(s)}`));
+            }
+        }
+        else {
+            console.log("(不存在)");
+        }
+        return;
+    }
+    const scope = options.local ? "local" : options.global ? "global" : undefined;
+    const configManager = getConfigManager(scope);
+    const servers = configManager.listServers();
+    console.log(`配置级别: ${formatScope(configManager.getScope())}`);
+    console.log(`配置文件: ${configManager.getConfigPath()}\n`);
+    if (servers.length === 0) {
+        console.log("没有配置任何服务器");
+        console.log("\n使用 'mcp-ssh-pty add' 添加服务器");
+        return;
+    }
+    console.log("已配置的服务器:\n");
+    servers.forEach((server, index) => {
+        console.log(`  ${index + 1}. ${formatServer(server)}`);
+    });
+}
+/**
+ * add 命令 - 支持参数和交互式
+ */
+async function addServer(name, options) {
+    // 确定配置级别
+    let scope;
+    if (options?.local) {
+        scope = "local";
+    }
+    else if (options?.global) {
+        scope = "global";
+    }
+    else {
+        // 交互式选择
+        scope = await select({
+            message: "保存到哪个级别?",
+            choices: [
+                { name: "📁 项目级别 (当前目录/.claude/)", value: "local" },
+                { name: "🌐 用户级别 (~/.claude/)", value: "global" },
+            ],
+        });
+    }
+    const configManager = getConfigManager(scope);
+    let serverName = name;
+    let host = options?.host;
+    let port = options?.port ? parseInt(options.port) : 22;
+    let username = options?.user;
+    let authPassword = options?.password;
+    let privateKeyPath = options?.key;
+    let passphrase = options?.passphrase;
+    // 交互式获取缺失的参数
+    if (!serverName) {
+        serverName = await input({
+            message: "服务器名称:",
+            validate: (v) => v.trim() ? true : "名称不能为空",
+        });
+    }
+    if (!host) {
+        host = await input({
+            message: "主机地址:",
+            validate: (v) => v.trim() ? true : "地址不能为空",
+        });
+    }
+    if (!options?.port) {
+        const portStr = await input({
+            message: "端口:",
+            default: "22",
+        });
+        port = parseInt(portStr) || 22;
+    }
+    if (!username) {
+        username = await input({
+            message: "用户名:",
+            validate: (v) => v.trim() ? true : "用户名不能为空",
+        });
+    }
+    // 认证方式
+    if (!authPassword && !privateKeyPath) {
+        const authType = await select({
+            message: "认证方式:",
+            choices: [
+                { name: "私钥", value: "key" },
+                { name: "密码", value: "password" },
+            ],
+        });
+        if (authType === "key") {
+            privateKeyPath = await input({
+                message: "私钥路径:",
+                default: "~/.ssh/id_rsa",
+            });
+            const needPassphrase = await confirm({
+                message: "私钥是否有密码保护?",
+                default: false,
+            });
+            if (needPassphrase) {
+                passphrase = await password({
+                    message: "私钥密码:",
+                });
+            }
+        }
+        else {
+            authPassword = await password({
+                message: "登录密码:",
+            });
+        }
+    }
+    const server = {
+        name: serverName,
+        host,
+        port,
+        username,
+    };
+    if (privateKeyPath) {
+        server.privateKeyPath = privateKeyPath;
+        if (passphrase) {
+            server.passphrase = passphrase;
+        }
+    }
+    else if (authPassword) {
+        server.password = authPassword;
+    }
+    // 检查是否已存在
+    const existing = configManager.getServer(serverName);
+    if (existing) {
+        const overwrite = await confirm({
+            message: `服务器 '${serverName}' 已存在，是否覆盖?`,
+            default: false,
+        });
+        if (!overwrite) {
+            console.log("已取消");
+            return;
+        }
+    }
+    configManager.addServer(server);
+    console.log(`\n✓ 服务器 '${serverName}' 已添加`);
+    console.log(`  级别: ${formatScope(scope)}`);
+    console.log(`  配置文件: ${configManager.getConfigPath()}`);
+}
+/**
+ * remove 命令
+ */
+async function removeServer(name, options) {
+    const scope = options?.local ? "local" : options?.global ? "global" : undefined;
+    const configManager = getConfigManager(scope);
+    const servers = configManager.listServers();
+    console.log(`配置级别: ${formatScope(configManager.getScope())}\n`);
+    if (servers.length === 0) {
+        console.log("没有配置任何服务器");
+        return;
+    }
+    let serverName = name;
+    if (!serverName) {
+        serverName = await select({
+            message: "选择要删除的服务器:",
+            choices: servers.map((s) => ({
+                name: formatServer(s),
+                value: s.name,
+            })),
+        });
+    }
+    const server = configManager.getServer(serverName);
+    if (!server) {
+        console.log(`服务器 '${serverName}' 不存在`);
+        return;
+    }
+    const confirmed = await confirm({
+        message: `确定要删除服务器 '${serverName}' 吗?`,
+        default: false,
+    });
+    if (!confirmed) {
+        console.log("已取消");
+        return;
+    }
+    configManager.removeServer(serverName);
+    console.log(`\n✓ 服务器 '${serverName}' 已删除`);
+}
+/**
+ * test 命令 - 测试连接
+ */
+async function testServer(name, options) {
+    const scope = options?.local ? "local" : options?.global ? "global" : undefined;
+    const configManager = getConfigManager(scope);
+    const servers = configManager.listServers();
+    if (servers.length === 0) {
+        console.log("没有配置任何服务器");
+        return;
+    }
+    let serverName = name;
+    if (!serverName) {
+        serverName = await select({
+            message: "选择要测试的服务器:",
+            choices: servers.map((s) => ({
+                name: formatServer(s),
+                value: s.name,
+            })),
+        });
+    }
+    const server = configManager.getServer(serverName);
+    if (!server) {
+        console.log(`服务器 '${serverName}' 不存在`);
+        return;
+    }
+    console.log(`\n测试连接到 '${serverName}'...`);
+    const sshManager = new SSHManager();
+    try {
+        await sshManager.connect(server);
+        console.log("✓ 连接成功!");
+        // 执行简单命令测试
+        const shellManager = sshManager.getShellManager();
+        const result = await shellManager.send("echo 'SSH connection test successful'");
+        if (result.complete) {
+            console.log("✓ Shell 正常工作");
+        }
+        await sshManager.disconnect();
+        console.log("✓ 已断开连接");
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.log(`✗ 连接失败: ${message}`);
+        process.exit(1);
+    }
+}
+/**
+ * config 命令 - 交互式配置
+ */
+async function interactiveConfig() {
+    // 先选择配置级别
+    const scope = await select({
+        message: "选择配置级别:",
+        choices: [
+            {
+                name: `📁 项目级别 (${ConfigManager.localConfigExists() ? "已存在" : "新建"})`,
+                value: "local",
+            },
+            {
+                name: `🌐 用户级别 (${ConfigManager.globalConfigExists() ? "已存在" : "新建"})`,
+                value: "global",
+            },
+        ],
+    });
+    const configManager = getConfigManager(scope);
+    console.log(`\n当前配置: ${formatScope(scope)}`);
+    console.log(`路径: ${configManager.getConfigPath()}\n`);
+    while (true) {
+        const action = await select({
+            message: "选择操作:",
+            choices: [
+                { name: "📋 查看所有服务器", value: "list" },
+                { name: "➕ 添加服务器", value: "add" },
+                { name: "✏️  编辑服务器", value: "edit" },
+                { name: "🗑️  删除服务器", value: "remove" },
+                { name: "🔌 测试连接", value: "test" },
+                { name: "🔄 切换配置级别", value: "switch" },
+                { name: "📁 显示配置文件路径", value: "path" },
+                { name: "🚪 退出", value: "exit" },
+            ],
+        });
+        console.log("");
+        switch (action) {
+            case "list": {
+                const servers = configManager.listServers();
+                if (servers.length === 0) {
+                    console.log("没有配置任何服务器");
+                }
+                else {
+                    servers.forEach((s, i) => console.log(`  ${i + 1}. ${formatServer(s)}`));
+                }
+                break;
+            }
+            case "add":
+                await addServerToManager(configManager);
+                break;
+            case "edit": {
+                const servers = configManager.listServers();
+                if (servers.length === 0) {
+                    console.log("没有配置任何服务器");
+                    break;
+                }
+                const editName = await select({
+                    message: "选择要编辑的服务器:",
+                    choices: servers.map((s) => ({
+                        name: formatServer(s),
+                        value: s.name,
+                    })),
+                });
+                const server = configManager.getServer(editName);
+                if (server) {
+                    console.log("\n当前配置:");
+                    console.log(`  名称: ${server.name}`);
+                    console.log(`  主机: ${server.host}`);
+                    console.log(`  端口: ${server.port || 22}`);
+                    console.log(`  用户: ${server.username}`);
+                    console.log(`  认证: ${server.privateKeyPath ? `私钥(${server.privateKeyPath})` : "密码"}`);
+                    console.log("\n重新输入新配置:\n");
+                    await addServerToManager(configManager, server.name);
+                }
+                break;
+            }
+            case "remove": {
+                const servers = configManager.listServers();
+                if (servers.length === 0) {
+                    console.log("没有配置任何服务器");
+                    break;
+                }
+                const removeName = await select({
+                    message: "选择要删除的服务器:",
+                    choices: servers.map((s) => ({
+                        name: formatServer(s),
+                        value: s.name,
+                    })),
+                });
+                const confirmed = await confirm({
+                    message: `确定要删除服务器 '${removeName}' 吗?`,
+                    default: false,
+                });
+                if (confirmed) {
+                    configManager.removeServer(removeName);
+                    console.log(`✓ 服务器 '${removeName}' 已删除`);
+                }
+                else {
+                    console.log("已取消");
+                }
+                break;
+            }
+            case "test": {
+                const servers = configManager.listServers();
+                if (servers.length === 0) {
+                    console.log("没有配置任何服务器");
+                    break;
+                }
+                const testName = await select({
+                    message: "选择要测试的服务器:",
+                    choices: servers.map((s) => ({
+                        name: formatServer(s),
+                        value: s.name,
+                    })),
+                });
+                const server = configManager.getServer(testName);
+                if (server) {
+                    console.log(`\n测试连接到 '${testName}'...`);
+                    const sshManager = new SSHManager();
+                    try {
+                        await sshManager.connect(server);
+                        console.log("✓ 连接成功!");
+                        await sshManager.disconnect();
+                        console.log("✓ 已断开连接");
+                    }
+                    catch (error) {
+                        const message = error instanceof Error ? error.message : String(error);
+                        console.log(`✗ 连接失败: ${message}`);
+                    }
+                }
+                break;
+            }
+            case "switch":
+                // 递归调用，切换级别
+                return interactiveConfig();
+            case "path":
+                console.log(`配置级别: ${formatScope(scope)}`);
+                console.log(`配置文件路径: ${configManager.getConfigPath()}`);
+                console.log(`文件是否存在: ${configManager.configExists() ? "是" : "否"}`);
+                break;
+            case "exit":
+                console.log("再见!");
+                return;
+        }
+        console.log("");
+    }
+}
+/**
+ * 向指定 ConfigManager 添加服务器
+ */
+async function addServerToManager(configManager, existingName) {
+    const serverName = existingName || await input({
+        message: "服务器名称:",
+        validate: (v) => v.trim() ? true : "名称不能为空",
+    });
+    const host = await input({
+        message: "主机地址:",
+        validate: (v) => v.trim() ? true : "地址不能为空",
+    });
+    const portStr = await input({
+        message: "端口:",
+        default: "22",
+    });
+    const port = parseInt(portStr) || 22;
+    const username = await input({
+        message: "用户名:",
+        validate: (v) => v.trim() ? true : "用户名不能为空",
+    });
+    const authType = await select({
+        message: "认证方式:",
+        choices: [
+            { name: "私钥", value: "key" },
+            { name: "密码", value: "password" },
+        ],
+    });
+    const server = {
+        name: serverName,
+        host,
+        port,
+        username,
+    };
+    if (authType === "key") {
+        server.privateKeyPath = await input({
+            message: "私钥路径:",
+            default: "~/.ssh/id_rsa",
+        });
+        const needPassphrase = await confirm({
+            message: "私钥是否有密码保护?",
+            default: false,
+        });
+        if (needPassphrase) {
+            server.passphrase = await password({
+                message: "私钥密码:",
+            });
+        }
+    }
+    else {
+        server.password = await password({
+            message: "登录密码:",
+        });
+    }
+    configManager.addServer(server);
+    console.log(`\n✓ 服务器 '${serverName}' 已保存`);
+}
+/**
+ * 创建 CLI 程序
+ */
+export function createCLI() {
+    const program = new Command();
+    program
+        .name("mcp-ssh-pty")
+        .description("SSH MCP Server with PTY shell support")
+        .version("1.0.0");
+    program
+        .command("list")
+        .description("列出所有已配置的服务器")
+        .option("-l, --local", "只显示项目级别配置")
+        .option("-g, --global", "只显示用户级别配置")
+        .option("-a, --all", "显示所有级别配置")
+        .action(listServers);
+    program
+        .command("add [name]")
+        .description("添加新服务器")
+        .option("-l, --local", "保存到项目级别")
+        .option("-g, --global", "保存到用户级别")
+        .option("-H, --host <host>", "主机地址")
+        .option("-P, --port <port>", "端口", "22")
+        .option("-u, --user <user>", "用户名")
+        .option("-p, --password <password>", "密码")
+        .option("-k, --key <path>", "私钥路径")
+        .option("--passphrase <passphrase>", "私钥密码")
+        .action(addServer);
+    program
+        .command("remove [name]")
+        .alias("rm")
+        .description("删除服务器")
+        .option("-l, --local", "从项目级别删除")
+        .option("-g, --global", "从用户级别删除")
+        .action(removeServer);
+    program
+        .command("test [name]")
+        .description("测试服务器连接")
+        .option("-l, --local", "使用项目级别配置")
+        .option("-g, --global", "使用用户级别配置")
+        .action(testServer);
+    program
+        .command("config")
+        .description("交互式配置管理")
+        .action(interactiveConfig);
+    return program;
+}
+// 如果直接运行此文件
+export async function runCLI() {
+    const program = createCLI();
+    await program.parseAsync(process.argv);
+}