SSH MCP Server
SSH MCP Server — AIエージェント向けリモートサーバーツール
お使いのマシンに既にあるOpenSSHクライアントを使用します:あなたのキー、~/.ssh/config、ジャンプホスト、エージェントフォワーディング。バンドルされるものはなく、コンパイルも不要、ネイティブバインディングもありません。
Claude Code、Codex CLI、opencode、Gemini CLI、Qwen Code、Hermes、その他のMCPクライアントで動作します。
インストール · ツール · セットアップ · セキュリティ · ロードマップ · ドキュメント · 変更履歴
30秒でインストール
グローバルインストールは不要です。npx が初回使用時にパッケージをダウンロードします:
npx -y @hypnosis/ssh-mcp-serverClaude Code にすべてのプロジェクトで追加:
claude mcp add ssh -s user \
-e SSH_PROFILES_FILE="$HOME/.claude/ssh-profiles.json" \
-- npx -y @hypnosis/ssh-mcp-server次に、少なくとも1台のマシンを指定して ~/.claude/ssh-profiles.json を作成します:
{
"profiles": {
"production": {
"host": "server.example.com",
"username": "admin",
"privateKeyPath": "~/.ssh/your_private_key"
}
}
}これで接続するのに十分です。
Codex、opencode、Qwen Code、その他のクライアントについては、SSH MCPサーバーのセットアップ で説明しています。
要件
Node.js 18+ と、PATH にシステムの ssh クライアントが必要です。Windowsではキーベースのプロファイルを使用してください。パスワードおよびパスフレーズのプロファイルは現在利用できません。
固定バージョンを好む場合、オフラインで作業する場合、または起動ごとのレジストリチェックを1回減らしたい場合は:npm install -g @hypnosis/ssh-mcp-server を実行し、npx の代わりに ssh-mcp-server コマンドを使用してください。
Related MCP server: cygnus-ssh-mcp
こんな人におすすめ
DevOpsおよびSRE — 監査、インシデントチェック、日常のサーバー作業を高速化したい方。
Vibeコーダーやインディービルダー — AIアシスタントと一緒に開発し、自分たちのサーバーで構築したものを運用している方。
システム管理者やプラットフォームエンジニア — 制限のない生のシェルではなく、構造化されたツールを求める方。
専任の運用チームなしで自前のVPSを運用する開発者や小規模チーム。
ホームラボ、NAS、ルーターの所有者 — 便利なハードウェアが現代のプロトコルに対応しきれなくなった方。
生のシェルではなくSSH MCPサーバーを使う理由
トークン削減、AIコスト削減
生のシェルはAIエージェントに消防ホースのような情報の奔流を与えます:繰り返されるコマンド、ASCIIテーブル、ログのダンプ。そのノイズをサーバーの全体像に変換するためにトークンを消費します — つまりあなたのお金です。
より高速なサーバーデバッグ
専用ツールは日常的なチェックをまとめて実行し、ノイズの多い出力を制限し、重要な部分だけを返します。エージェントはターミナル出力の解釈に費やす時間が減り、より早く修正に到達できます。
推測の減少、AIのミス削減
構造化された回答は、何が見つかったか、何を測定できなかったか、何が切り詰められたかを示します。これにより、エージェントが幻覚でギャップを埋める余地が減り — 悪い修正が減り、デプロイが安定し、より信頼性の高いコードになります。
SSH互換性:最新サーバー、レガシー機器、Windows
既存のOpenSSH設定を使用
バンドルされたSSH実装はなく、ネイティブバインディングもなく、プラットフォームごとの再ビルドもありません。コマンドはシステムの ssh クライアントを使用するため、あなたのキー、~/.ssh/config、ジャンプホスト、エージェントフォワーディングはすべて、ターミナルで行うのとまったく同じように機能し続けます。サポートされている場合、宛先ごとに1つの共有マルチプレックス接続を使用するため、認証は1回だけで済み、コマンドごとには行いません。
レガシーサーバー、ルーター、NASデバイスへのSSHサポート
最新の scp でルーターにファイルを送信すると、次のようになります:
scp app.conf router:/etc/
# scp: subsystem request failed on channel 0何も壊れていません — 現在の scp は新しいプロトコルで通信しますが、ルーターはそれを知りません。ターミナルでは、フォーラムのスレッドを読んで、追加のフラグを持って戻ってくることになります。ここでは何もする必要はありません:転送が試行され、拒否が認識され、代わりに古いプロトコルが使用され、そのマシンは記憶されるため、次のファイルは直接そこに送られます。
古いSSHクライアントと不足しているツールのためのフォールバック
古い機器には行き止まりではなくフォールバックがあります。最新の機能がない場合、サーバーは可能な限り古い方法を取ります:
お使いのマシン | 得られるもの |
最新のファイル転送には小さすぎるルーターやNAS | ファイルは問題なく届く — 古いプロトコルが自動的に使用される |
10年前のサーバー | ワークフローは引き続き機能する。接続を再利用する代わりに、コマンドごとに新しい接続を開くだけ |
ファイルのハッシュ化手段がない最小構成のイメージ | 誰も確認していない一致を主張する代わりに、アップロードは「検証できませんでした」と表示する |
ツールが単にインストールされていないマシン | 回答は「未測定」と表示 — 「何もない」と読めるゼロには決してならない |
Model Context Protocolのために構築
公式MCP SDK上に構築され、全体がTypeScriptで書かれ、2500以上のユニットテストに加えて、モックではなく実際のコンテナに対して実行されるライブスイートを備えています。
生のSSHとSSH MCPサーバー:同じ作業を両方の方法で
SSHサーバーのヘルスチェック
状況: デプロイが完了したばかりです。サーバーが遅く感じられますが、ディスク、メモリ、サービス、コンテナ、エラーのどれが原因かわかりません。
質問: 「このマシンは正常ですか?」
生のSSH
$ uptime
10:42:17 up 18 days, 3:21, 2 users, load average: 0.42, 0.31, 0.28
$ df -hT
Filesystem Type Size Used Avail Use% Mounted on
/dev/sda1 ext4 40G 35G 5.0G 87% /
overlay overlay 40G 35G 5.0G 87% /var/lib/docker/overlay2/...
$ free -h
total used free shared buff/cache available
Mem: 7.7Gi 4.9Gi 612Mi 121Mi 2.2Gi 2.5Gi
$ systemctl --failed
UNIT LOAD ACTIVE SUB DESCRIPTION
● api-worker.service loaded failed failed API background worker
$ docker ps -a
CONTAINER ID IMAGE STATUS PORTS
8e14d0b41c2a api:latest Up 3 minutes 0.0.0.0:8080->8080/tcp
65b894af2430 worker:latest Exited (1) 2 minutes ago
$ ss -tulpn
Netid State Local Address:Port Process
tcp LISTEN 0.0.0.0:22 users:(("sshd",pid=842,fd=3))
tcp LISTEN 0.0.0.0:8080 users:(("docker-proxy",pid=1942,fd=4))
$ journalctl -p err --since -1h | tail -50
Aug 20 10:39:14 prod api-worker[22104]: database connection timed out
Aug 20 10:39:14 prod systemd[1]: api-worker.service: Failed with result 'exit-code'.それでも省略された結果です。完全なチェックには、CPU、サービス状態、コンテナ数、最近のエラーについて、それぞれ独自の出力形式を持つ追加のコマンドが必要です。さらに悪いことに、ss がないマシンでは、ポートチェックが実行されなかった場合にリスナーがゼロのように見えることがあります。
構造化されたMCP結果
ssh_snapshot({ "profile": "production" }){
"disk_pct": 87,
"mem_pct": 64,
"cpu_pct": 12,
"load": "0.42 0.31 0.28",
"containers": 7,
"ports": 14,
"services_running": 3,
"recent_errors": 21,
"unavailable": []
}エージェントが得られるもの
生のSSH | 構造化されたMCP | 得られる利点 |
複数のコマンドとASCIIテーブル | 1つの結果に名前付きフィールド | 1回の呼び出し、名前付きフィールド、ラウンドトリップの削減 |
ツールがないと空の出力のように見えることがある |
| 推測が減り、悪い修正が減る |
ディスク、サービス、エラーを自分で整理する | 問題のシグナルがすでに表面化されている | より高速なデバッグ |
完全な ssh_audit_baseline の結果は、いくつかの生のコマンド出力よりも長くなることがあります — 当社のラボ測定では約1,077トークン対765トークンです。節約は完全なワークフローから生まれるのであって、1つのレスポンスを短くすることからではありません。
実際のトラブルシューティングセッションでは、専用ツールによって49回の個別コマンド呼び出しが4回のMCP呼び出しに削減されました。呼び出しが増えるごとに、蓄積された会話で別のモデルターンが開始されます。プロンプトキャッシングは繰り返し入力のコストを削減できますが、新しいコマンドとその出力は依然としてコンテキストを消費します。ラウンドトリップが少ないほど、セッション全体のトークンが減り、繰り返しの分析が減り、回答への道のりが速くなります。
脈拍ではなく全体像が必要ですか? ssh_audit_baseline は、システム、ディスク、メモリ、ポート、sshd、失敗したユニット、Docker、ファイアウォール、アップデートをまとめて処理します。結果は CRITICAL / WARNING / OK として届きます。未測定のセクションは、黙ってゼロとして読まれるのではなく、明示されます。
Linuxサーバーのログ検索
状況: APIがタイムアウトしていますが、同じメッセージがnginx、syslog、journald、または通常のユーザーでは読み取れないアプリケーションログにある可能性があります。
質問: 「そのエラーはどこから来たのですか?」
生のSSH
$ grep -i "timeout" /var/log/nginx/error.log
2026/08/20 10:38:54 [error] upstream timed out while reading response header
$ grep -i "timeout" /var/log/syslog
Aug 20 10:39:14 prod api-worker[22104]: database connection timed out
$ grep -i "timeout" /var/log/app/*.log 2>/dev/null
$ journalctl -u api --since "1 hour ago" | grep -i timeout
Aug 20 10:39:14 prod api[22104]: database connection timed out after 30000ms3番目のコマンドはきれいに見えますが、2>/dev/null は権限エラーも隠していました。「一致なし」と「何も読み取られなかった」が今や同じに見えます。また、忙しいログは数千行を返し、インシデントの残りをエージェントのコンテキストから押し出す可能性があります。
構造化されたMCP結果
ssh_log_search({ "profile": "production",
"path": ["/var/log/nginx/error.log", "/var/log/syslog", "/var/log/app/*.log"],
"query": "timeout", "context": 2, "since": "1h" }){
"matches": 34,
"lines": [
{ "file": "/var/log/nginx/error.log", "line": 4821,
"text": "upstream timed out while reading response header", "context": false },
{ "file": "/var/log/nginx/error.log", "line": 4822,
"text": "client closed connection", "context": true }
],
"files_searched": 6,
"files_unreadable": ["/var/log/app/private"],
"files_skipped": 12,
"files_undated": [],
"limited": false,
"truncated": false
}エージェントが得られるもの
生のSSH | 構造化されたMCP | 得られる利点 |
4つの検索と4つの出力 | ファイルとグロブにわたる1つの検索 | トークンとラウンドトリップの削減 |
権限エラーが消えることがある |
| 「ログはクリーン」という誤った結論がない |
出力が有用な上限なしに増大することがある |
| 部分的な結果からより安全な判断 |
since はサーバーの時計を使用し、namesOnly: true は一致するパスのみを返し、ssh_log_tail は1回の呼び出しで複数のログから最後のN行を読み取ります。
安全なリモート設定編集
状況: 稼働中のサーバーでnginx設定を置き換える必要があります。接続の切断、誤ったモード、未確認のコピーにより、サービスが壊れたファイルのままになる可能性があります。
質問: 「部分的なファイルを残さずにこの設定を置き換えられますか?」
生のSSH
$ sudo sh -c 'cat > /etc/nginx/conf.d/api.conf' <<'EOF'
server {
listen 80;
location / { proxy_pass http://127.0.0.1:8080; }
}
EOF
$ echo $?
0終了コード0はシェルが完了したことを示します。どのバイトが届いたかは証明されず、> は新しいファイルの最初のバイトが到着する前に古いファイルを切り詰めました。書き込み中に接続が切断されると、サービスは部分的な設定のままになります。
構造化されたMCP結果
ssh_file_write({ "profile": "production",
"files": [{ "path": "/etc/nginx/conf.d/api.conf",
"content": "server {\n listen 80;\n location / { proxy_pass http://127.0.0.1:8080; }\n}\n",
"mode": "644", "sudo": true, "verify": true }] }){
"files": [{ "path": "/etc/nginx/conf.d/api.conf", "written": true,
"verified": "verified", "reason": null, "bytes": 79 }]
}エージェントが得られるもの
素のSSH | 構造化MCP | 得られる利点 |
ターゲットはコピー完了前に途中で切られる | 完全な一時ファイルが1回のリネームで置き換わる | 書きかけの設定が残らない |
終了コードのみ | バイト数と検証結果が名前付きで示される | 実際に何が届いたかを把握できる |
パーミッションはシェルテキストの中に埋もれる |
| 所有権を予測でき、クォートの誤りが減る |
verified には3つの重要なの結果があります: verified、サーバーにハッシュ
ツールがない場合の unavailable、そして検証が要求されなかった場合の skipped です。
読み込みでは、ssh_file_read がパスのリストを受け取り、ssh_file_list はグロブ、
再帰、サイズ、モードを処理します。
sudo でバッチSSHコマンドを実行する
状況: デプロイの準備はできていますが、トラフィックを移す前に nginx の構文、 サービスの状態、最近のエラーをすべてチェックする必要があります。1件のチェック失敗が 結合ダンプの中に埋もれてしまっては困ります。
質問: 「すべての事前チェックは合格しましたか?」
素のSSH
$ ssh admin@server.example.com 'sudo nginx -t'
nginx: configuration file /etc/nginx/nginx.conf test is successful
$ ssh admin@server.example.com 'sudo systemctl is-active nginx'
active
$ ssh admin@server.example.com 'sudo tail -5 /var/log/nginx/error.log'
2026/08/20 10:38:54 [error] upstream timed out while reading response header3つの接続が、互いに関係のない出力を返します。コマンドを ; で結合した場合、シェルは
最後の終了コードしか報告しません。&& で結合した場合、最初の失敗より後のチェックは
消失します。
構造化MCPの結果
ssh_exec({ "profile": "production",
"command": ["nginx -t", "systemctl is-active nginx",
"tail -5 /var/log/nginx/error.log"],
"sudo": true }){
"commands": [
{ "command": "nginx -t", "exit_code": 0, "truncated": false, "clipped_bytes": 0,
"stdout": "", "stderr": "nginx: configuration file /etc/nginx/nginx.conf test is successful\n" },
{ "command": "systemctl is-active nginx", "exit_code": 0, "truncated": false,
"clipped_bytes": 0, "stdout": "active\n", "stderr": "" },
{ "command": "tail -5 /var/log/nginx/error.log", "exit_code": 0, "truncated": false,
"clipped_bytes": 0, "stdout": "2026/08/21 09:14:02 [error] upstream timed out\n", "stderr": "" }
],
"job_id": null
}エージェントが得る利点
素のSSH | 構造化MCP | 得られる利点 |
3回の呼び出しと相互に関係のない出力 | 順序付けされた1つのコマンドリスト | ラウンドトリップが減る |
結合シェルは途中経過の状態を隠す | 各コマンドが独自の | 失敗したチェックを見逃さない |
|
| 引用符を読み取るミスが減る |
破壊的コマンド保護は、最初のコマンドを実行する前にすべてのリストを検査します。 1つの項目が拒否された場合、他のすべての項目は「未実行」とマークされ、サーバーには何も 送信されません。
各コマンドは自身の stdout と stderr を持っています。実行して何も出力しなかった
コマンドは空の文字列を支え、実行されなかったコマンドにはそれらのフィールド自体が存在
しません。したがって、2つの状態を読み違えることはありません。コマンドごとに128KBを
超える出力は、表向けの先頭とログ向けの末尾の両方を保持し、途中にちょうどカットした分量を
示す継ぎ目が入り、clipped_bytes がどれだけ切り出したかを示します。切り詰めは
バイト境界で行われ、文字のエッジにどの戻るため、クリップされた応答の内容には置換文字が
混入しません。
sudo は、ターミナルなしでサーバーに到達します。プロファイルにパスワードがある場合は、
それが標準入力で sudo に渡されます。キーで認証するプロファイルはパスワードを持たない
ため、その構成での sudo が機能するのはすでにパスワードレスの環境だけです。また、
自身の標準入力を読み取るコマンドにパスワードは決して渡されません。渡してしまうとデータに
混ざってしまうからです。
長時間実行されるSSHジョブを実行する
状況: バックアップまたはマイグレーションは、エージェントのセッションより長く 実行されることがあります。接続自体も切れてしまう可能性がありますが、後でその状態、 出力、終了コードを確認する必要があります。
質問: 「このジョブは会話が終わっても継続されますか?」
生のSSH
$ ssh admin@server.example.com 'pg_dump app | gzip > /srv/backups/app.sql.gz'
client_loop: send disconnect: Broken pipe端末はもうありません。再接続してプロセスを探し、対象ファイルを検査し、バックアップが 完了したのか途中で止まったのかを推測する必要があります。
構造化MCPの結果
ssh_exec({ "profile": "production",
"command": "pg_dump app | gzip > /srv/backups/app.sql.gz",
"detach": true }){
"commands": [{
"command": "pg_dump app | gzip > /srv/backups/app.sql.gz",
"exit_code": null,
"truncated": false,
"timed_out": false,
"blocked": false,
"blocked_reason": null,
"not_run": false,
"warning": null
}],
"job_id": "mst0f2q1-9ab3c4d5"
}エージェントが得る利点
生のSSH | 構造化MCP | あなたの利点 |
ジョブは1つのSSHセッションに借用されている | リモートジョブには永続的なIDがある | 安全な切断と再起動 |
再接続はプロセスやファイルの捜索を意味する | 状態と終了コードが名前付きの状態を持つ | 完了したかどうかを推測する必要がない |
出力を再度読むと古いテキストを繰り返す | 出力はバイトオフィセットから継続する | 長いジョブでのトークン使用量の削減 |
ジョブの状態は、このサーバーのメモリではなくリモートのディスク上にあります。
ssh_job_status は running、finished、lost を区別し、ssh_job_output は
最後のバイトオフセットから続きを読み出します。さらに ssh_job_kill はシェルのみではなく
プロセスグループ全体にシグナルを送ります。
レジオルーターとNASデバイスにファイルを転送する
状況: 現在のOpenSSHクライアントはSFTPを前提としていますが、ルーターまたはNAS などは暗号的なscpプロトコルしか理解しません。それでも、データは完全に転送され、 対象のファイルを安全に置き換えないといけません。
質問: 「この古いデバイスでも検証済みファイルを受け取れますか?」
生のSSH
$ scp app.conf operator@router:/etc/app.conf
subsystem request failed on channel 0
scp: Connection closedよくある次の手順は、レジオフラグを思い出してコピーを再実行し、その後さらにハッシュ コマンドを実行することです。ただ、デバイスにハッシュツールがないと別ですが。
構造化MCPの結果
ssh_upload({ "profile": "router", "local_path": "./app.conf",
"remote_path": "/etc/app.conf", "sudo": true,
"mode": "644", "owner": "root:root", "verify": true }){
"files": [{
"path": "/etc/app.conf",
"written": true,
"verified": "verified",
"reason": null,
"bytes": 1284
}]
}エージェントが得る利点
生のSSH | 構造化MCP | あなたの利点 |
新しいSFTPモードは最初のエラーで停止する | 従来のscpへのフォールバックを自動化される | 古い機材でもПродуктが作動 |
コピー成功が内容の完全とは限らない | SHA-256 検証には名前の付い判断がある | 破損を成功と取り違えない |
直接置換すると途中状態の対物が残る場合がある | 転送中後に一時ファイルが所定の場所へ移動される | 作業ファイルは中断後も残る |
デバイスに sha256sum も openssl もない場合、誤検証せずに unavailable として
理由を示します。ディレクトリ全体は recursive: true で転送し、ハッシュをまとめて
検証します。
AIエージェント向けの破壊コマンド保護
このガードは、コマンドがSSHに届く前にローカルで実行されます。復旧できる操作と、 データを格納しているコンテナを破壊する操作を区別し、チェーンや一括処理の処理順序も 検査します。
破壊的なチェーンを開始前に止める
安全なバックアップと置換の手順:
cp -r /srv/app /srv/app.bak && mv /srv/app /srv/app-old && rm -rf /srv/app同じ操作を間違えた順序で実行した例:
rm -rf /srv/app && cp -r /srv/app /srv/app.bak && mv /srv/app /srv/app-old
# REFUSED before the first command runsシェルはまずディレクトリを削除し、そこで初めてそのディレクトリ バックアップが消えた
ことに気づきます。ガードは「後のステップが前のステップで破壊した対象を読み出している」
ことを探すので、呼び出し全体が自分のマシン上で止まります。同じ仕組みが
dropdb app && pg_dump app > backup.sql も検出します。
取り返しのつかない損失は拒否し、改善可能な変更には警告を出す
拒否される操作 — コンテナ自体 | 示されるのは内容のみ |
|
|
|
|
| 1つのプロフィールを編集する |
|
|
|
|
docker compose down -v は、-v が名前付きボリューム(データベースボリュームを含む)を
削除してしまうため拒否されます。-v がない場合にサービスを止める行為は、同じ取り返し
のつかない操作としては扱われません。
ファイルシステムのルート、ホームディレクトリ、また /etc、/var、/usr のような
システム系ディレクトリを再帰で――シンボリックリンク経由でも――削除できる操作も拒否されます。
rm -rf "$DIR"/* のように対象が解決できない操作も拒否されます。「確認できない」を
「安全」とみなさないからです。
破壊コマンドを意図したものとして確認する
永久に禁止されるものはありません。再確認済みのコマンドに # CONFIRMED-DESTRUCTIVE を
入れると、それが透しても通されるようにします。ガードがバッチ内のどこか一項目だけを拒否した
場合、バッチ全体が実行前に止まるため、サーバー上で操作の途中状態が残ることはありません。
ガードは1回の呼び出し単位で機能します。ある呼び出しの「削除」と次の呼び出しの「読み取り」 を繋いだり、自分が理解しないツールについて推測したりはしませんが、決してそれを意図しません。 これはポリシーエンジンではにシートベルトなって。復元ができる操作の判断はあくまで あなたの責任です。パスの制約と引用規則は docs/security.md にまとめています。
サーバー運用のためのSSH MCPツール
18のツール。全パターンと完全パラメータ的なは ** docs reference**docs/tools.md にあります。
MCPツールの安全関係注記
標準のMCPアノテーションは、どのツールが読み取り専用・破壊性テスト・で、処理が常に同じ か、それとも開いた世界を前提としているかをクライアントに伝えます。詳しい テーブル(ツール)参照 を 参照してください。
SSHコマンドの実行とリモートファイルの管理
Tool | 役割内容 |
| 1つのコマンドや一括処理を実行します。破壊コマンドガード、引き出しデタッチ付き |
| 1つまたはDutility색のファイルをテキストまたはバイナリで読み込む |
| アトミックリネームと任意のSHA-256検証でファイルを書き込む |
| ディレクトリ一覧表示。グロブや再起ににも省略可 |
長時間稼働するSSHジョブの監視
Tool | 役割 |
| バックグラウンドジョブの状態: running、finished、lost |
| バイトオフセットから累計出力を読み取る |
| ジョブ一覧およびTTLを過ぎた終了ジョブを掃除 |
| ジョブのプロセスグループ全体にジョブ |
ログ検索とサーバーのヘルスチェック
Toolツール | 役割 |
| 複数ログの直近のN行、グロブ対応も |
| ログ全体からのパターン検索 |
| ワンショットのヘルススナップショット: サービス、リソース、Docker、ネットワーク、エラー |
| ト ランスポート制御: 統計、再読み込み、テスト、一覧、閉じる |
SSH経由でファイルをアップロード / ダウンロード
バイナリセーフな転送 + 完全性チェック。詳細は docs/transfer.md に。
Tool | 役割内容 |
| ファイル/ディレクトリをご登録 |
| ファイル/ディレクトリを作成 |
バイナリおよび大容量ファイルには
ssh_upload/ssh_downloadを使用 — base64 やヒアドキュはクロマイナリセーフでもアトミックでもありません。
SSHでのLinuxサーバー監査
読み取り専用で、1回のラウンドトリップに大量にまとまります。詳しくは docs/audit.mdをご覧ください。
Toolツール | 役割内容 |
| システム、ディスク、メモリ、ネットワーク、ssh、サービス、Docker、FW、アップデート |
| 証明書の期限、SAN、チェーン、更新フックをドメインについて確認 |
| ディスクの消耗先: |
|
|
Windows での SSH 互換モード
Windows は互換モードを自動的に使用します。接続多重化が利用できない場合、サーバーはコマンドごとに1つの接続に切り替えます。同じツールが鍵ベースの SSH 経由で引き続き利用できます。個別のセットアップや Windows 専用の実装は不要です。
破壊的コマンドのガードについては、AI エージェント向け破壊的コマンド保護 を参照してください。
SSH MCP サーバーのセットアップ
まず 30秒でインストール からパッケージを実行し、その後プロファイルファイルを作成します。
SSH 接続プロファイルの作成
どこに置いても構いません。エージェント自身の設定の隣が一般的な選択肢です。以下の例では ~/.claude/ssh-profiles.json を使用しています。他のエージェントではディレクトリを置き換えてください(~/.codex/、~/.qwen/、~/.config/opencode/):
{
"profiles": {
"production": {
"host": "server.example.com",
"username": "admin",
"port": 22,
"privateKeyPath": "~/.ssh/your_private_key"
}
}
}SSH プロファイルを明示的に選択する
サーバーがフォールバックするプロファイルはありません。各プロファイルは異なるマシンであり、間違ったマシンに送信されたコマンドは、エラーメッセージでは元に戻せません。名前を指定せずに問い合わせると、選択肢となる名前の一覧が返されます:
ssh_exec({ command: "uptime" })
→ No profile specified. Name one explicitly: productionサーバーが SSH に使用できないプロファイル — host がないもの、username がないもの、または mode: "local" — は文句を言わずにスキップされ、認識されないフィールドはそのまま残されるため、ファイルを他のツールと共有できます。壊れたフィールドを持つプロファイルは別のケースです。フィールドと値とともに名前が示され、正常な隣接プロファイルは動作を継続します。
各プロファイルはオプションで pathSecurity ブロックを受け付け、ファイルツールが触れられるパスをホワイトリストまたはブラックリストで制御できます — docs/security.md を参照してください。
SSH パスワードとパスフレーズをプロファイルに含めない
鍵を優先してください。パスワードまたは暗号化された鍵のパスフレーズが避けられない場合は、プロファイル自体ではなく、別のシークレットファイルに保存してください:
{
"secretsFile": "~/.config/ssh-mcp/secrets.json",
"profiles": {
"production": {
"host": "server.example.com",
"username": "admin"
}
}
}シークレットファイルはプロファイル名をキーにします — secrets.json.example を参照:
{
"production": { "password": "..." }
}シークレットファイルは自分だけが読み取れるようにしてください(chmod 600)。相対パスはプロファイルファイルから解決されます。シークレットは argv の外に保持され、ログではマスクされます。認証情報のセキュリティ を参照してください。
Claude Code、Codex、その他の MCP クライアントの設定
使用するクライアントを選択し、同じプロファイルファイルを指定します。
Claude Code
1つのコマンドで、-s user によりサーバーがすべてのプロジェクトで利用可能になります:
claude mcp add ssh -s user \
-e SSH_PROFILES_FILE="$HOME/.claude/ssh-profiles.json" \
-- npx -y @hypnosis/ssh-mcp-serverCodex CLI
codex mcp add ssh \
--env SSH_PROFILES_FILE="$HOME/.codex/ssh-profiles.json" \
-- npx -y @hypnosis/ssh-mcp-serveropencode
~/.config/opencode/opencode.json に配置します:
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"ssh": {
"type": "local",
"command": ["npx", "-y", "@hypnosis/ssh-mcp-server"],
"enabled": true,
"environment": {
"SSH_PROFILES_FILE": "~/.config/opencode/ssh-profiles.json"
}
}
}
}Qwen Code
他と同様、1つのコマンドです:
qwen mcp add ssh \
-e SSH_PROFILES_FILE="$HOME/.qwen/ssh-profiles.json" \
npx -y @hypnosis/ssh-mcp-serverその他の MCP クライアント
Gemini CLI、Hermes、Cline、エディタプラグイン、または自作のエージェントも同様に動作します。必要なのは実行するコマンドと1つの環境変数だけです。
MCP クライアントの再起動
クライアントを再起動し、ssh_monitor({ action: "list" }) を実行してプロファイルが読み込まれたことを確認します。
SSH MCP サーバー設定
変数 | 機能 | デフォルト |
| プロファイル JSON へのパス — 必須 | — |
|
|
|
| フォールバック。 |
|
| ログ行内のタイムスタンプ |
|
| 最後のコマンド後、共有接続が維持される秒数。 |
|
| コントロールソケットの配置場所 |
|
| プロファイルキャッシュの TTL(ミリ秒) |
|
| プロファイルファイルの変更時に再読み込み |
|
共有接続は意図的にこのプロセスより長く生存します。終了時に閉じると、同じマシン上の別のウィンドウが使用しているチャネルが切断されるためです。
SSH MCP サーバーの制限事項
キャンセル: SSH を閉じるとリモートコマンドが実行中のままになる可能性があります。制御が重要な場合は、デタッチジョブを使用してください。
アトミック書き込み: BSD と macOS では、ファイルシステムをまたいだリネームの事前チェックはできません。
SSH MCP サーバーのロードマップ
macOS SSH ホストに対する完全なテスト実行
Windows でのエンドツーエンド互換性テスト
マルチホスト監査 — 1回の呼び出しで複数の SSH プロファイルの健全性を比較
既存の
~/.ssh/configからのプロファイルインポート大容量ファイルと不安定な接続のための再開可能な転送
リモート操作のタイムライン — コマンド、転送、ガード判定を1つの監査証跡に
すぐ使える SSH トラブルシューティングのプレイブック
モデルに届く回答— 完了: コマンド出力、一致したログ行、マシン名、スナップショットセクションがテキストだけでなくフィールドでも送信されますより小さな MCP ツールスキーマ— 完了: ツール一覧が10%軽量化され、デタッチジョブはポーリングされる代わりに最後に書き込んだ行を表示するようになりました
SSH MCP サーバーの開発とテスト
npm install
npm run build # tsc
npx tsc --noEmit # types, plus dead declarations
npm run test:unit # unit tests
npm run lab:up # start the two test containers
npm run test:live # live suite against those containersライブスイートは実際のコンテナ(BusyBox と coreutils 各1つ)に対して実行されます。なぜなら、この2つは静かに食い違うことがあり、モックは作成者に合わせた結果を返すためです。レイアウトは docs/architecture.md を参照してください。
SSH MCP Server が気に入りましたか? ⭐
このツールが気に入ったら、GitHub でスターを付けてください — より多くの人にプロジェクトを知ってもらう助けになります。
SSH MCP サーバーへの貢献
Issue とプルリクエストは github.com/hypnosis/ssh-mcp-server で受け付けています。
ライセンス
MIT — LICENSE を参照してください。
Available Tools
18 toolsssh_audit_baselineARead-only
Reports how a machine is set up: sshd, firewall, pending updates, failed services, docker, listening ports and disk, each section marked CRITICAL, WARNING or OK. Reads only, in one round trip instead of a dozen commands. For load and health at this moment rather than settings, use ssh_snapshot.
| Name | Required | Description | Default |
|---|---|---|---|
| compact | No | Trim the long sections. false = whole, much larger answer. Default: true | |
| include | No | system, disk, mem, net, ssh, services, docker, firewall, updates. Default: all | |
| profile | Yes | Machine name. | |
| include_sudo_sections | No | Run the sections that need root as root: sshd -T for ssh, ufw and iptables rules for firewall. Without it those sections name what they could not read instead of guessing. Default: false |
Output Schema
| Name | Required | Description |
|---|---|---|
| os | No | |
| net | No | |
| ssh | No | |
| disk | No | |
| load | No | |
| docker | No | |
| kernel | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| memory | No | |
| uptime | No | |
| updates | No | |
| date_utc | No | |
| firewall | No | |
| hostname | No | |
| services | No | |
| red_flags | No | |
| unavailable | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotation already declares readOnlyHint=true, and the description reinforces this with 'Reads only'. It adds useful behavioral context beyond the annotation by stating that sections are marked CRITICAL/WARNING/OK and that it replaces 'a dozen commands' in one round trip. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no filler: the first defines purpose and output shape, the second states safety and efficiency, and the third routes to the sibling tool. The most important scoping information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only audit tool, the description covers what it reports, how the output is categorized, why it is efficient, and which sibling to use in the alternate use case. Combined with full parameter documentation and an output schema, nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with every parameter documented including defaults and allowed values. The tool description contributes high-level context but does not need to compensate for missing parameter docs, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Reports how a machine is set up', then enumerates exact domains (sshd, firewall, updates, services, docker, ports, disk) and the severity marking scheme. It also distinguishes itself from ssh_snapshot, so an agent can tell it apart from the closest sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: 'For load and health at this moment rather than settings, use ssh_snapshot.' It also frames the tool as a one-round-trip setup audit, making the intended use case clear without ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_disk_breakdownARead-only
Finds what filled a disk: free space per filesystem, the largest directories under each path given, and what docker, journald and package caches hold. Reads only, nothing is deleted. For how full the disks are at all, ssh_snapshot answers in one line.
| Name | Required | Description | Default |
|---|---|---|---|
| sudo | No | Read as root. Straight away for places a plain user cannot read (/root, /var/lib/docker); otherwise retry with true when the answer names what it could not read. Default: false The cache section then reads root's home, not the profile user's. | |
| paths | No | Where to look. Naming the suspect beats walking the whole filesystem. Default: ["/"] | |
| top_n | No | Largest directories named per path. Default: 20 | |
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| cache | No | |
| docker | No | |
| largest | No | |
| var_log | No | |
| journald | No | |
| unreadable | No | Not looked into: the sizes above leave these out |
| filesystems | No | |
| unavailable | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description reinforces this with 'Reads only, nothing is deleted.' It adds useful context about what areas are inspected (docker, journald, package caches) without contradicting the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences. The first explains scope and read-only behavior, and the second routes to the alternative for a different need. There is no filler or repeated schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a rich input schema, an output schema, and a readOnlyHint annotation, the description covers what an agent needs: what it inspects, that it is safe, and how it relates to ssh_snapshot. No critical behavioral or selection information is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not add parameter-specific meaning beyond the schema, but it does relate the tool's purpose to the 'paths' concept. It neither improves nor harms parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb-resource pair ('Finds what filled a disk') and enumerates the concrete outputs: free space per filesystem, largest directories per path, and cache contents. It also differentiates itself from ssh_snapshot by framing this as the detailed breakdown versus the one-line fullness answer.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a clear alternative and selection rule: use ssh_snapshot when only overall disk fullness is needed, and this tool when a breakdown is required. It could be slightly more explicit about when not to use the tool, but the guidance is strong enough for an agent to make the right choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_downloadADestructiveIdempotent
Copies a file or directory from a server to this machine, checked by sha256 on both sides. To read a text file rather than keep it, ssh_file_read skips the disk.
| Name | Required | Description | Default |
|---|---|---|---|
| sudo | No | For /root and the like. A root copy stages in /tmp, is fetched and removed — the machine needs room. Default: false | |
| verify | No | sha256 on both sides, per file. "unavailable" = no sha256 on the machine = delivered, not broken. "mismatched" fails the call and replaces nothing. Default: true | |
| profile | Yes | Machine name. | |
| timeout | No | Milliseconds. No ceiling by default — a transfer runs as long as it takes. | |
| recursive | No | Only to force it — a directory is recognised on its own. | |
| local_path | Yes | Where it lands on this machine. | |
| remote_path | Yes | What to fetch from the server. |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide idempotentHint and destructiveHint, and the description adds meaningful behavioral detail: 'checked by sha256 on both sides.' This goes beyond the annotations by explaining the verification mechanism. It does not explicitly state that an existing local_path may be overwritten, but the destructiveHint annotation covers the general risk, and the schema's verify parameter adds mismatch semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no redundant wording. The core action and verification detail are front-loaded, and the sibling alternative follows in a clearly conditional form. Every sentence contributes useful information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, output schema, and annotations, the description is complete enough for an agent to know what the tool does, when to use it, and when not to. It covers direction, verification, and the key sibling alternative, with no missing information necessary for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all seven parameters in detail. The description adds no parameter-level meaning beyond the schema; it only restates the overall transfer and verification behavior. A baseline of 3 is appropriate since the schema carries the semantic weight.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action and resource: 'Copies a file or directory from a server to this machine.' This clearly identifies the tool's direction and purpose. It also differentiates from ssh_file_read by noting the alternative is for reading text without keeping a copy, and the title 'Download from a server' reinforces the intent.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides an alternative and a usage condition: 'To read a text file rather than keep it, ssh_file_read skips the disk.' This tells an agent when to prefer a sibling tool instead. The copy direction is unambiguous, so there is no confusion with ssh_upload.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_execADestructive
Runs one command or a list of them on a server, each with its own exit code, stdout and stderr. Work measured in minutes belongs in detach, not in a longer timeout. Reach for it last — files, logs, transfers, health and jobs each have a tool that batches the round trips and parses the answer.
| Name | Required | Description | Default |
|---|---|---|---|
| cwd | No | Directory to start in, detached jobs included. Cannot be entered -> the command stops, it does not run elsewhere. | |
| sudo | No | Execute command(s) with sudo. Default: false | |
| detach | No | Background job on the server: returns an id at once, outlives this call, timeout does not apply. Follow with ssh_job_status / ssh_job_output, stop with ssh_job_kill. One command. With sudo the job runs as root and every later call follows it as root, provided the profile has a password or sudo needs none. Default: false | |
| command | Yes | One command, or a list: ["hostname", "whoami"]. Each runs in its own shell — no shared variable, no shared cd; cwd applies to all. A non-zero exit does not stop the list. | |
| profile | Yes | Machine name. | |
| timeout | No | Milliseconds, per command in a list, not for the whole list; default 30000. Work measured in minutes -> detach, not a bigger number. |
Output Schema
| Name | Required | Description |
|---|---|---|
| job_id | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| commands | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the destructiveHint annotation, the description adds behavior: each command returns its own exit code, stdout, and stderr, and long-running work should be detached rather than given a bigger timeout. It doesn't fully warn about the arbitrary-command risk, but the annotation and phrasing imply raw execution.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences carry both the core behavior and the key usage caveat. Every clause earns its place, and the most important routing guidance comes second but remains succinct.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The combination of a rich schema, output schema, and a description that covers command granularity and tool routing gives an agent enough to invoke this correctly. It does not name the exact sibling tools, but the categories are identifiable from the sibling list.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already explains every parameter. The description reinforces the detach-vs-timeout tradeoff at a high level, but adds no new parameter-specific meaning. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: running one command or a list on a server, with per-command exit code, stdout, and stderr. It also differentiates from specialized siblings by saying files, logs, transfers, health, and jobs each have their own tool, making this the raw fallback.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit when-not-to-use guidance: work measured in minutes belongs in detach, not a longer timeout. It also tells the agent to prefer category-specific tools because they batch round trips and parse answers, which is clear routing advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_file_listARead-only
Lists a directory on a server: every entry with its size, mode, owner and modification time, as fields. A directory it was not allowed to enter is named rather than left out, and a listing cut short by the output limit says so. To see what is inside a file, use ssh_file_read.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Directory to list. | |
| sudo | No | List as root, for directories the profile user cannot open. Default: false | |
| pattern | No | Glob matched on the machine: "*.conf". Without it every entry comes back. | |
| profile | Yes | Machine name. | |
| recursive | No | Descend into subdirectories. A deep tree is cut at the output limit and says so. Default: false |
Output Schema
| Name | Required | Description |
|---|---|---|
| path | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| entries | No | |
| truncated | No | The output limit cut the answer: the directory holds more than entries lists. |
| unreadable | No | Directories nobody was allowed to enter. Their contents are missing from entries, and a list short by the one that mattered looks complete. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, it discloses useful behavioral edge cases: unreadable directories are named rather than silently omitted, and listings truncated by the output limit are explicitly flagged. This gives the agent accurate expectations for permission failures and large listings.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tight sentences with no filler: core purpose first, then key behavioral guarantees, then the routing note to ssh_file_read. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a readOnlyHint, 100% schema parameter coverage, and an output schema present, the description covers the remaining contextual needs: result contents, error behavior, truncation signaling, and the relationship to the closest sibling. Nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema fully documents all five parameters. The description adds context about output fields and truncation but not new parameter-level semantics, matching the baseline for fully documented schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Lists a directory on a server' and names the returned fields (size, mode, owner, modification time). It distinguishes itself from ssh_file_read by explicitly directing file-content needs to that sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It clearly states the tool's use case (listing directories) and provides an explicit alternative for the adjacent case ('To see what is inside a file, use ssh_file_read'). No ambiguity remains about which sibling to pick for file-content access.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_file_readARead-only
Reads text files from a server, several of them in one call. A file it could not read is named with the reason, never returned empty or cut short as if that were the content. To look for something inside logs rather than read them, ssh_log_search greps on the server.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | One path, or a list: ["/etc/hosts", "/etc/resolv.conf"]. An unreadable file costs the list nothing — the others still come back. | |
| sudo | No | Read as root, for files the profile user cannot open. Default: false | |
| binary | No | Fetch over the transport, not the command channel; answer in base64. The safe way for non-text, implies encoding=base64. Default: false | |
| profile | Yes | Machine name. | |
| encoding | No | base64 keeps non-text bytes intact but still goes through the command channel and its size limit. Real binary -> binary below. Default: utf8 | utf8 |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true, which the description does not contradict. The description adds meaningful behavioral context beyond annotations: unreadable files are reported with the reason, never returned as empty or truncated content, and multiple files can be read in one call. These are useful operational details not captured by the annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The primary purpose and batch capability are front-loaded, followed by error behavior and an alternative tool reference. Every sentence earns its place and the structure is clean.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a rich schema that documents all parameters, the description covers the core behavior (batch read, error handling) and names an alternative. Since there is no output schema, the error-behavior note partially clarifies return semantics, though the exact response structure isn't specified. For a read-only tool, this is adequate and nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% — every parameter (path, sudo, binary, profile, encoding) has a detailed schema description with defaults and enums where applicable. The tool description itself adds no additional parameter semantics beyond the schema, so this dimension sits at the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence states a specific verb ('reads') and resource ('text files from a server') and highlights the batch capability ('several of them in one call'). It explicitly distinguishes itself from ssh_log_search, but does not address other siblings like ssh_file_list or ssh_file_write, so differentiation is partial.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides an explicit alternative: 'To look for something inside logs rather than read them, ssh_log_search greps on the server.' This is clear when-not-to-use guidance for one specific scenario, but it does not mention when to use ssh_file_list or other file tools, so coverage is limited.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_file_writeADestructiveIdempotent
Writes text files on a server, several in one call, each with its own path, permissions, owner and sudo. A file is replaced whole and never appears half-written; there is no append. For something that already exists on this machine, use ssh_upload.
| Name | Required | Description | Default |
|---|---|---|---|
| files | Yes | One file, or a list — mode and sudo decided per file, not per call. | |
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the idempotent and destructive hints, the description discloses that files are replaced whole, atomically, and never appended to. This adds useful behavioral context that the annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, all high-signal: the core action, the atomic/replace behavior, and the sibling alternative. No filler or redundant restatement.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, annotations, and output schema, the description covers the essential behavioral semantics and alternative routing. Nothing critical is missing for an agent to invoke this correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already explains each parameter thoroughly. The description contributes the multi-file and per-file ownership/sudo framing, but most parameter-level meaning is in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: writes files on a server. It also differentiates itself from the closest sibling by saying anything already on this machine should use ssh_upload.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names ssh_upload as the alternative for files that already exist locally, and clarifies the tool supports multiple files in one call. The no-append note also sets an important boundary.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_job_killADestructiveIdempotent
Stops a detached job and everything it started — the signal reaches the whole process group. A job that had already finished is reported as gone, not as a refusal.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass. | |
| signal | No | KILL only when TERM was already ignored. | TERM |
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| id | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| reason | No | |
| signal | No | What was actually sent, which is not always what was asked for. |
| outcome | No | signalled — the signal reached the process group of the job; gone — the job had already ended, so there was nothing to stop; nopid — the job recorded no pid, so there was nothing to signal; missing — the server knows no job under this id; no-answer — the server did not answer the stop request, so the job state is unknown. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint and idempotentHint. The description adds valuable context: the signal reaches the whole process group, and already-finished jobs are reported as 'gone' rather than a refusal. This goes beyond the annotation hints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences that front-load the primary action and then clarify an edge case. No redundancy or wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is sufficient for a destructive operation with an output schema. It explains the scope of destruction (process group) and the idempotent edge case. Combined with schema documentation for parameters and annotation hints, an agent has what it needs to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all 3 parameters with descriptions, so baseline is 3. The tool description itself does not add any parameter-specific meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Stops), resource (detached job), and clarifies it reaches the entire process group. Distinguishes from sibling tools like ssh_job_list and ssh_job_status which are non-destructive. Also clarifies behavior for already-finished jobs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for stopping detached background jobs, but does not explicitly mention alternatives or conditions when not to use. It clarifies that it targets detached jobs, giving scope, but lacks explicit when-not guidance or reference to alternative sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_job_listARead-only
Lists the detached jobs on a machine with their state, jobs started with sudo included — for when an id was not kept. Ids and states only; for what a job printed, use ssh_job_output.
| Name | Required | Description | Default |
|---|---|---|---|
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| jobs | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description adds meaningful behavioral detail beyond that: it lists detached jobs including sudo-started ones, and clarifies that only IDs and states are returned. This goes beyond the annotation without contradicting it.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The core purpose is front-loaded, followed by a scope caveat and a pointer to an alternative. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read-only tool with an output schema, the description is complete. It explains scope, inclusion of sudo jobs, return content, and when to use it, while relying on annotations and the output schema for the rest.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% because the only parameter, 'profile', is documented as 'Machine name.' The description does not add parameter-level meaning beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Lists') and resource ('detached jobs on a machine with their state'), and adds a distinguishing constraint ('jobs started with sudo included'). It also explicitly differentiates itself from ssh_job_output by limiting scope to 'Ids and states only', so an agent can select it correctly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use guidance: 'for when an id was not kept'. It also names the alternative for related needs: 'for what a job printed, use ssh_job_output'. This directly helps an agent choose between sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_job_outputARead-only
Returns what a detached job has written so far, stdout and stderr together, from a byte offset you choose. For whether the job is still running rather than what it printed, ssh_job_status answers in one line.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass. | |
| offset | No | Byte offset to read from; the answer names the next one. | |
| profile | Yes | Machine name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true, which covers safety, and the description adds meaningful behavioral context: reads only output produced 'so far' (non-blocking), merges stdout and stderr, and supports reading from a chosen byte offset with the next offset returned. This goes beyond annotation data without contradicting it.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences carry the full purpose, the key behavioral detail, and the alternative-tool routing. The most important information is front-loaded, and there is no filler or repetition of schema fields.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only streaming tool with a complete schema, the description is largely sufficient: it conveys non-blocking behavior, combined streams, byte-offset seeking, and the cursor semantics. There is no output schema, so a bit more detail about the exact return shape would push this to 5, but nothing essential to invoking it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters. The tool description itself does not add new parameter-level meaning beyond what the schema says; it merely restates the offset concept. This meets the baseline for full schema coverage but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Returns what a detached job has written so far', and clarifies that stdout and stderr are combined. It also distinguishes this from ssh_job_status by explicitly contrasting output content with run-state. This leaves no ambiguity about the tool's core function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The second sentence gives clear routing guidance: if an agent cares whether the job is still running, use ssh_job_status instead. This is an explicit condition that selects between two closely related siblings, which is exactly what an agent needs.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_job_statusARead-only
Reports the state of a detached job, with the last lines it wrote so you can see where it got to. lost means no exit code was left behind, not that the work failed — ssh_job_output still has the output.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass. | |
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| jobs | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as read-only, so the description adds value by explaining the 'lost' status semantics and clarifying that 'lost' does not mean the work failed. It also discloses that the output remains available via ssh_job_output, which is useful behavioral context beyond what the annotations state.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences convey the core purpose, the extra output detail, and the important 'lost' edge-case semantics. Every phrase carries meaning, and the key information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only status tool with complete schema descriptions and an output schema present, the description covers all essential context. The 'lost' clarification removes a likely source of confusion, and the readOnlyHint addresses safety.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides 100% parameter coverage with descriptive text for both 'id' and 'profile', including the note about sudo. The tool description itself adds no additional parameter-level meaning, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Reports') and a specific resource ('the state of a detached job'), and also states it includes the last lines written for progress visibility. This distinguishes it from sibling tools like ssh_job_output (which retrieves full output) and ssh_job_list (which lists jobs).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description makes clear when to use this tool: to check the state of a detached job and see where it got to via its last lines. It also gives an implicit when-not by pointing to ssh_job_output for cases where the job is 'lost' but output still exists. It does not explicitly contrast with ssh_job_list, but the single-job framing is enough.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_log_searchARead-only
Greps log files on the server and returns the matching lines with their paths, or the paths alone when line bodies are not wanted. An empty answer means no match, never a failed search — files that could not be read are listed apart. For the tail of a file rather than a search through it, ssh_log_tail is cheaper. A container is searched by name instead of by path.
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | Which end maxMatches keeps: "end" newest (scans the whole file), "start" oldest (stops reading at the cap). Default: end | end |
| path | No | One path, a list, or a glob in the file name: "/var/log/*.log". Expanded by the server's find, not a shell — a name with a space or a newline stays one name. A glob in the directory part is refused. | |
| sudo | No | Read as root. Straight away for places a plain user cannot read (/root, /var/lib/docker); otherwise retry with true when the answer names what it could not read. Default: false | |
| query | Yes | Regex, grep -E dialect. | |
| since | No | Window: "today" | "2026-08-19" | "2h" | "3d", the day taken from the server. Skips files untouched in it (count reported). A window of a day or more then keeps only lines dated inside — 2026-08-19, Aug 19, 19/Aug/2026; a shorter one filters files and leaves their lines alone. Undated file: searched whole and named. | |
| context | No | Lines around each match, as grep -C. Excluded by namesOnly. Default: 0 | |
| profile | Yes | Machine name. | |
| timeout | No | Milliseconds per file, default 30000. Raise for multi-gigabyte files with from: "end". | |
| container | No | Read this container's output instead of a file: docker is asked where it writes, and the answer names the file it read. Whatever cannot be read this way — a driver that keeps no file, an engine that is not docker, a name nothing answers to — comes back said aloud, naming ssh_exec as the way through. The file belongs to root, so sudo: true. Give this or path, never both. | |
| namesOnly | No | Answer = matching paths, no line bodies. One command for the whole list; maxMatches and context do not apply. Default: false | |
| recursive | No | Walk the whole tree, not one level. With a glob: "/etc/nginx/*.conf" reaches those at any depth. Symlinked files are searched, symlinked dirs not descended. Default: false | |
| maxMatches | No | Cap per file; reaching it is reported. Default: 200 | |
| caseSensitive | No | false = case ignored. Default: false |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | No | Matching file names, for namesOnly. |
| lines | No | The matching lines. context:true marks a neighbour shown alongside, not a match. |
| source | No | Named only when container was asked: the engine, the driver and the file the lines were read from. |
| limited | No | maxMatches was reached — more exist than are shown. |
| matches | No | Lines in the answer — matches plus any context lines; with namesOnly, matching files. |
| truncated | No | Output was cut mid-answer: incomplete, not empty. |
| files_skipped | No | Left unread by the since window. |
| files_undated | No | No recognisable timestamp: searched whole, the window was not applied. |
| files_searched | No | |
| files_unreadable | No | Opened with an error — not proof the text is absent. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds significant behavioral clarity beyond the readOnlyHint annotation: an empty answer means no match, never a failed search, and unreadable files are listed apart. This prevents an agent from misinterpreting an empty result as an error. The readOnly annotation already covers mutation safety, so the added semantics are above baseline.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two dense sentences with no wasted words. The core purpose, output distinction, no-match semantics, failure handling, sibling alternative, and container usage are all packed in efficiently.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a full input schema and an output schema present, the description covers the non-obvious behavioral gotchas an agent needs: empty-result semantics, unreadable-file reporting, and the tail alternative. It could have mentioned the output structure explicitly, but the output schema already supplies that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents every parameter thoroughly. The description reinforces the container-by-name notion and the line-bodies-versus-paths choice, but it does not add meaning beyond what the parameter descriptions already supply. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a precise verb and object: 'Greps log files on the server and returns the matching lines with their paths.' It also distinguishes the paths-only mode and immediately contrasts itself with ssh_log_tail, so an agent can disambiguate it from the closest sibling without inspecting the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names when a sibling is cheaper: 'For the tail of a file rather than a search through it, ssh_log_tail is cheaper.' It also conveys the container-vs-path usage pattern. It does not enumerate all alternatives among the many siblings, but the relevant distinction is covered.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_log_tailARead-only
Returns the last lines of one or more log files, whatever their size — nothing is shipped here to be trimmed locally. A container is read by name instead of by path, through the file its driver writes. To look for something rather than read the end, use ssh_log_search.
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | One path, a list, or a glob in the file name: "/var/log/*.log". Expanded by the server's find, not a shell — a name with a space or a newline stays one name. A glob in the directory part is refused. | |
| sudo | No | Read as root. Straight away for places a plain user cannot read (/root, /var/lib/docker); otherwise retry with true when the answer names what it could not read. Default: false | |
| lines | No | How many lines from the end. Default: 100 | |
| profile | Yes | Machine name. | |
| container | No | Read this container's output instead of a file: docker is asked where it writes, and the answer names the file it read. Whatever cannot be read this way — a driver that keeps no file, an engine that is not docker, a name nothing answers to — comes back said aloud, naming ssh_exec as the way through. The file belongs to root, so sudo: true. Give this or path, never both. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description adds behavioral context: 'whatever their size — nothing is shipped here to be trimmed locally' and explains container resolution 'through the file its driver writes.' These clarify how the tool behaves without contradicting the annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three purposeful sentences: core behavior and scope come first, container nuance follows, and the sibling alternative closes. No filler, no repetition of schema details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only tail tool, the description plus fully described schema covers file paths, globs, container mode, sudo behavior, and search routing. It does not describe the return format, but that is reasonably inferable from 'returns the last lines' and no output schema exists.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameter descriptions already carry the meaning. The main description adds tailing/container framing but does not materially extend individual parameter semantics beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Returns the last lines of one or more log files'. It also distinguishes itself from the sibling ssh_log_search by explicitly contrasting tailing with searching for something.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly routes the agent: 'To look for something rather than read the end, use ssh_log_search.' It also clarifies the container-read path vs ordinary file paths, giving concrete context for when each mode applies.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_monitorAIdempotent
Looks after the SSH connections themselves, not the machines behind them: lists the configured profiles, tests one, reports pool statistics, closes a connection or reloads the profile file. Start here on a machine you have not used yet — test names the state before anything else runs.
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Which of the five to do. close and reload drop live connections; the other three only read. | |
| profile | No | Which machine. Required for stats, test and close; list and reload take none. |
Output Schema
| Name | Required | Description |
|---|---|---|
| state | No | ready — logged in, commands run; limited — logged in and commands run, but the shell is not POSIX; no-route — the server was never reached; rejected — the server was reached and refused the login. null — nothing was checked: only the test action reaches the server. |
| action | No | |
| broken | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| profile | No | |
| profiles | No | |
| exit_code | No | |
| latency_ms | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description reveals important behavioral nuance beyond the annotations: close and reload drop live connections while the other actions only read. Annotations already signal idempotent and non-destructive, so this is additive rather than repetitive, and it does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core scope and followed by practical guidance. Every phrase earns its place; there is no redundant filler or repetition of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With only two parameters, an output schema, and strong annotations, the description covers the essential usage guidance, side-effect differences, and conceptual scope. It could explicitly enumerate which action to use in which scenario, but the existing context is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with both parameters already well described in the schema. The description adds a high-level summary of actions but does not materially improve on the schema's per-parameter semantics, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb-and-resource purpose: managing SSH connections themselves, listing profiles, testing, reporting pool stats, closing, and reloading. It explicitly distinguishes itself from tools that operate on machines behind the connections, which differentiates it from the many ssh_ sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives concrete usage context: 'Start here on a machine you have not used yet' and recommends that 'test names the state before anything else runs.' It does not explicitly name which sibling tools to use instead, but its scope exclusion ('not the machines behind them') makes the appropriate context clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_service_statusARead-only
Reports one systemd unit: whether it is loaded, active and enabled, with the tail of its journal. A machine without systemd comes back as NOT CHECKED, never as a stopped service — that would read as an outage which is not there. For every failed unit at once, ssh_audit_baseline names them.
| Name | Required | Description | Default |
|---|---|---|---|
| sudo | No | Read as root. Straight away for places a plain user cannot read (/root, /var/lib/docker); otherwise retry with true when the answer names what it could not read. Default: false Without it the journal comes back trimmed to what the profile user may see. | |
| unit | Yes | Unit name, e.g. "nginx" or "nginx.service". | |
| since | No | Journal window, as journalctl reads it: "1h ago", "today", "2026-08-19". | |
| profile | Yes | Machine name. | |
| log_lines | No | Journal lines returned. Default: 50 |
Output Schema
| Name | Required | Description |
|---|---|---|
| unit | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
| enabled | No | |
| outcome | No | checked — systemd answered, and the fields below carry its measurement; no_systemd — there was nobody to ask on this server, so the service was not measured; no_unit — systemd knows no such unit, which is not the same as a unit that is stopped. |
| restart | No | |
| sub_state | No | |
| recent_log | No | |
| status_head | No | |
| active_state | No | |
| restart_after | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnlyHint=true, the safety profile is already known, so the description adds valuable behavioral context beyond annotations: the NOT CHECKED distinction for non-systemd machines and the journal-tail behavior. This prevents a false outage conclusion and clarifies return semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no filler. The main purpose is front-loaded, and each subsequent sentence contributes either a behavioral caveat or a sibling alternative. Nothing is repeated from the schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists and the input schema fully documents parameters, the description covers the essential agent-facing context: single-unit scope, journal tail, systemd-absence semantics, and the relevant sibling tool. No critical gap remains.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all five parameters well. The description does not materially add parameter-level detail beyond the schema, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Reports one systemd unit: whether it is loaded, active and enabled, with the tail of its journal.' It also differentiates from ssh_audit_baseline by noting that sibling names failed units at once, making the tool's single-unit scope clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit alternative and condition: 'For every failed unit at once, ssh_audit_baseline names them.' It also provides a crucial usage caveat—machines without systemd return NOT CHECKED, not stopped—so an agent knows when not to interpret the result as an outage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_snapshotARead-only
Reports how a machine is doing right now: cpu, memory, disk, containers, listening ports, services and recent errors, in one round trip. Whatever could not be measured comes back null and marked unavailable, never as a zero that reads like an idle machine. For how the machine is set up rather than how it is running, use ssh_audit_baseline.
| Name | Required | Description | Default |
|---|---|---|---|
| profile | Yes | Machine name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| load | No | |
| ports | No | |
| cpu_pct | No | |
| mem_pct | No | |
| disk_pct | No | |
| services | No | |
| listening | No | |
| containers | No | |
| error_lines | No | |
| unavailable | No | |
| recent_errors | No | |
| services_running | No | |
| containers_running | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnlyHint=true, so the read-only nature is covered. The description adds valuable behavioral context: unmeasured values return null and are marked unavailable rather than zero, preventing misinterpretation. This goes beyond annotations by defining output semantics, so a 4 is justified.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. It front-loads the core purpose, adds the critical null-behavior detail, and ends with the alternative. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that an output schema exists (which explains return structure) and the description covers what it measures, the round-trip efficiency, and the null unavailable convention, nothing essential is missing for an agent to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The sole parameter 'profile' is already fully described in the schema as 'Machine name.' (100% coverage). The description does not add any further detail about the parameter, so baseline 3 applies—the schema carries the full semantic load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reports current machine health (cpu, memory, disk, containers, listening ports, services, recent errors) in one round trip, and explicitly contrasts it with ssh_audit_baseline for setup vs. running state. This makes its purpose unambiguous and distinguishes it from siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use this tool: for current operational status, and when not to (for configuration use ssh_audit_baseline). This directly names the alternative and the condition, leaving no ambiguity about selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_tls_checkARead-only
Checks the TLS certificate a domain serves — days left, whether the name matches a SAN, the issuer and whether renewal is configured — with the handshake made from the server itself, so it sees what that machine sees, including hosts closed to the outside. A null field means the check could not run, not that the certificate is bad. Run it per domain, once ssh_audit_baseline has named the sites.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | Default: 443 | |
| sudo | No | Read the renewal config as root. Without it "no hook configured" only means "could not look". Default: false | |
| domain | Yes | The name to ask for, e.g. "example.com". | |
| profile | Yes | Machine name. | |
| check_renew_hook | No | Also look for the renewal config. Default: true |
Output Schema
| Name | Required | Description |
|---|---|---|
| port | No | |
| domain | No | |
| issuer | No | |
| san_text | No | |
| not_after | No | |
| days_until_expiry | No | |
| renew_hook_evidence | No | |
| renew_hook_configured | No | |
| san_includes_hostname | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description reveals that the handshake is made from the server itself, so it sees hosts closed to the outside, and clarifies that null fields mean the check could not run rather than certificate failure. This is meaningful behavioral context the annotation does not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is information-dense and front-loads the core purpose, then adds null semantics and usage sequencing. The first sentence is a bit long with several em-dash interruptions, but every clause adds signal and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With annotations declaring read-only behavior, an output schema present, and 100% parameter coverage, the description adds the remaining needed context: what the check sees, how to interpret nulls, and when to run it relative to ssh_audit_baseline. Nothing critical is missing for an agent to select and call this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all five parameters. The tool description adds useful context around domains and null results, but it does not add new parameter-level meaning beyond what the schema provides, matching the baseline of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Checks') and resource ('the TLS certificate a domain serves'), and enumerates the concrete outputs: days left, SAN match, issuer, renewal configuration. This clearly differentiates it from sibling SSH tools like ssh_exec or ssh_audit_baseline.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to 'Run it per domain, once ssh_audit_baseline has named the sites,' giving a clear prerequisite and invocation pattern. It does not enumerate when not to use it or name alternatives, but the sequencing guidance is actionable and specific.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ssh_uploadADestructiveIdempotent
Copies a local file or directory to a server, checked by sha256 on both sides and never left half-written at the target. A directory replaces the target whole — whatever was there and is not in the source is gone with it; merge: true keeps it instead. For text you can paste, ssh_file_write is cheaper; piping base64 through ssh_exec truncates silently.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Octal, one value for every file sent. Omit to keep local permissions. | |
| sudo | No | For /etc, /opt and the like, and for setting an owner. Data stages in /tmp first — the machine needs room for a second copy. Default: false | |
| merge | No | Directories only. true = what the target holds and the source does not stays — uploads, .env, logs; same-named files are taken from the source. The tree is still put in place whole, by one rename. mode and owner then cover the kept files too. Default: false | |
| owner | No | "root:root", every file and directory sent. Needs sudo; without it the answer says it was not applied. | |
| verify | No | sha256 on both sides, per file. "unavailable" = no sha256 on the machine = delivered, not broken. "mismatched" fails the call and replaces nothing. Default: true | |
| profile | Yes | Machine name. | |
| timeout | No | Milliseconds. No ceiling by default — a transfer runs as long as it takes. | |
| overwrite | No | false = refuse rather than replace, including when the target cannot be checked. A directory is judged whole, not per file. Default: true | |
| recursive | No | Only to force it — a directory is recognised on its own. | |
| local_path | Yes | A file or a directory on this machine. | |
| remote_path | Yes | Where it goes on the server. A sent directory becomes this path itself and replaces it whole, not file by file — with merge: true what the source lacks stays. |
Output Schema
| Name | Required | Description |
|---|---|---|
| files | No | |
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the idempotentHint and destructiveHint annotations, the description discloses the critical behavior: sha256 verification on both sides, atomic writes that are never half-left, and full replacement of the target directory unless merge:true is set. This is substantive behavioral detail, not just a restatement of annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: the first states the action and key guarantees, the second clarifies the destructive directory behavior, and the third routes to an alternative. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich parameter schema, the output schema, and annotations, the description covers the essential operational invariants: atomicity, verification, destructive replacement, and the relevant alternative. Nothing needed to correctly invoke the tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already covers all 11 parameters richly, so the baseline is 3. The description adds cross-cutting meaning not obvious from individual parameters: the transfer is atomic, directories replace the target whole, and verification is built in. This is useful, but the per-parameter semantic burden is largely carried by the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Copies a local file or directory to a server.' It also distinguishes itself from siblings by noting that ssh_file_write is cheaper for pasteable text, making the tool's role clear against the other SSH tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly gives a decision rule: for text you can paste, use ssh_file_write instead, and warns that piping base64 through ssh_exec truncates silently. This tells an agent when not to use this tool and which sibling to prefer.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
12 tool updates
v2.3.3- Changed
ssh_audit_baseline4 fields changed- changed
Input schema / properties / include_sudo_sections / descriptionPrevious value: -"Read sshd config as sshd sees it (sshd -T), needs root. Without it the ssh section says so instead of guessing from the file. Default: false"New value: +"Run the sections that need root as root: sshd -T for ssh, ufw and iptables rules for firewall. Without it those sections name what they could not read instead of guessing. Default: false" - added
Output schema / properties / firewall / properties / iptables / properties / status / descriptionAdded value: +"not_installed — the tool is absent from the server, so it filters nothing here; no_access — the tool is there, but reading its rules needs root: what it allows is unknown; read — the rules were read, and the fields beside this one come from them." - added
Output schema / properties / firewall / properties / ufw / properties / status / descriptionAdded value: +"not_installed — the tool is absent from the server, so it filters nothing here; no_access — the tool is there, but reading its rules needs root: what it allows is unknown; read — the rules were read, and the fields beside this one come from them." - added
Output schema / properties / legendAdded value: +{ + "additionalProperties": { + "type": "string" + }, + "description": "What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed.", + "type": "object" +}
- Changed
ssh_download4 fields changed- changed
Input schema / properties / verify / descriptionPrevious value: -"sha256 on both sides, per file. \"unavailable\" = no sha256 on the machine = delivered, not broken. Default: true"New value: +"sha256 on both sides, per file. \"unavailable\" = no sha256 on the machine = delivered, not broken. \"mismatched\" fails the call and replaces nothing. Default: true" - added
Output schema / properties / files / items / properties / verified / descriptionAdded value: +"How the sha256 check ended, not whether the data landed — written says that. verified — sha256 was compared after the write and matched; mismatched — sha256 was compared and differed: nothing was replaced, and the path still holds what it held before; unavailable — the check had nothing to work with, and reason says what was missing; skipped — no comparison ran: none was asked for, or nothing landed to compare." - changed
Output schema / properties / files / items / properties / verified / enumPrevious value: -[ - "verified", - "unavailable", - "skipped" -]New value: +[ + "verified", + "mismatched", + "unavailable", + "skipped" +] - added
Output schema / properties / files / items / properties / written / descriptionAdded value: +"Whether the data reached the path. Permissions and owner are a separate matter: one that did not apply is named in reason, and written stays true."
- Changed
ssh_file_list1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "entries": { + "items": { + "properties": { + "group": { + "type": "string" + }, + "mode": { + "description": "Octal, as chmod takes it: \"644\", \"4755\" — not the rwx letters ls prints.", + "type": "string" + }, + "mtime": { + "description": "Seconds since epoch, UTC.", + "type": "number" + }, + "name": { + "description": "Name inside the listed directory; with recursive, the path below it. Never a full path, so it reads the same either way.", + "type": "string" + }, + "owner": { + "type": "string" + }, + "size": { + "type": "number" + }, + "target": { + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "What the entry is, which decides what size means for it. file — a regular file, and size is its bytes; dir — a directory: size is the directory entry itself, never the sum of what it holds; symlink — a symbolic link — target says where it points, and size is the length of that path; other — a socket, fifo or device node: there is no content to read here.", + "enum": [ + "file", + "dir", + "symlink", + "other" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "legend": { + "additionalProperties": { + "type": "string" + }, + "description": "What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed.", + "type": "object" + }, + "path": { + "type": "string" + }, + "truncated": { + "description": "The output limit cut the answer: the directory holds more than entries lists.", + "type": "boolean" + }, + "unreadable": { + "description": "Directories nobody was allowed to enter. Their contents are missing from entries, and a list short by the one that mattered looks complete.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
ssh_file_write4 fields changed- changed
Input schema / properties / files / oneOfPrevious value: -[ - { - "properties": { - "binary": { - "description": "content is base64, decoded before writing. Default: false", - "type": "boolean" - }, - "content": { - "description": "The whole new content, written byte for byte. Replaces the file, never extends it; no trailing newline is added.", - "type": "string" - }, - "mode": { - "description": "Octal string, \"644\". Applied before the file takes its place.", - "type": "string" - }, - "path": { - "description": "Where the file goes.", - "type": "string" - }, - "sudo": { - "description": "Write as root — /etc and anywhere the profile user cannot write. Default: false", - "type": "boolean" - }, - "verify": { - "description": "Compare sha256 before the file takes its place. Default: false", - "type": "boolean" - } - }, - "required": [ - "path", - "content" - ], - "type": "object" - }, - { - "items": { - "properties": { - "binary": { - "description": "content is base64, decoded before writing. Default: false", - "type": "boolean" - }, - "content": { - "description": "The whole new content, written byte for byte. Replaces the file, never extends it; no trailing newline is added.", - "type": "string" - }, - "mode": { - "description": "Octal string, \"644\". Applied before the file takes its place.", - "type": "string" - }, - "path": { - "description": "Where the file goes.", - "type": "string" - }, - "sudo": { - "description": "Write as root — /etc and anywhere the profile user cannot write. Default: false", - "type": "boolean" - }, - "verify": { - "description": "Compare sha256 before the file takes its place. Default: false", - "type": "boolean" - } - }, - "required": [ - "path", - "content" - ], - "type": "object" - }, - "type": "array" - } -]New value: +[ + { + "properties": { + "binary": { + "description": "content is base64, decoded before writing. Default: false", + "type": "boolean" + }, + "content": { + "description": "The whole new content, written byte for byte. Replaces the file, never extends it; no trailing newline is added.", + "type": "string" + }, + "mode": { + "description": "Octal string, \"644\", for this file alone. Applied before the file takes its place.", + "type": "string" + }, + "owner": { + "description": "\"root:root\", for this file alone. Set before the file takes its place. Needs sudo; without it the answer says it was not applied.", + "type": "string" + }, + "path": { + "description": "Where the file goes.", + "type": "string" + }, + "sudo": { + "description": "Write as root, for this file alone — /etc and anywhere the profile user cannot write. Default: false", + "type": "boolean" + }, + "verify": { + "description": "Compare sha256 before the file takes its place. A mismatch fails the call and leaves the path as it was. Default: true", + "type": "boolean" + } + }, + "required": [ + "path", + "content" + ], + "type": "object" + }, + { + "items": { + "properties": { + "binary": { + "description": "content is base64, decoded before writing. Default: false", + "type": "boolean" + }, + "content": { + "description": "The whole new content, written byte for byte. Replaces the file, never extends it; no trailing newline is added.", + "type": "string" + }, + "mode": { + "description": "Octal string, \"644\", for this file alone. Applied before the file takes its place.", + "type": "string" + }, + "owner": { + "description": "\"root:root\", for this file alone. Set before the file takes its place. Needs sudo; without it the answer says it was not applied.", + "type": "string" + }, + "path": { + "description": "Where the file goes.", + "type": "string" + }, + "sudo": { + "description": "Write as root, for this file alone — /etc and anywhere the profile user cannot write. Default: false", + "type": "boolean" + }, + "verify": { + "description": "Compare sha256 before the file takes its place. A mismatch fails the call and leaves the path as it was. Default: true", + "type": "boolean" + } + }, + "required": [ + "path", + "content" + ], + "type": "object" + }, + "type": "array" + } +] - added
Output schema / properties / files / items / properties / verified / descriptionAdded value: +"How the sha256 check ended, not whether the data landed — written says that. verified — sha256 was compared after the write and matched; mismatched — sha256 was compared and differed: nothing was replaced, and the path still holds what it held before; unavailable — the check had nothing to work with, and reason says what was missing; skipped — no comparison ran: none was asked for, or nothing landed to compare." - changed
Output schema / properties / files / items / properties / verified / enumPrevious value: -[ - "verified", - "unavailable", - "skipped" -]New value: +[ + "verified", + "mismatched", + "unavailable", + "skipped" +] - added
Output schema / properties / files / items / properties / written / descriptionAdded value: +"Whether the data reached the path. Permissions and owner are a separate matter: one that did not apply is named in reason, and written stays true."
- Changed
ssh_job_kill2 fields changed- added
Output schema / properties / outcome / descriptionAdded value: +"signalled — the signal reached the process group of the job; gone — the job had already ended, so there was nothing to stop; nopid — the job recorded no pid, so there was nothing to signal; missing — the server knows no job under this id; no-answer — the server did not answer the stop request, so the job state is unknown." - added
Output schema / properties / signal / descriptionAdded value: +"What was actually sent, which is not always what was asked for."
- Changed
ssh_job_list2 fields changed- added
Output schema / properties / jobs / items / properties / started_at / descriptionAdded value: +"Seconds since the epoch; null — the server did not record it." - added
Output schema / properties / jobs / items / properties / state / descriptionAdded value: +"running — started and still running: this is not the outcome, come back later; finished — the job ended and reported its exit code; lost — the job is gone and left no exit code behind; missing — the server knows no job under this id."
- Changed
ssh_job_status2 fields changed- added
Output schema / properties / jobs / items / properties / started_at / descriptionAdded value: +"Seconds since the epoch; null — the server did not record it." - added
Output schema / properties / jobs / items / properties / state / descriptionAdded value: +"running — started and still running: this is not the outcome, come back later; finished — the job ended and reported its exit code; lost — the job is gone and left no exit code behind; missing — the server knows no job under this id."
- Changed
ssh_log_search4 fields changed- added
Input schema / properties / containerAdded value: +{ + "description": "Read this container's output instead of a file: docker is asked where it writes, and the answer names the file it read. Whatever cannot be read this way — a driver that keeps no file, an engine that is not docker, a name nothing answers to — comes back said aloud, naming ssh_exec as the way through. The file belongs to root, so sudo: true. Give this or path, never both.", + "type": "string" +} - changed
Input schema / properties / since / descriptionPrevious value: -"Window: \"today\" | \"2026-08-19\" | \"2h\" | \"3d\", the day taken from the server. Skips files untouched in it (count reported), then keeps only lines dated inside — 2026-08-19, Aug 19, 19/Aug/2026. Undated file: searched whole and named. Under a day filters files, not lines."New value: +"Window: \"today\" | \"2026-08-19\" | \"2h\" | \"3d\", the day taken from the server. Skips files untouched in it (count reported). A window of a day or more then keeps only lines dated inside — 2026-08-19, Aug 19, 19/Aug/2026; a shorter one filters files and leaves their lines alone. Undated file: searched whole and named." - changed
Input schema / requiredPrevious value: -[ - "profile", - "path", - "query" -]New value: +[ + "profile", + "query" +] - added
Output schema / properties / sourceAdded value: +{ + "description": "Named only when container was asked: the engine, the driver and the file the lines were read from.", + "type": "string" +}
- Changed
ssh_log_tail2 fields changed- added
Input schema / properties / containerAdded value: +{ + "description": "Read this container's output instead of a file: docker is asked where it writes, and the answer names the file it read. Whatever cannot be read this way — a driver that keeps no file, an engine that is not docker, a name nothing answers to — comes back said aloud, naming ssh_exec as the way through. The file belongs to root, so sudo: true. Give this or path, never both.", + "type": "string" +} - changed
Input schema / requiredPrevious value: -[ - "profile", - "path" -]New value: +[ + "profile" +]
- Changed
ssh_monitor2 fields changed- changed
Input schema / properties / action / descriptionPrevious value: -"Which of the five to do."New value: +"Which of the five to do. close and reload drop live connections; the other three only read." - added
Output schema / properties / state / descriptionAdded value: +"ready — logged in, commands run; limited — logged in and commands run, but the shell is not POSIX; no-route — the server was never reached; rejected — the server was reached and refused the login. null — nothing was checked: only the test action reaches the server."
- Changed
ssh_service_status2 fields changed- added
Output schema / properties / legendAdded value: +{ + "additionalProperties": { + "type": "string" + }, + "description": "What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed.", + "type": "object" +} - added
Output schema / properties / outcome / descriptionAdded value: +"checked — systemd answered, and the fields below carry its measurement; no_systemd — there was nobody to ask on this server, so the service was not measured; no_unit — systemd knows no such unit, which is not the same as a unit that is stopped."
- Changed
ssh_upload8 fields changed- added
Input schema / properties / mergeAdded value: +{ + "default": false, + "description": "Directories only. true = what the target holds and the source does not stays — uploads, .env, logs; same-named files are taken from the source. The tree is still put in place whole, by one rename. mode and owner then cover the kept files too. Default: false", + "type": "boolean" +} - changed
Input schema / properties / owner / descriptionPrevious value: -"\"root:root\", every file sent. Needs sudo; without it the answer says it was not applied."New value: +"\"root:root\", every file and directory sent. Needs sudo; without it the answer says it was not applied." - changed
Input schema / properties / remote_path / descriptionPrevious value: -"Where it goes on the server. A sent directory becomes this path itself and replaces it whole, not file by file."New value: +"Where it goes on the server. A sent directory becomes this path itself and replaces it whole, not file by file — with merge: true what the source lacks stays." - changed
Input schema / properties / sudo / descriptionPrevious value: -"For /etc, /opt and the like. Data stages in /tmp first — the machine needs room for a second copy. Default: false"New value: +"For /etc, /opt and the like, and for setting an owner. Data stages in /tmp first — the machine needs room for a second copy. Default: false" - changed
Input schema / properties / verify / descriptionPrevious value: -"sha256 on both sides, per file. \"unavailable\" = no sha256 on the machine = delivered, not broken. Default: true"New value: +"sha256 on both sides, per file. \"unavailable\" = no sha256 on the machine = delivered, not broken. \"mismatched\" fails the call and replaces nothing. Default: true" - added
Output schema / properties / files / items / properties / verified / descriptionAdded value: +"How the sha256 check ended, not whether the data landed — written says that. verified — sha256 was compared after the write and matched; mismatched — sha256 was compared and differed: nothing was replaced, and the path still holds what it held before; unavailable — the check had nothing to work with, and reason says what was missing; skipped — no comparison ran: none was asked for, or nothing landed to compare." - changed
Output schema / properties / files / items / properties / verified / enumPrevious value: -[ - "verified", - "unavailable", - "skipped" -]New value: +[ + "verified", + "mismatched", + "unavailable", + "skipped" +] - added
Output schema / properties / files / items / properties / written / descriptionAdded value: +"Whether the data reached the path. Permissions and owner are a separate matter: one that did not apply is named in reason, and written stays true."
9 tool updates
v2.3.0- Changed
ssh_download1 field changed- added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_exec2 fields changed- changed
Input schema / properties / detach / descriptionPrevious value: -"Background job on the server: returns an id at once, outlives this call, timeout does not apply. Follow with ssh_job_status / ssh_job_output, stop with ssh_job_kill. One command, no sudo. Default: false"New value: +"Background job on the server: returns an id at once, outlives this call, timeout does not apply. Follow with ssh_job_status / ssh_job_output, stop with ssh_job_kill. One command. With sudo the job runs as root and every later call follows it as root, provided the profile has a password or sudo needs none. Default: false" - added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_file_write1 field changed- added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_job_kill2 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Job id returned by ssh_exec with detach: true"New value: +"Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass." - added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_job_list1 field changed- added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_job_output1 field changed- changed
Input schema / properties / id / descriptionPrevious value: -"Job id returned by ssh_exec with detach: true"New value: +"Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass."
- Changed
ssh_job_status2 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Job id returned by ssh_exec with detach: true"New value: +"Job id returned by ssh_exec with detach: true. A job started with sudo is reached as root from the id alone — nothing extra to pass." - added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_monitor1 field changed- added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
- Changed
ssh_upload1 field changed- added
Output schema / properties / legend / descriptionAdded value: +"What the words in this answer mean. A key names the field before the value — \"state=limited\", \"jobs[].state=lost\" — and only the values this answer actually used are listed."
18 tool updates
v1.0.0- First observed
ssh_audit_baseline - First observed
ssh_disk_breakdown - First observed
ssh_download - First observed
ssh_exec - First observed
ssh_file_list - First observed
ssh_file_read - First observed
ssh_file_write - First observed
ssh_job_kill - First observed
ssh_job_list - First observed
ssh_job_output - First observed
ssh_job_status - First observed
ssh_log_search - First observed
ssh_log_tail - First observed
ssh_monitor - First observed
ssh_service_status - First observed
ssh_snapshot - First observed
ssh_tls_check - First observed
ssh_upload
TDQS
Scored across 18 tools
Each tool targets a distinct resource and action: file read/write/list/upload/download, job status/output/list/kill, log tail/search, and system snapshot/audit/disk/service checks are clearly separated. Cross-references such as ssh_file_read vs ssh_download and ssh_snapshot vs ssh_audit_baseline reinforce rather than blur the boundaries. ssh_exec is explicitly positioned as a last-resort generic tool, reducing overlap.
All tools share the ssh_ prefix and snake_case, and most follow a domain_action pattern like ssh_file_read, ssh_job_status, and ssh_log_search. A few one-offs such as ssh_snapshot, ssh_monitor, ssh_upload, and ssh_audit_baseline break the otherwise predictable pattern, though they remain readable and recognizable.
At 18 tools, the set is slightly above the typical 3-15 range, but it covers a broad SSH operations domain: execution, files, transfers, detached jobs, logs, monitoring, TLS, disk, and services. Each tool has a distinct role and none feels redundant, so the count is reasonable for the stated scope.
The tool surface covers the main workflows: command execution, file read/write/list/transfer, detached job lifecycle, log tailing/searching, and system/health inspection. Obvious gaps like a dedicated file delete or service start/stop are absent, but ssh_exec provides a universal fallback, so agents can work around those missing operations.
Maintenance
Related MCP Connectors
- emisarOAuthdev.emisar
Let AI operate servers without SSH. Choose actions, approve risky changes, and audit every step.
Remote Desktop Commander: use files, terminal and processes on your own computers from any AI app.
Connect AI assistants to authorized Windows and macOS devices for files, commands, and management.
11Work on your own computers from Claude or ChatGPT: run commands, edit and search files.
Related MCP Servers
- AlicenseAqualityCmaintenanceEnables AI assistants to securely execute remote SSH commands, perform file transfers, and monitor system status through a standardized interface. It features robust security controls including command whitelisting, blacklisting, and credential isolation to prevent unauthorized operations.1011 npmMIT

cygnus-ssh-mcpofficial
AlicenseAqualityAmaintenanceEnables AI assistants to manage remote servers via SSH with 43 specialized tools for command execution, file editing, directory operations, and background tasks across Linux, macOS, and Windows.46104 PyPI8GPL 3.0- AlicenseNot gradedqualityFmaintenanceEnables AI assistants to execute commands and transfer files on remote servers over SSH connections.1MIT
- AlicenseAqualityBmaintenanceEnables AI assistants to manage remote servers via SSH with agentless command execution, file operations, and service management.919 PyPIMIT