@jahrulnr/mcp-ssh-agentic
v0.4.6
Published
MCP server for agentic passwordless SSH/SCP with ControlMaster connection reuse
Downloads
1,110
Readme
mcp-ssh-agentic
An MCP server for agentic SSH/SCP operations with passwordless authentication. It uses the operating system's native ssh and scp binaries, so existing SSH features continue to work seamlessly, including public key authentication, ~/.ssh/config, ssh-agent, ProxyJump, and known_hosts.
Connection Efficiency
On Linux and macOS, each target uses SSH ControlMaster multiplexing:
- Socket:
~/.cache/mcp-ssh-agentic/mux/<hash> ControlPersist=600(master connection stays alive for 10 minutes of idle time)- Subsequent calls to the same host reuse the existing TCP connection and authentication
- Stale sockets are automatically removed and the connection is retried once
ssh_closeexplicitly closes the master connection
Windows (cmd / PowerShell / Git Bash)
Native Win32-OpenSSH does not support ControlMaster (this affects all three common Windows shells — they share the same ssh.exe). Multiplexing is disabled by default on win32; every tool call opens a fresh SSH connection. Behavior is otherwise the same.
| Client | Mux default | Notes |
|---|---|---|
| Windows cmd.exe | off | Uses Win32-OpenSSH |
| Windows PowerShell / pwsh | off | Same OpenSSH client |
| Git Bash | off | Usually the same Win32-OpenSSH on PATH |
| WSL (Ubuntu, etc.) | on | Runs as Linux — preferred on Windows for connection reuse |
| macOS / Linux | on | Full ControlMaster support |
If a ControlMaster error is still seen (for example after forcing mux on), the server auto-disables multiplexing for the rest of the process and retries without it.
Override with env:
{
"mcpServers": {
"ssh-agentic": {
"command": "npx",
"args": ["-y", "@jahrulnr/mcp-ssh-agentic"],
"env": {
"MCP_SSH_AGENTIC_MUX": "0"
}
}
}
}MCP_SSH_AGENTIC_MUX=0— force off (also:false,no,off)MCP_SSH_AGENTIC_MUX=1— force on (only if yoursshactually supports ControlMaster)
Running with npx
After a release, the package is on npmjs and GitHub Packages as @jahrulnr/mcp-ssh-agentic.
npmjs (simplest):
{
"mcpServers": {
"ssh-agentic": {
"command": "npx",
"args": ["-y", "@jahrulnr/mcp-ssh-agentic"]
}
}
}GitHub Packages (needs a PAT with read:packages in ~/.npmrc):
@jahrulnr:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT{
"mcpServers": {
"ssh-agentic": {
"command": "npx",
"args": ["-y", "--registry=https://npm.pkg.github.com", "@jahrulnr/mcp-ssh-agentic"]
}
}
}Targets must always be specified as user@host[:port], for example [email protected]:22. The port may also be configured through aliases in ~/.ssh/config.
Available Tools
ssh_ping, ssh_read_file, ssh_write_file, ssh_read_image, ssh_list_dir, ssh_mkdir, ssh_grep, ssh_apply_patch, ssh_delete, ssh_exec, ssh_interactive_exec, ssh_interactive_input, ssh_interactive_close, ssh_interactive_list, ssh_scp_to, ssh_scp_from, ssh_close
Examples:
ssh_read_file("[email protected]:22", "/etc/hostname")
ssh_write_file("demo@server", "/srv/app/.env", "PORT=3000\n")
ssh_mkdir("demo@server", "/srv/app/releases/42")
ssh_list_dir("demo@server", "/var/log")
ssh_grep("demo@server", "TODO", "/srv/app", "*.js")
ssh_exec("demo@server", "systemctl --user status my-service")
# Commands that may require interactive input (sudo password, y/N prompts, setup wizards):
ssh_interactive_exec("demo@server", "sudo apt-get upgrade")
# -> session_id=abc123, status=running, output contains "[sudo] password for demo:"
ssh_interactive_input(session_id="abc123", input="secret123")
# -> additional output, e.g. "Do you want to continue? [Y/n]"
ssh_interactive_input(session_id="abc123", input="Y")
# -> status=exited (code 0) once the process finishes
ssh_interactive_close("abc123") # close manually if needed
ssh_scp_to("demo@server", "./dist/app.tar.gz", "/apps/app.tar.gz")
ssh_scp_from("demo@server", "/apps/backups/db.sql.gz", "./db.sql.gz")
ssh_close("demo@server")Behavior Notes
ssh_deleteusesrm -ffor files andrm -rfonly whenrecursive=true.ssh_write_filewrites or overwrites a remote file directly from text (without creating a temporary local file). Useappend=trueto append instead of overwrite. Parent directories are created automatically unlesscreate_dirs=false.ssh_mkdiris equivalent tomkdir -pon the remote host, which is especially useful beforessh_scp_to, sincescpdoes not automatically create remote parent directories.ssh_exechas a default timeout of 30 seconds and a maximum output size of 5 MiB.ssh_read_imagesupports files up to 20 MiB.ssh_write_fileaccepts content up to 5 MiB. SCP operations default to a 120-second timeout.- All remote commands (not just
ssh_exec) run through a non-login, non-interactive shell (bash --noprofile --norc -c, falling back tosh -c). This avoids failures caused by broken/etc/profile.dscripts on some servers and ensures consistent behavior across all tools.ssh_execalways returnsexit_code=Nalong with stdout. If stderr is present, it is included in a[stderr]section. Non-zero exit codes setisError, but stdout is still returned. - Interactive sessions (TTY/PTY):
ssh_interactive_execforces PTY allocation on the remote side (ssh -tt), allowing programs that require a real terminal (sudo,passwd, confirmation prompts, setup wizards, REPLs, etc.) to behave correctly even though the local side uses ordinary pipes. The server waits until output has been quiet forquiet_ms(default: 500 ms) or the process exits, then returns the collected output along with asession_id. Continue the session usingssh_interactive_input(leaveinputempty to simply wait for more output without sending anything). This mechanism is based on output inactivity rather than prompt detection. Commands that continuously produce output (such as long build logs) may cause the tool call to wait longer depending onquiet_msandmaxWaitMs. The server allows up to 8 concurrent interactive sessions, automatically cleans up sessions after 10 minutes of inactivity, and terminates all active sessions when the server exits. Usessh_interactive_listto view active sessions andssh_interactive_closeto close them manually. ssh_greptreats "no matches" as a successful result and still returns partial matches even if some paths cannot be read.ssh_scp_toandssh_scp_fromsupportrecursive=truefor directories. Local parent directories are created automatically when downloading. Remote parent directories must already exist before uploading (usessh_mkdirif needed).- The SSH and SCP clients are invoked with
-qto suppress MOTD and other unnecessary output on stderr.
Local Development
npm install
npm run check
npm test
npm startUnit tests use createMockTransport() — the same SSH contract (exec / scp / close / spawnInteractive) executed in a local sandbox, without a real SSH host.
To test the MCP protocol, use MCP Inspector or any MCP client that supports stdio transport.
CI / Release
GitHub Actions (.github/workflows/ci.yml):
- Unit test (any branch/PR) — Node 18 / 22 / 24 →
npm run check+npm run test:unit - MCP test (after unit) — same Node matrix × (
nodebin |npxfromnpm pack) withMCP_SSH_AGENTIC_MOCK=1 - Push to
master— after both pass, if tagvX.Y.Zis new: create tag → publish to GitHub Packages + npmjs
Local: npm run test:all
Bump version in package.json before merging to master for a new release. Re-merging the same version skips tag/publish.
Secrets: NPM_TOKEN. GitHub Packages uses GITHUB_TOKEN (packages: write).
