Get help on using the remote-ssh-cli command-line tool to manage SSH hosts outside the MCP protocol. Returns installation, usage, and troubleshooting instructions for the standalone CLI.

List the SSH hosts known to the server. Each entry contains exactly two fields: 'sys_name' (the host name) and 'uid' (its unique identifier). Start here: pass a 'uid' value to the other tools as their host_id argument. No address, port, user name or credential is returned.

Create a new SSH host entry. The supplied password or private key is encrypted at rest and never returned by any tool. The response contains the new host's public metadata, including the uid that identifies it in host_list.

Update fields on an existing host. Call host_list first — it returns the uid of every host, and that value is what host_id expects. Omit a credential field to keep the current value. Supply an empty string to clear it (only valid if you also flip the auth method).

Permanently delete a host entry. Call host_list first — it returns the uid of every host, and that value is what host_id expects.

Run a single non-interactive shell command on a remote host. Returns stdout, stderr, exit code, and duration. Call host_list first — it returns the uid of every host, and that value is what host_id expects. The model must use host_id only; connection credentials are resolved server-side and never returned. The model MUST supply timeout_seconds (1-600) appropriate for the command; the command is terminated when the timeout expires.

Run a command on a remote host that needs to consume expect/answer prompts (e.g. sudo). Each entry in 'expects' is an object with 'expect' (the prompt text to wait for) and 'answer' (the response to send back). Call host_list first — it returns the uid of every host, and that value is what host_id expects. The model must use host_id only; credentials are resolved server-side. The model MUST supply timeout_seconds (1-600) appropriate for the command.

Execute a multi-step playbook on a remote host. The 'content' field is a multi-line string. Supports structured format with directives: '# @section "Title"' to group steps into sections, '# @desc "description"' for section description, '# @note "text"' for step notes, '# @danger "text"' for danger warnings, and '# @on "command"' for interactive commands (replaces legacy 'expect:'/'answer:' syntax). Legacy format (one command per line with optional 'expect:'/'answer:' pairs) is also supported. Stops on the first non-zero exit code and returns the transcript of every step that ran. Call host_list first — it returns the uid of every host, and that value is what host_id expects. The model must use host_id only; credentials are resolved server-side. The model MUST supply timeout_seconds (1-600) — it is the budget for the WHOLE playbook, each step only gets the time that is left.