ssh_write_file

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

Discloses automatic backup creation, which is a key behavior, but omits details like overwrite behavior, network requirements, or failure handling. With no annotations, more depth is needed.

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, no irrelevant details, front-loads the primary action and key feature (auto-backup). Efficient use of space.

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?

Lacks explanation of return values, error states, prerequisites (SSH access), and how backup is stored. For a tool with 5 parameters and no output schema, more context is warranted.

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%, so baseline is 3. The description adds minimal value beyond the schema (e.g., mentions backup creation but schema already defines the backup parameter).

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 'writes a file' and the resource 'on a Proxmox node via SSH', distinguishing it from sibling tools like ssh_read_file (reading) and vm_file_write (writing to VMs).

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?

No guidance on when to use this tool versus alternatives (e.g., vm_file_write for VM files, ssh_execute for commands). The agent must infer context from the description alone.

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