ssh_file_write

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

The description mentions it handles special characters and multi-line content, and returns a dictionary. However, it does not explicitly highlight the destructive nature of overwriting by default, nor does it describe error conditions, permission requirements, or side effects like changing file mode or creating directories. With no annotations, the description carries the full burden and is only partially transparent.

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 very concise: two sentences for the main function and one for the return value. No unnecessary words or repetition; it is efficiently 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?

Given the tool's complexity (6 parameters, output schema, no annotations), the description is minimally adequate. It covers the primary function but lacks details on return value structure, error handling, and contextual notes about directory creation or sudo behavior. The output schema is not visible, so some completeness is lost.

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 parameters are already well-documented in the schema. The tool description adds no additional meaning beyond summarizing the operation. 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 clearly states the tool creates or modifies files with specified content, specifying overwrite and append modes. It distinguishes itself from sibling tools like ssh_file_read, ssh_file_copy, etc., which deal with reading or copying rather than writing.

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 is provided on when to use this tool versus alternatives. There is no mention of prerequisites (e.g., connection must be established) or conditions like when to use append instead of overwrite.

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