Update SSH host

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description goes well beyond the annotations by disclosing the critical behavioral trait: the call replaces the host's configuration, does not merge, and resets every omitted field to its default, including username, password/key, and enableX toggles. This prevents a dangerous incorrect assumption and is genuinely additive.

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 compact at three sentences and front-loads the most important warning. The opening 'Update SSH host.' is redundant with the title, but the rest of the sentences are dense and high-value, which is appropriate for a 43-parameter mutation.

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 tool's complexity and sparse annotations, the description covers the prerequisite call, the complete-payload strategy, and the main failure mode. It does not mention return values or explicitly point to the partial-update sibling, but those are minor gaps for this operation.

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?

With only 23% schema description coverage, the description should compensate, and it partially does by telling the agent to fetch and resend existing fields and by highlighting reset-prone categories. However, it does not add meaning for the required id/ip/port fields or the many other undocumented parameters, so compensation is incomplete.

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 action: updating an existing SSH host configuration. The 'replaces, does not merge' warning distinguishes it from partial/bulk update siblings like termix_hosts_bulk_update_partial_fields_multiple_ssh, and the word 'existing' separates it from create_ssh_host.

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 provides an explicit precondition workflow: call termix_hosts_get_ssh_host_id first and resend all fields. It also warns that omitting fields resets them, which effectively tells the agent when not to call it naively. It stops short of naming the partial-update alternative, so it is not a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.