ssh_upload

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

Even without annotations, the description fully discloses behavioral traits: mutation, non-idempotent, no backup, no sudo, blocked in certain modes. This gives the agent a clear understanding of side effects.

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?

Five sentences, each adding essential information. Front-loaded with the core action. No redundant phrases.

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?

Covers key aspects: action, mutability, idempotency, preconditions, security mode restrictions, alternative tool. No output schema, but typical for upload tool. Could mention success/failure feedback, but sufficient.

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 covers all parameters with descriptions. The description adds value beyond schema by specifying that the remote path must be writable by the configured SSH user (no sudo). This is non-obvious from schema alone.

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?

Description clearly states it uploads a single local file to a remote path via SFTP, overwriting any existing file. It distinguishes itself from the sibling tool ssh_sync for directory trees.

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?

Provides explicit when-to-use (single file upload) and when-not-to (use ssh_sync for directories). Also notes blocking conditions (readonly/restricted mode) and prerequisites (local file must exist, remote path writable).

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