ssh_upload

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

No annotations are provided, so the description must fully disclose behavior. It mentions SFTP and modes but omits critical details like overwrite behavior, authentication requirements, error handling, or file permissions. This gap leaves the agent unaware of potential 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?

Two sentences with zero waste. The first sentence clearly states the core action, and the second efficiently lists the supported modes and parameters. Front-loaded and easy to parse.

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?

For a file upload tool with 5 parameters, the description covers the main usage patterns (file, glob, directory) and the relevant parameter (preserve). It lacks details on return values (not needed without output schema) and error scenarios, but overall provides sufficient guidance for typical use.

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%, baseline 3. The description adds meaning beyond the schema by explaining how glob patterns upload matches into remotePath, that recursive=true is required for directories, and what the preserve parameter does (preserve mode/timestamps). This enhances parameter understanding.

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 verb 'Upload' and the resource 'remote server over SFTP'. It distinguishes itself from siblings like ssh_download (download), ssh_exec (execute commands), ssh_list (list files), and ssh_list_servers (list servers) by focusing on uploads.

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?

The description specifies when to use the tool (for uploads) and details three modes: single file, glob pattern, and directory with recursive=true. It implies usage context but lacks explicit exclusions or alternative tool suggestions (e.g., 'Use ssh_download to retrieve files').

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