@pyrokine/mcp-ssh 1.0.0 → 1.1.2

package/README.md

@@ -8,21 +8,27 @@ A comprehensive SSH MCP Server for AI assistants (Claude, Cursor, Windsurf, etc.
 [![Node](https://img.shields.io/badge/node-%3E%3D18-green.svg)](https://nodejs.org/)
 [![MCP](https://img.shields.io/badge/MCP-compatible-purple.svg)](https://modelcontextprotocol.io/)
 
+![Linux](https://img.shields.io/badge/Linux-tested-success)
+![macOS](https://img.shields.io/badge/macOS-untested-yellow)
+![Windows](https://img.shields.io/badge/Windows-untested-yellow)
+
 ## Features
 
 - **Multiple Authentication**: Password, SSH key, SSH agent
+- **SSH Config Support**: Read `~/.ssh/config` with Host aliases, `Host *` inheritance, ProxyJump (`user@host:port`)
 - **Connection Management**: Connection pooling, keepalive, auto-reconnect
 - **Session Persistence**: Sessions info saved for reconnection
 - **Command Execution**:
-  - Basic exec with timeout
-  - PTY mode (for interactive commands like `top`, `htop`)
-  - `sudo` execution
-  - `su` (switch user) execution - *run commands as different user*
-  - Batch execution
+    - Basic exec with timeout
+    - PTY mode (for interactive commands like `top`, `htop`)
+    - `sudo` execution
+    - `su` (switch user) execution - *run commands as different user*
+    - Batch execution
+    - Parallel execution on multiple hosts
 - **Persistent PTY Sessions**: For long-running interactive commands (top, htop, tmux, vim, etc.)
-  - Output buffering with polling read
-  - Send keystrokes and commands
-  - Window resize support
+    - Output buffering with polling read
+    - Send keystrokes and commands
+    - Window resize support
 - **File Operations**: Upload, download, read, write, list directory (via SFTP)
 - **Smart Sync**: Directory sync with rsync (auto-fallback to SFTP if rsync unavailable)
 - **Environment Configuration**: LANG, LC_ALL, custom env vars
@@ -30,21 +36,29 @@ A comprehensive SSH MCP Server for AI assistants (Claude, Cursor, Windsurf, etc.
 
 ## Compatible Clients
 
-| Client | Status |
-|--------|--------|
-| Claude Code | ✅ |
-| Claude Desktop | ✅ |
-| Cursor | ✅ |
-| Windsurf | ✅ |
-| Continue.dev | ✅ |
-| Cline | ✅ |
-| Any MCP-compatible client | ✅ |
+| Client                    | Status |
+|---------------------------|--------|
+| Claude Code               | ✅      |
+| Claude Desktop            | ✅      |
+| Cursor                    | ✅      |
+| Windsurf                  | ✅      |
+| Continue.dev              | ✅      |
+| Cline                     | ✅      |
+| Any MCP-compatible client | ✅      |
 
 ## Installation
 
+### npm (Recommended)
+
+```bash
+npm install -g @pyrokine/mcp-ssh
+```
+
+### From Source
+
 ```bash
 git clone https://github.com/Pyrokine/claude-mcp-tools.git
-cd claude-mcp-tools/ssh
+cd claude-mcp-tools/mcp-ssh
 npm install
 npm run build
 ```
@@ -72,68 +86,135 @@ Add to your MCP settings (e.g., `~/.claude/settings.json` or client-specific con
 }
 ```
 
-## Available Tools (27 tools)
+## Available Tools (29 tools)
 
 ### Connection Management
 
-| Tool | Description |
-|------|-------------|
-| `ssh_connect` | Establish SSH connection with keepalive |
-| `ssh_disconnect` | Close connection |
-| `ssh_list_sessions` | List active sessions |
-| `ssh_reconnect` | Reconnect a disconnected session |
+| Tool                | Description                                       |
+|---------------------|---------------------------------------------------|
+| `ssh_connect`       | Establish SSH connection (supports ~/.ssh/config) |
+| `ssh_disconnect`    | Close connection                                  |
+| `ssh_list_sessions` | List active sessions                              |
+| `ssh_reconnect`     | Reconnect a disconnected session                  |
+| `ssh_config_list`   | List hosts from ~/.ssh/config                     |
 
 ### Command Execution
 
-| Tool | Description |
-|------|-------------|
-| `ssh_exec` | Execute command (supports PTY mode) |
-| `ssh_exec_as_user` | Execute as different user (via `su`) |
-| `ssh_exec_sudo` | Execute with `sudo` |
-| `ssh_exec_batch` | Execute multiple commands sequentially |
-| `ssh_quick_exec` | One-shot: connect, execute, disconnect |
+| Tool                | Description                                   |
+|---------------------|-----------------------------------------------|
+| `ssh_exec`          | Execute command (supports PTY mode)           |
+| `ssh_exec_as_user`  | Execute as different user (via `su`)          |
+| `ssh_exec_sudo`     | Execute with `sudo`                           |
+| `ssh_exec_batch`    | Execute multiple commands sequentially        |
+| `ssh_exec_parallel` | Execute command on multiple hosts in parallel |
+| `ssh_quick_exec`    | One-shot: connect, execute, disconnect        |
 
 ### File Operations
 
-| Tool | Description |
-|------|-------------|
-| `ssh_upload` | Upload local file to remote server |
-| `ssh_download` | Download remote file to local |
-| `ssh_read_file` | Read remote file content |
-| `ssh_write_file` | Write content to remote file |
-| `ssh_list_dir` | List remote directory contents |
-| `ssh_file_info` | Get file/directory metadata |
-| `ssh_mkdir` | Create remote directory |
-| `ssh_sync` | Smart sync with rsync (fallback to SFTP) |
+| Tool             | Description                              |
+|------------------|------------------------------------------|
+| `ssh_upload`     | Upload local file to remote server       |
+| `ssh_download`   | Download remote file to local            |
+| `ssh_read_file`  | Read remote file content                 |
+| `ssh_write_file` | Write content to remote file             |
+| `ssh_list_dir`   | List remote directory contents           |
+| `ssh_file_info`  | Get file/directory metadata              |
+| `ssh_mkdir`      | Create remote directory                  |
+| `ssh_sync`       | Smart sync with rsync (fallback to SFTP) |
 
 ### PTY Sessions (Persistent Interactive Terminal)
 
-| Tool | Description |
-|------|-------------|
-| `ssh_pty_start` | Start persistent PTY session (for top, htop, tmux, etc.) |
-| `ssh_pty_write` | Send data to PTY (keystrokes, commands) |
-| `ssh_pty_read` | Read PTY output (screen mode: current screen, raw mode: ANSI stream) |
-| `ssh_pty_resize` | Resize PTY window |
-| `ssh_pty_close` | Close PTY session |
-| `ssh_pty_list` | List all PTY sessions |
+| Tool             | Description                                                          |
+|------------------|----------------------------------------------------------------------|
+| `ssh_pty_start`  | Start persistent PTY session (for top, htop, tmux, etc.)             |
+| `ssh_pty_write`  | Send data to PTY (keystrokes, commands)                              |
+| `ssh_pty_read`   | Read PTY output (screen mode: current screen, raw mode: ANSI stream) |
+| `ssh_pty_resize` | Resize PTY window                                                    |
+| `ssh_pty_close`  | Close PTY session                                                    |
+| `ssh_pty_list`   | List all PTY sessions                                                |
 
 ### Port Forwarding
 
-| Tool | Description |
-|------|-------------|
-| `ssh_forward_local` | Local port forwarding (ssh -L): access remote services |
+| Tool                 | Description                                            |
+|----------------------|--------------------------------------------------------|
+| `ssh_forward_local`  | Local port forwarding (ssh -L): access remote services |
 | `ssh_forward_remote` | Remote port forwarding (ssh -R): expose local services |
-| `ssh_forward_close` | Close port forwarding |
-| `ssh_forward_list` | List all port forwards |
+| `ssh_forward_close`  | Close port forwarding                                  |
+| `ssh_forward_list`   | List all port forwards                                 |
 
 ## Usage Examples
 
+### Using SSH Config (Recommended)
+
+If you have hosts configured in `~/.ssh/config`:
+
+```
+# List available hosts
+ssh_config_list()
+
+# Connect using config host name
+ssh_connect(configHost="myserver")
+ssh_exec(alias="myserver", command="uptime")
+
+# Use custom config file path
+ssh_connect(configHost="myserver", configPath="/custom/path/config")
+```
+
+Supported SSH config features:
+
+- `Host` with multiple aliases (e.g., `Host a b c`)
+- `Host *` global defaults inheritance (first `Host *` block only)
+- `HostName`, `User`, `Port`, `IdentityFile`
+- `ProxyJump` with `user@host:port` format (first hop only)
+- Explicit parameters override config values (e.g., `ssh_connect(configHost="x", user="override")`)
+
+**Not supported** (skipped):
+
+- `Include` directive
+- `Match` blocks (entire block skipped until next `Host`)
+- Wildcard patterns (e.g., `Host *.example.com`)
+
+**Behavior notes**:
+
+- Multiple `Host *` blocks: only first is used
+- Duplicate Host definitions: `ssh_config_list` shows all, `ssh_connect` uses first
+- IPv6 in ProxyJump: use bracket notation `[2001:db8::1]:22`
+
+### Parallel Execution on Multiple Hosts
+
+Execute the same command on multiple connected hosts:
+
+```
+1. ssh_connect(configHost="server1")
+2. ssh_connect(configHost="server2")
+3. ssh_connect(configHost="server3")
+4. ssh_exec_parallel(aliases=["server1", "server2", "server3"], command="uptime")
+```
+
 ### Basic: Connect and Execute
 
 ```
-1. ssh_connect(host="192.168.1.100", user="root", password="xxx", alias="myserver")
-2. ssh_exec(alias="myserver", command="ls -la /home")
-3. ssh_disconnect(alias="myserver")
+ssh_connect(host="192.168.1.100", user="root", keyPath="/home/.ssh/id_rsa", alias="myserver")
+ssh_exec(alias="myserver", command="ls -la /home")
+ssh_disconnect(alias="myserver")
+```
+
+### Jump Host (Bastion)
+
+Connect to internal server via jump host:
+
+```
+ssh_connect(
+  host="10.0.0.5",
+  user="root",
+  keyPath="/home/.ssh/id_rsa",
+  alias="internal",
+  jumpHost={
+    host: "bastion.example.com",
+    user: "admin",
+    keyPath: "/home/.ssh/bastion_key"
+  }
+)
 ```
 
 ### Switch User Execution (su)
@@ -146,6 +227,10 @@ Perfect for scenarios where you SSH as root but need to run commands as another
    // Output: appuser
 ```
 
+By default, shell profile is loaded to ensure environment variables are available (since `su -c` creates a
+non-interactive shell which doesn't execute rc files). Supports bash (`.bashrc`), zsh (`.zshrc`), and other shells (
+`.profile`). Disable with `loadProfile=false` if not needed.
+
 ### Interactive Commands (PTY mode)
 
 For commands that need a terminal:
@@ -228,7 +313,8 @@ ssh_sync(..., dryRun=true)
 
 If rsync is not available on remote or local, it automatically falls back to SFTP.
 
-**Note**: rsync mode uses SSH key/agent authentication and disables strict host key checking (`StrictHostKeyChecking=no`) for convenience. If you require host key verification, use SFTP mode instead.
+**Note**: rsync mode uses SSH key/agent authentication and disables strict host key checking (
+`StrictHostKeyChecking=no`) for convenience. If you require host key verification, use SFTP mode instead.
 
 ### Persistent PTY Sessions (top, tmux, etc.)
 
@@ -267,6 +353,7 @@ ssh_pty_write(ptyId="pty_1_xxx", data="\x02d")
 ```
 
 Common control sequences:
+
 - Enter: `\r` or `\n`
 - Ctrl+C: `\x03`
 - Ctrl+D: `\x04`
@@ -296,25 +383,25 @@ ssh_forward_close(forwardId="fwd_1_xxx")
 
 ### Connection Options
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `host` | string | *required* | Server address |
-| `user` | string | *required* | Username |
-| `password` | string | - | Password authentication |
-| `keyPath` | string | - | Path to SSH private key |
-| `port` | number | 22 | SSH port |
-| `alias` | string | auto-generated | Connection alias for reference |
-| `env` | object | - | Environment variables |
-| `keepaliveInterval` | number | 30000 | Keepalive interval in ms |
+| Option              | Type   | Default        | Description                    |
+|---------------------|--------|----------------|--------------------------------|
+| `host`              | string | *required*     | Server address                 |
+| `user`              | string | *required*     | Username                       |
+| `password`          | string | -              | Password authentication        |
+| `keyPath`           | string | -              | Path to SSH private key        |
+| `port`              | number | 22             | SSH port                       |
+| `alias`             | string | auto-generated | Connection alias for reference |
+| `env`               | object | -              | Environment variables          |
+| `keepaliveInterval` | number | 30000          | Keepalive interval in ms       |
 
 ### Exec Options
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `timeout` | number | 30000 | Command timeout in ms |
-| `cwd` | string | - | Working directory |
-| `env` | object | - | Additional environment variables |
-| `pty` | boolean | false | Enable PTY mode for interactive commands |
+| Option    | Type    | Default | Description                              |
+|-----------|---------|---------|------------------------------------------|
+| `timeout` | number  | 30000   | Command timeout in ms                    |
+| `cwd`     | string  | -       | Working directory                        |
+| `env`     | object  | -       | Additional environment variables         |
+| `pty`     | boolean | false   | Enable PTY mode for interactive commands |
 
 ## Project Structure
 
@@ -331,14 +418,6 @@ mcp-ssh/
 └── README.md
 ```
 
-## Roadmap
-
-- [ ] Dynamic port forwarding (SOCKS proxy)
-- [ ] SSH Agent forwarding
-- [ ] Command history and audit logging
-- [ ] Multi-host parallel execution
-- [ ] SSH config file (~/.ssh/config) auto-discovery
-
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/README_zh.md

@@ -8,21 +8,27 @@
 [![Node](https://img.shields.io/badge/node-%3E%3D18-green.svg)](https://nodejs.org/)
 [![MCP](https://img.shields.io/badge/MCP-compatible-purple.svg)](https://modelcontextprotocol.io/)
 
+![Linux](https://img.shields.io/badge/Linux-tested-success)
+![macOS](https://img.shields.io/badge/macOS-untested-yellow)
+![Windows](https://img.shields.io/badge/Windows-untested-yellow)
+
 ## 功能特性
 
 - **多种认证方式**：密码、SSH 密钥、SSH Agent
+- **SSH Config 支持**：读取 `~/.ssh/config`，支持 Host 多别名、`Host *` 继承、ProxyJump（`user@host:port` 格式）
 - **连接管理**：连接池复用、心跳保持、自动重连
 - **会话持久化**：会话信息保存，支持重连
 - **命令执行**：
-  - 基础执行（带超时）
-  - PTY 模式（用于 `top`、`htop` 等交互式命令）
-  - `sudo` 执行
-  - `su` 切换用户执行
-  - 批量执行
+    - 基础执行（带超时）
+    - PTY 模式（用于 `top`、`htop` 等交互式命令）
+    - `sudo` 执行
+    - `su` 切换用户执行
+    - 批量执行
+    - 多主机并行执行
 - **持久化 PTY 会话**：用于长时间运行的交互式命令（top、htop、tmux、vim 等）
-  - 输出缓冲区，支持轮询读取
-  - 发送按键和命令
-  - 窗口大小调整
+    - 输出缓冲区，支持轮询读取
+    - 发送按键和命令
+    - 窗口大小调整
 - **文件操作**：上传、下载、读取、写入、目录列表（通过 SFTP）
 - **智能同步**：目录同步，优先使用 rsync（无 rsync 时自动回退到 SFTP）
 - **环境配置**：LANG、LC_ALL、自定义环境变量
@@ -30,21 +36,29 @@
 
 ## 兼容客户端
 
-| 客户端 | 状态 |
-|--------|------|
-| Claude Code | ✅ |
-| Claude Desktop | ✅ |
-| Cursor | ✅ |
-| Windsurf | ✅ |
-| Continue.dev | ✅ |
-| Cline | ✅ |
-| 其他 MCP 兼容客户端 | ✅ |
+| 客户端            | 状态 |
+|----------------|----|
+| Claude Code    | ✅  |
+| Claude Desktop | ✅  |
+| Cursor         | ✅  |
+| Windsurf       | ✅  |
+| Continue.dev   | ✅  |
+| Cline          | ✅  |
+| 其他 MCP 兼容客户端   | ✅  |
 
 ## 安装
 
+### npm（推荐）
+
+```bash
+npm install -g @pyrokine/mcp-ssh
+```
+
+### 从源码安装
+
 ```bash
 git clone https://github.com/Pyrokine/claude-mcp-tools.git
-cd claude-mcp-tools/ssh
+cd claude-mcp-tools/mcp-ssh
 npm install
 npm run build
 ```
@@ -72,68 +86,135 @@ claude mcp add ssh -- node /path/to/mcp-ssh/dist/index.js
 }
 ```
 
-## 可用工具（27 个）
+## 可用工具（29 个）
 
 ### 连接管理
 
-| 工具 | 描述 |
-|------|------|
-| `ssh_connect` | 建立 SSH 连接并保持心跳 |
-| `ssh_disconnect` | 关闭连接 |
-| `ssh_list_sessions` | 列出活跃会话 |
-| `ssh_reconnect` | 重新连接断开的会话 |
+| 工具                  | 描述                          |
+|---------------------|-----------------------------|
+| `ssh_connect`       | 建立 SSH 连接（支持 ~/.ssh/config） |
+| `ssh_disconnect`    | 关闭连接                        |
+| `ssh_list_sessions` | 列出活跃会话                      |
+| `ssh_reconnect`     | 重新连接断开的会话                   |
+| `ssh_config_list`   | 列出 ~/.ssh/config 中的 Host    |
 
 ### 命令执行
 
-| 工具 | 描述 |
-|------|------|
-| `ssh_exec` | 执行命令（支持 PTY 模式） |
-| `ssh_exec_as_user` | 以其他用户身份执行（通过 `su`） |
-| `ssh_exec_sudo` | 使用 `sudo` 执行 |
-| `ssh_exec_batch` | 批量执行多条命令 |
-| `ssh_quick_exec` | 一次性执行：连接、执行、断开 |
+| 工具                  | 描述                 |
+|---------------------|--------------------|
+| `ssh_exec`          | 执行命令（支持 PTY 模式）    |
+| `ssh_exec_as_user`  | 以其他用户身份执行（通过 `su`） |
+| `ssh_exec_sudo`     | 使用 `sudo` 执行       |
+| `ssh_exec_batch`    | 批量执行多条命令           |
+| `ssh_exec_parallel` | 在多台主机上并行执行命令       |
+| `ssh_quick_exec`    | 一次性执行：连接、执行、断开     |
 
 ### 文件操作
 
-| 工具 | 描述 |
-|------|------|
-| `ssh_upload` | 上传本地文件到远程 |
-| `ssh_download` | 从远程下载文件到本地 |
-| `ssh_read_file` | 读取远程文件内容 |
-| `ssh_write_file` | 写入内容到远程文件 |
-| `ssh_list_dir` | 列出远程目录内容 |
-| `ssh_file_info` | 获取文件/目录元数据 |
-| `ssh_mkdir` | 创建远程目录 |
-| `ssh_sync` | 智能同步（优先 rsync，回退 SFTP） |
+| 工具               | 描述                     |
+|------------------|------------------------|
+| `ssh_upload`     | 上传本地文件到远程              |
+| `ssh_download`   | 从远程下载文件到本地             |
+| `ssh_read_file`  | 读取远程文件内容               |
+| `ssh_write_file` | 写入内容到远程文件              |
+| `ssh_list_dir`   | 列出远程目录内容               |
+| `ssh_file_info`  | 获取文件/目录元数据             |
+| `ssh_mkdir`      | 创建远程目录                 |
+| `ssh_sync`       | 智能同步（优先 rsync，回退 SFTP） |
 
 ### PTY 会话（持久化交互式终端）
 
-| 工具 | 描述 |
-|------|------|
-| `ssh_pty_start` | 启动持久化 PTY 会话（用于 top、htop、tmux 等） |
-| `ssh_pty_write` | 向 PTY 发送数据（按键、命令） |
-| `ssh_pty_read` | 读取 PTY 输出（screen 模式：当前屏幕，raw 模式：ANSI 流） |
-| `ssh_pty_resize` | 调整 PTY 窗口大小 |
-| `ssh_pty_close` | 关闭 PTY 会话 |
-| `ssh_pty_list` | 列出所有 PTY 会话 |
+| 工具               | 描述                                      |
+|------------------|-----------------------------------------|
+| `ssh_pty_start`  | 启动持久化 PTY 会话（用于 top、htop、tmux 等）        |
+| `ssh_pty_write`  | 向 PTY 发送数据（按键、命令）                       |
+| `ssh_pty_read`   | 读取 PTY 输出（screen 模式：当前屏幕，raw 模式：ANSI 流） |
+| `ssh_pty_resize` | 调整 PTY 窗口大小                             |
+| `ssh_pty_close`  | 关闭 PTY 会话                               |
+| `ssh_pty_list`   | 列出所有 PTY 会话                             |
 
 ### 端口转发
 
-| 工具 | 描述 |
-|------|------|
-| `ssh_forward_local` | 本地端口转发（ssh -L）：访问远程服务 |
+| 工具                   | 描述                    |
+|----------------------|-----------------------|
+| `ssh_forward_local`  | 本地端口转发（ssh -L）：访问远程服务 |
 | `ssh_forward_remote` | 远程端口转发（ssh -R）：暴露本地服务 |
-| `ssh_forward_close` | 关闭端口转发 |
-| `ssh_forward_list` | 列出所有端口转发 |
+| `ssh_forward_close`  | 关闭端口转发                |
+| `ssh_forward_list`   | 列出所有端口转发              |
 
 ## 使用示例
 
+### 使用 SSH Config（推荐）
+
+如果已在 `~/.ssh/config` 中配置了主机：
+
+```
+# 列出可用主机
+ssh_config_list()
+
+# 使用配置的主机名连接
+ssh_connect(configHost="myserver")
+ssh_exec(alias="myserver", command="uptime")
+
+# 使用自定义配置文件路径
+ssh_connect(configHost="myserver", configPath="/custom/path/config")
+```
+
+支持的 SSH config 特性：
+
+- `Host` 多别名（如 `Host a b c`）
+- `Host *` 全局默认继承（仅第一个 `Host *` 块）
+- `HostName`、`User`、`Port`、`IdentityFile`
+- `ProxyJump`，支持 `user@host:port` 格式（仅第一跳）
+- 显式参数优先于 config 值（如 `ssh_connect(configHost="x", user="覆盖值")`）
+
+**不支持**（跳过）：
+
+- `Include` 指令
+- `Match` 块（整个块跳过直到下一个 `Host`）
+- 通配符模式（如 `Host *.example.com`）
+
+**行为说明**：
+
+- 多个 `Host *` 块：仅使用第一个
+- 重复的 Host 定义：`ssh_config_list` 显示全部，`ssh_connect` 使用第一个
+- ProxyJump 中的 IPv6：使用方括号格式 `[2001:db8::1]:22`
+
+### 多主机并行执行
+
+在多个已连接的主机上并行执行同一命令：
+
+```
+1. ssh_connect(configHost="server1")
+2. ssh_connect(configHost="server2")
+3. ssh_connect(configHost="server3")
+4. ssh_exec_parallel(aliases=["server1", "server2", "server3"], command="uptime")
+```
+
 ### 基础：连接和执行
 
 ```
-1. ssh_connect(host="192.168.1.100", user="root", password="xxx", alias="myserver")
-2. ssh_exec(alias="myserver", command="ls -la /home")
-3. ssh_disconnect(alias="myserver")
+ssh_connect(host="192.168.1.100", user="root", keyPath="/home/.ssh/id_rsa", alias="myserver")
+ssh_exec(alias="myserver", command="ls -la /home")
+ssh_disconnect(alias="myserver")
+```
+
+### 跳板机
+
+通过跳板机连接内网服务器：
+
+```
+ssh_connect(
+  host="10.0.0.5",
+  user="root",
+  keyPath="/home/.ssh/id_rsa",
+  alias="internal",
+  jumpHost={
+    host: "bastion.example.com",
+    user: "admin",
+    keyPath: "/home/.ssh/bastion_key"
+  }
+)
 ```
 
 ### 切换用户执行（su）
@@ -146,6 +227,9 @@ claude mcp add ssh -- node /path/to/mcp-ssh/dist/index.js
    // 输出: appuser
 ```
 
+默认加载 shell 配置以确保环境变量可用（`su -c` 创建非交互式 shell，不会自动执行 rc 文件）。支持 bash（`.bashrc`）、zsh（`.zshrc`
+）及其他 shell（`.profile`）。如不需要可设置 `loadProfile=false`。
+
 ### 交互式命令（PTY 模式）
 
 用于需要终端的命令：
@@ -228,7 +312,8 @@ ssh_sync(..., dryRun=true)
 
 如果远程或本地没有 rsync，会自动回退到 SFTP。
 
-**注意**：rsync 模式使用 SSH 密钥/代理认证，并禁用严格主机密钥检查（`StrictHostKeyChecking=no`）以方便使用。如需主机密钥验证，请使用 SFTP 模式。
+**注意**：rsync 模式使用 SSH 密钥/代理认证，并禁用严格主机密钥检查（`StrictHostKeyChecking=no`）以方便使用。如需主机密钥验证，请使用
+SFTP 模式。
 
 ### 持久化 PTY 会话（top、tmux 等）
 
@@ -267,6 +352,7 @@ ssh_pty_write(ptyId="pty_1_xxx", data="\x02d")
 ```
 
 常用控制序列：
+
 - 回车: `\r` 或 `\n`
 - Ctrl+C: `\x03`
 - Ctrl+D: `\x04`
@@ -296,25 +382,25 @@ ssh_forward_close(forwardId="fwd_1_xxx")
 
 ### 连接选项
 
-| 选项 | 类型 | 默认值 | 描述 |
-|------|------|--------|------|
-| `host` | string | *必需* | 服务器地址 |
-| `user` | string | *必需* | 用户名 |
-| `password` | string | - | 密码认证 |
-| `keyPath` | string | - | SSH 私钥路径 |
-| `port` | number | 22 | SSH 端口 |
-| `alias` | string | 自动生成 | 连接别名，用于后续引用 |
-| `env` | object | - | 环境变量 |
-| `keepaliveInterval` | number | 30000 | 心跳间隔（毫秒） |
+| 选项                  | 类型     | 默认值   | 描述          |
+|---------------------|--------|-------|-------------|
+| `host`              | string | *必需*  | 服务器地址       |
+| `user`              | string | *必需*  | 用户名         |
+| `password`          | string | -     | 密码认证        |
+| `keyPath`           | string | -     | SSH 私钥路径    |
+| `port`              | number | 22    | SSH 端口      |
+| `alias`             | string | 自动生成  | 连接别名，用于后续引用 |
+| `env`               | object | -     | 环境变量        |
+| `keepaliveInterval` | number | 30000 | 心跳间隔（毫秒）    |
 
 ### 执行选项
 
-| 选项 | 类型 | 默认值 | 描述 |
-|------|------|--------|------|
-| `timeout` | number | 30000 | 命令超时（毫秒） |
-| `cwd` | string | - | 工作目录 |
-| `env` | object | - | 额外环境变量 |
-| `pty` | boolean | false | 启用 PTY 模式（用于交互式命令） |
+| 选项        | 类型      | 默认值   | 描述                 |
+|-----------|---------|-------|--------------------|
+| `timeout` | number  | 30000 | 命令超时（毫秒）           |
+| `cwd`     | string  | -     | 工作目录               |
+| `env`     | object  | -     | 额外环境变量             |
+| `pty`     | boolean | false | 启用 PTY 模式（用于交互式命令） |
 
 ## 项目结构
 
@@ -331,14 +417,6 @@ mcp-ssh/
 └── README.md
 ```
 
-## 路线图
-
-- [ ] 动态端口转发（SOCKS 代理）
-- [ ] SSH Agent 转发
-- [ ] 命令历史和审计日志
-- [ ] 多主机并行执行
-- [ ] SSH 配置文件（~/.ssh/config）自动发现
-
 ## 贡献
 
 欢迎贡献！请随时提交 Pull Request。