Register or update host
hz_host_registerRegister or replace an SSH host in the registry so it becomes reachable over SSH. Returns a dry-run plan by default; set confirm=true to save, with an optional SSH login test.
Instructions
Add a host to the registry (or replace its entry). Only registered hosts are reachable over SSH. Set protected=true on the mail server. test_ssh checks the login before saving.
Safety: dry run unless confirm=true.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>",
"address": "<address>"
},
"name": "hz_host_register"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Short registry name, e.g. app or mail | |
| port | No | ||
| role | No | Free label: mail, app, coolify, db … | app |
| sudo | No | Prefix privileged commands with sudo -n. Default: user is not root | |
| user | No | root | |
| caddy | No | ||
| notes | No | ||
| address | Yes | IP or hostname SSH connects to | |
| confirm | No | false (default) returns a dry-run plan and changes nothing. true executes the plan. | |
| test_ssh | No | ||
| protected | No | Refuse destructive operations on this host | |
| stacks_dir | No | Where compose stacks live: <stacks_dir>/<name> | /opt |
| allowed_paths | No | ||
| hcloud_server | No | Matching Hetzner Cloud server name | |
| hcloud_project | No |