@pyrokine/mcp-ssh 1.0.0 → 1.1.2

package/dist/file-ops.js

@@ -1,9 +1,9 @@
 /**
  * SSH File Operations - 文件操作
  */
+import { execSync } from 'child_process';
 import * as fs from 'fs';
 import * as path from 'path';
-import { execSync } from 'child_process';
 import { sessionManager } from './session-manager.js';
 /**
  * 上传文件
@@ -20,12 +20,14 @@ export async function uploadFile(alias, localPath, remotePath, onProgress) {
         const writeStream = sftp.createWriteStream(remotePath);
         let settled = false;
         const cleanup = (err) => {
-            if (settled)
+            if (settled) {
                 return;
+            }
             settled = true;
             sftp.end();
-            if (err)
+            if (err) {
                 reject(err);
+            }
         };
         let transferred = 0;
         readStream.on('data', (chunk) => {
@@ -58,10 +60,12 @@ export async function downloadFile(alias, remotePath, localPath, onProgress) {
     // 获取远程文件大小
     const stats = await new Promise((resolve, reject) => {
         sftp.stat(remotePath, (err, stats) => {
-            if (err)
+            if (err) {
                 reject(err);
-            else
+            }
+            else {
                 resolve(stats);
+            }
         });
     });
     const totalSize = stats.size;
@@ -75,12 +79,14 @@ export async function downloadFile(alias, remotePath, localPath, onProgress) {
         const writeStream = fs.createWriteStream(localPath);
         let settled = false;
         const cleanup = (err) => {
-            if (settled)
+            if (settled) {
                 return;
+            }
             settled = true;
             sftp.end();
-            if (err)
+            if (err) {
                 reject(err);
+            }
         };
         let transferred = 0;
         readStream.on('data', (chunk) => {
@@ -108,16 +114,17 @@ export async function downloadFile(alias, remotePath, localPath, onProgress) {
 /**
  * 读取远程文件内容
  */
-export async function readFile(alias, remotePath, maxBytes = 1024 * 1024 // 默认最大 1MB
-) {
+export async function readFile(alias, remotePath, maxBytes = 1024 * 1024) {
     const sftp = await sessionManager.getSftp(alias);
     // 获取文件大小
     const stats = await new Promise((resolve, reject) => {
         sftp.stat(remotePath, (err, stats) => {
-            if (err)
+            if (err) {
                 reject(err);
-            else
+            }
+            else {
                 resolve(stats);
+            }
         });
     });
     const actualSize = stats.size;
@@ -264,10 +271,12 @@ export async function mkdir(alias, remotePath, recursive = false) {
     return new Promise((resolve, reject) => {
         sftp.mkdir(remotePath, (err) => {
             sftp.end();
-            if (err)
+            if (err) {
                 reject(err);
-            else
+            }
+            else {
                 resolve(true);
+            }
         });
     });
 }
@@ -279,10 +288,12 @@ export async function removeFile(alias, remotePath) {
     return new Promise((resolve, reject) => {
         sftp.unlink(remotePath, (err) => {
             sftp.end();
-            if (err)
+            if (err) {
                 reject(err);
-            else
+            }
+            else {
                 resolve(true);
+            }
         });
     });
 }
@@ -323,7 +334,7 @@ export async function syncFiles(alias, localPath, remotePath, direction, options
  * 转义 shell 路径参数
  */
 function escapeShellPath(p) {
-    return `'${p.replace(/'/g, "'\\''")}'`;
+    return `'${p.replace(/'/g, '\'\\\'\'')}'`;
 }
 /**
  * 使用 rsync 同步文件
@@ -336,7 +347,8 @@ async function syncWithRsync(alias, localPath, remotePath, direction, options) {
         execSync('which rsync', { stdio: 'pipe' });
         hasLocalRsync = true;
     }
-    catch { }
+    catch {
+    }
     if (!hasLocalRsync) {
         // 本地没有 rsync，回退到 SFTP
         return syncWithSftp(alias, localPath, remotePath, direction, options);
@@ -374,13 +386,16 @@ async function syncWithRsync(alias, localPath, remotePath, direction, options) {
         const result = execSync(rsyncCmd, {
             encoding: 'utf-8',
             timeout: 600000, // 10 分钟超时
-            stdio: ['pipe', 'pipe', 'pipe']
+            stdio: ['pipe', 'pipe', 'pipe'],
         });
         // 解析 rsync 输出统计文件数
         const lines = result.split('\n');
         let filesTransferred = 0;
         for (const line of lines) {
-            if (line.trim() && !line.startsWith('sending') && !line.startsWith('receiving') && !line.startsWith('total')) {
+            if (line.trim() &&
+                !line.startsWith('sending') &&
+                !line.startsWith('receiving') &&
+                !line.startsWith('total')) {
                 filesTransferred++;
             }
         }
@@ -409,7 +424,8 @@ async function syncWithSftp(alias, localPath, remotePath, direction, options) {
         return {
             success: true,
             method: 'sftp',
-            output: 'Dry run mode: would transfer files via SFTP' + (warnings.length ? `. Warning: ${warnings.join('; ')}` : ''),
+            output: 'Dry run mode: would transfer files via SFTP' +
+                (warnings.length ? `. Warning: ${warnings.join('; ')}` : ''),
         };
     }
     try {

package/dist/index.js

@@ -15,9 +15,10 @@
  */
 import { Server } from '@modelcontextprotocol/sdk/server/index.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import { CallToolRequestSchema, ListToolsRequestSchema, } from '@modelcontextprotocol/sdk/types.js';
-import { sessionManager } from './session-manager.js';
+import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
 import * as fileOps from './file-ops.js';
+import { sessionManager } from './session-manager.js';
+import { parseProxyJump, parseSSHConfig } from './ssh-config.js';
 // 创建 MCP Server
 const server = new Server({
     name: 'ssh-mcp-pro',
@@ -34,28 +35,43 @@ const tools = [
         name: 'ssh_connect',
         description: `建立 SSH 连接并保持会话。支持密码、密钥认证，支持跳板机。
 
+可通过 configHost 参数使用 ~/.ssh/config 中的配置，无需重复填写连接信息。
+支持 Host 多别名、Host * 全局默认继承、ProxyJump（user@host:port 格式）。
+
 示例:
-- 密码认证: ssh_connect(host="192.168.1.1", user="root", password="xxx")
+- 使用 ssh config: ssh_connect(configHost="myserver")
 - 密钥认证: ssh_connect(host="192.168.1.1", user="root", keyPath="/home/.ssh/id_rsa")
-- 自定义别名: ssh_connect(..., alias="myserver")
-- 设置环境变量: ssh_connect(..., env={"LANG": "en_US.UTF-8"})`,
+- 跳板机: ssh_connect(host="内网IP", user="root", keyPath="...", jumpHost={host:"跳板机IP", user:"root", keyPath:"..."})`,
         inputSchema: {
             type: 'object',
             properties: {
-                host: { type: 'string', description: '服务器地址' },
-                user: { type: 'string', description: '用户名' },
-                password: { type: 'string', description: '密码（与 keyPath 二选一）' },
+                configHost: { type: 'string', description: '使用 ~/.ssh/config 中的 Host 配置（推荐）' },
+                configPath: { type: 'string', description: 'SSH 配置文件路径（默认 ~/.ssh/config）' },
+                host: { type: 'string', description: '服务器地址（使用 configHost 时可省略）' },
+                user: { type: 'string', description: '用户名（使用 configHost 时可省略）' },
+                password: { type: 'string', description: '密码' },
                 keyPath: { type: 'string', description: 'SSH 私钥路径' },
-                port: { type: 'number', description: 'SSH 端口，默认 22', default: 22 },
-                alias: { type: 'string', description: '连接别名（可选，用于后续引用）' },
+                port: { type: 'number', description: 'SSH 端口，默认 22' },
+                alias: { type: 'string', description: '连接别名（可选，默认使用 configHost 或 host）' },
                 env: {
                     type: 'object',
-                    description: '环境变量，如 {"LANG": "en_US.UTF-8"}',
+                    description: '环境变量',
                     additionalProperties: { type: 'string' },
                 },
                 keepaliveInterval: { type: 'number', description: '心跳间隔（毫秒），默认 30000' },
+                jumpHost: {
+                    type: 'object',
+                    description: '跳板机配置',
+                    properties: {
+                        host: { type: 'string', description: '跳板机地址' },
+                        user: { type: 'string', description: '跳板机用户名' },
+                        password: { type: 'string', description: '跳板机密码' },
+                        keyPath: { type: 'string', description: '跳板机私钥路径' },
+                        port: { type: 'number', description: '跳板机端口，默认 22' },
+                    },
+                    required: ['host', 'user'],
+                },
             },
-            required: ['host', 'user'],
         },
     },
     {
@@ -117,6 +133,9 @@ const tools = [
 
 适用场景: SSH 以 root 登录，但需要以其他用户（如 caros）执行命令。
 
+默认加载目标用户的 shell 配置以获取环境变量（su -c 创建非交互式 shell，不会自动执行 rc 文件）。
+支持 bash(.bashrc)、zsh(.zshrc) 及其他 shell(.profile)。
+
 示例: ssh_exec_as_user(alias="server", command="whoami", targetUser="caros")`,
         inputSchema: {
             type: 'object',
@@ -125,6 +144,7 @@ const tools = [
                 command: { type: 'string', description: '要执行的命令' },
                 targetUser: { type: 'string', description: '目标用户名' },
                 timeout: { type: 'number', description: '超时（毫秒）' },
+                loadProfile: { type: 'boolean', description: '是否加载 .bashrc（默认 true）' },
             },
             required: ['alias', 'command', 'targetUser'],
         },
@@ -380,7 +400,11 @@ rsync 可实现增量传输，对大目录同步效率更高。
             type: 'object',
             properties: {
                 ptyId: { type: 'string', description: 'PTY 会话 ID' },
-                mode: { type: 'string', enum: ['screen', 'raw'], description: '输出模式：screen（当前屏幕）或 raw（原始流），默认 screen' },
+                mode: {
+                    type: 'string',
+                    enum: ['screen', 'raw'],
+                    description: '输出模式：screen（当前屏幕）或 raw（原始流），默认 screen',
+                },
                 clear: { type: 'boolean', description: '(仅 raw 模式) 读取后是否清空缓冲区，默认 true' },
             },
             required: ['ptyId'],
@@ -480,6 +504,42 @@ rsync 可实现增量传输，对大目录同步效率更高。
             properties: {},
         },
     },
+    // ========== SSH Config ==========
+    {
+        name: 'ssh_config_list',
+        description: `列出 ~/.ssh/config 中配置的所有 Host。
+
+返回每个 Host 的配置信息（别名、地址、用户、端口、密钥路径等）。`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                configPath: { type: 'string', description: 'SSH 配置文件路径（默认 ~/.ssh/config）' },
+            },
+        },
+    },
+    // ========== 批量执行 ==========
+    {
+        name: 'ssh_exec_parallel',
+        description: `在多个已连接的会话上并行执行同一命令。
+
+示例：
+- ssh_exec_parallel(aliases=["server1", "server2"], command="uptime")
+
+返回每个主机的执行结果。`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                aliases: {
+                    type: 'array',
+                    items: { type: 'string' },
+                    description: '连接别名列表',
+                },
+                command: { type: 'string', description: '要执行的命令' },
+                timeout: { type: 'number', description: '每个命令的超时（毫秒），默认 30000' },
+            },
+            required: ['aliases', 'command'],
+        },
+    },
 ];
 // 注册工具列表
 server.setRequestHandler(ListToolsRequestSchema, async () => ({
@@ -493,20 +553,78 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
         switch (name) {
             // ========== 连接管理 ==========
             case 'ssh_connect': {
+                // 解析 configHost
+                let host = args.host;
+                let user = args.user;
+                let port = args.port;
+                let keyPath = args.keyPath;
+                const configPath = args.configPath;
+                let jumpHostResolved;
+                if (args.configHost) {
+                    const allHosts = parseSSHConfig(configPath);
+                    const hostConfig = allHosts.find(h => h.host === args.configHost);
+                    if (!hostConfig) {
+                        throw new Error(`Host '${args.configHost}' not found in SSH config`);
+                    }
+                    // 显式参数优先于 config 值
+                    host = host || hostConfig.hostName || hostConfig.host;
+                    user = user || hostConfig.user;
+                    port = port || hostConfig.port;
+                    keyPath = keyPath || hostConfig.identityFile;
+                    // 解析 ProxyJump（支持 user@host:port 格式）
+                    if (hostConfig.proxyJump) {
+                        const parsed = parseProxyJump(hostConfig.proxyJump);
+                        if (parsed) {
+                            // 先尝试在 config 中查找对应的 Host
+                            const jumpHostConfig = allHosts.find(h => h.host === parsed.host);
+                            if (jumpHostConfig) {
+                                // 使用 config 中的配置，但 parsed 的 user/port 优先
+                                jumpHostResolved = {
+                                    host: jumpHostConfig.hostName || jumpHostConfig.host,
+                                    port: parsed.port || jumpHostConfig.port || 22,
+                                    username: parsed.user || jumpHostConfig.user || 'root',
+                                    privateKeyPath: jumpHostConfig.identityFile,
+                                };
+                            }
+                            else {
+                                // 直接使用 parsed 的值
+                                jumpHostResolved = {
+                                    host: parsed.host,
+                                    port: parsed.port || 22,
+                                    username: parsed.user || 'root',
+                                };
+                            }
+                        }
+                    }
+                }
+                if (!host || !user) {
+                    throw new Error('host and user are required (either directly or via configHost)');
+                }
+                // 手动指定的 jumpHost 优先级高于 ProxyJump
+                const jumpHostArg = args.jumpHost;
+                const jumpHost = jumpHostArg ? {
+                    host: jumpHostArg.host,
+                    port: jumpHostArg.port || 22,
+                    username: jumpHostArg.user,
+                    password: jumpHostArg.password,
+                    privateKeyPath: jumpHostArg.keyPath,
+                } : jumpHostResolved;
                 const alias = await sessionManager.connect({
-                    host: args.host,
-                    port: args.port || 22,
-                    username: args.user,
+                    host,
+                    port: port || 22,
+                    username: user,
                     password: args.password,
-                    privateKeyPath: args.keyPath,
-                    alias: args.alias,
+                    privateKeyPath: keyPath,
+                    alias: args.alias ||
+                        args.configHost,
                     env: args.env,
                     keepaliveInterval: args.keepaliveInterval,
+                    jumpHost,
                 });
                 result = {
                     success: true,
                     alias,
-                    message: `Connected to ${args.user}@${args.host}:${args.port || 22}`,
+                    message: `Connected to ${user}@${host}:${port || 22}${jumpHost ? ' via jump host' : ''}`,
                 };
                 break;
             }
@@ -546,7 +664,10 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                 break;
             }
             case 'ssh_exec_as_user': {
-                const execResult = await sessionManager.execAsUser(args.alias, args.command, args.targetUser, { timeout: args.timeout });
+                const execResult = await sessionManager.execAsUser(args.alias, args.command, args.targetUser, {
+                    timeout: args.timeout,
+                    loadProfile: args.loadProfile,
+                });
                 result = execResult;
                 break;
             }
@@ -579,8 +700,9 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                             success: false,
                             error: err.message,
                         });
-                        if (stopOnError)
+                        if (stopOnError) {
                             break;
+                        }
                     }
                 }
                 result = {
@@ -732,7 +854,8 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     success: true,
                     forwardId,
                     type: 'local',
-                    message: `Local forward: ${args.localHost || '127.0.0.1'}:${args.localPort} -> ${args.remoteHost}:${args.remotePort}`,
+                    message: `Local forward: ${args.localHost ||
+                        '127.0.0.1'}:${args.localPort} -> ${args.remoteHost}:${args.remotePort}`,
                 };
                 break;
             }
@@ -742,7 +865,8 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     success: true,
                     forwardId,
                     type: 'remote',
-                    message: `Remote forward: ${args.remoteHost || '127.0.0.1'}:${args.remotePort} -> ${args.localHost}:${args.localPort}`,
+                    message: `Remote forward: ${args.remoteHost ||
+                        '127.0.0.1'}:${args.remotePort} -> ${args.localHost}:${args.localPort}`,
                 };
                 break;
             }
@@ -765,6 +889,56 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                 };
                 break;
             }
+            // ========== SSH Config ==========
+            case 'ssh_config_list': {
+                const hosts = parseSSHConfig(args.configPath);
+                result = {
+                    success: true,
+                    count: hosts.length,
+                    hosts: hosts.map(h => ({
+                        host: h.host,
+                        hostName: h.hostName,
+                        user: h.user,
+                        port: h.port,
+                        identityFile: h.identityFile,
+                        proxyJump: h.proxyJump,
+                    })),
+                };
+                break;
+            }
+            // ========== 批量执行 ==========
+            case 'ssh_exec_parallel': {
+                const aliases = args.aliases;
+                const command = args.command;
+                const timeout = args.timeout;
+                const execPromises = aliases.map(async (alias) => {
+                    try {
+                        const execResult = await sessionManager.exec(alias, command, { timeout });
+                        return {
+                            alias,
+                            success: execResult.success,
+                            exitCode: execResult.exitCode,
+                            stdout: execResult.stdout,
+                            stderr: execResult.stderr,
+                            duration: execResult.duration,
+                        };
+                    }
+                    catch (err) {
+                        return {
+                            alias,
+                            success: false,
+                            error: err.message,
+                        };
+                    }
+                });
+                const results = await Promise.all(execPromises);
+                result = {
+                    success: results.every(r => r.success),
+                    total: aliases.length,
+                    results,
+                };
+                break;
+            }
             default:
                 throw new Error(`Unknown tool: ${name}`);
         }

package/dist/session-manager.d.ts

@@ -8,7 +8,7 @@
  * - 会话持久化
  */
 import { Client, ClientChannel, SFTPWrapper } from 'ssh2';
-import { SSHConnectionConfig, SSHSessionInfo, ExecOptions, ExecResult, PersistedSession, PtyOptions, PtySessionInfo, PortForwardInfo } from './types.js';
+import { ExecOptions, ExecResult, PersistedSession, PortForwardInfo, PtyOptions, PtySessionInfo, SSHConnectionConfig, SSHSessionInfo } from './types.js';
 interface SSHSession {
     client: Client;
     config: SSHConnectionConfig;
@@ -37,23 +37,10 @@ export declare class SessionManager {
     private maxReconnectAttempts;
     private defaultPtyBufferSize;
     constructor(persistPath?: string);
-    private ensurePersistDir;
-    /**
-     * 生成连接别名
-     */
-    private generateAlias;
     /**
      * 建立 SSH 连接
      */
     connect(config: SSHConnectionConfig): Promise<string>;
-    /**
-     * 通过跳板机转发连接
-     */
-    private forwardConnection;
-    /**
-     * 检查连接是否存活
-     */
-    private isAlive;
     /**
      * 重新连接
      */
@@ -74,26 +61,20 @@ export declare class SessionManager {
      * 列出所有会话
      */
     listSessions(): SSHSessionInfo[];
-    /**
-     * 转义 shell 参数（使用单引号方式）
-     */
-    private escapeShellArg;
     /**
      * 执行命令
      */
     exec(alias: string, command: string, options?: ExecOptions): Promise<ExecResult>;
-    /**
-     * 校验用户名（只允许字母、数字、下划线、连字符）
-     */
-    private isValidUsername;
-    /**
-     * 校验环境变量名（只允许字母、数字、下划线，不能以数字开头）
-     */
-    private isValidEnvKey;
     /**
      * 以其他用户身份执行命令
+     * @param loadProfile 是否加载用户的 shell 配置（默认 true）。
+     *   su -c 创建非交互式 shell，不会自动执行 rc 文件，
+     *   但大多数用户的环境变量设置在 rc 文件中，因此默认加载。
+     *   支持 bash(.bashrc)、zsh(.zshrc) 及其他 shell(.profile)。
      */
-    execAsUser(alias: string, command: string, targetUser: string, options?: ExecOptions): Promise<ExecResult>;
+    execAsUser(alias: string, command: string, targetUser: string, options?: ExecOptions & {
+        loadProfile?: boolean;
+    }): Promise<ExecResult>;
     /**
      * 使用 sudo 执行命令
      */
@@ -102,18 +83,10 @@ export declare class SessionManager {
      * 获取 SFTP 客户端
      */
     getSftp(alias: string): Promise<SFTPWrapper>;
-    /**
-     * 持久化会话信息
-     */
-    private persistSessions;
     /**
      * 加载持久化的会话信息（仅用于显示，不自动重连）
      */
     loadPersistedSessions(): PersistedSession[];
-    /**
-     * 生成 PTY 会话 ID
-     */
-    private generatePtyId;
     /**
      * 启动持久化 PTY 会话
      */
@@ -122,10 +95,6 @@ export declare class SessionManager {
      * 向 PTY 写入数据
      */
     ptyWrite(ptyId: string, data: string): boolean;
-    /**
-     * 从终端仿真器获取当前屏幕内容
-     */
-    private getScreenContent;
     /**
      * 读取 PTY 输出
      * @param mode 'screen' 返回当前屏幕内容，'raw' 返回原始 ANSI 流
@@ -155,10 +124,6 @@ export declare class SessionManager {
      * 关闭所有 PTY 会话
      */
     ptyCloseAll(): number;
-    /**
-     * 生成端口转发 ID
-     */
-    private generateForwardId;
     /**
      * 创建本地端口转发
      * 本地监听 localHost:localPort，转发到远程 remoteHost:remotePort
@@ -169,6 +134,60 @@ export declare class SessionManager {
      * 远程监听 remoteHost:remotePort，转发到本地 localHost:localPort
      */
     forwardRemote(alias: string, remotePort: number, localHost: string, localPort: number, remoteHost?: string): Promise<string>;
+    /**
+     * 关闭端口转发
+     */
+    forwardClose(forwardId: string): boolean;
+    /**
+     * 列出所有端口转发
+     */
+    forwardList(): PortForwardInfo[];
+    private ensurePersistDir;
+    /**
+     * 生成连接别名
+     */
+    private generateAlias;
+    /**
+     * 通过跳板机转发连接
+     */
+    private forwardConnection;
+    /**
+     * 检查连接是否存活
+     */
+    private isAlive;
+    /**
+     * 转义 shell 参数（使用单引号方式）
+     */
+    private escapeShellArg;
+    /**
+     * 校验用户名（只允许字母、数字、下划线、连字符）
+     */
+    private isValidUsername;
+    /**
+     * 校验环境变量名（只允许字母、数字、下划线，不能以数字开头）
+     */
+    private isValidEnvKey;
+    /**
+     * 根据用户 shell 类型生成加载配置文件的命令
+     * bash → .bashrc, zsh → .zshrc, 其他 → .profile
+     */
+    private getLoadProfileCommand;
+    /**
+     * 持久化会话信息
+     */
+    private persistSessions;
+    /**
+     * 生成 PTY 会话 ID
+     */
+    private generatePtyId;
+    /**
+     * 从终端仿真器获取当前屏幕内容
+     */
+    private getScreenContent;
+    /**
+     * 生成端口转发 ID
+     */
+    private generateForwardId;
     /**
      * 确保 SSH session 有共享的 tcp connection dispatcher
      * 所有 remote forward 共用一个 dispatcher，根据 destIP/destPort 路由
@@ -180,14 +199,6 @@ export declare class SessionManager {
      * @param alias - session 的 map key
      */
     private removeTcpDispatcherIfEmpty;
-    /**
-     * 关闭端口转发
-     */
-    forwardClose(forwardId: string): boolean;
-    /**
-     * 列出所有端口转发
-     */
-    forwardList(): PortForwardInfo[];
 }
 export declare const sessionManager: SessionManager;
 export {};