ssh_read_file

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states the basic action without detailing authentication requirements, error handling, file size limits, or whether it returns raw content or requires a session. For a tool establishing an SFTP connection, much behavioral context is missing.

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 a single sentence that conveys the core purpose efficiently without any fluff or redundant information. Every word serves a purpose, making it appropriately concise.

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?

Despite having 6 parameters and no output schema or annotations, the description is minimal. It does not explain return values, error behavior, required authentication setup (e.g., SSH keys), or how the file content is presented. The schema covers parameters but not runtime behavior, leaving the agent underinformed.

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?

The schema covers all 6 parameters with descriptions (100% coverage), so the baseline is 3. The tool description does not add extra semantics beyond what the schema already provides, but it also does not repeat information, so it meets the baseline.

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 'Read', the resource 'file from a remote host', and the protocol 'SFTP', making the tool's purpose unambiguous. It contrasts with siblings like ssh_write_file (write) and ssh_download (download), though ssh_download might overlap; however, the verb 'read' implies returning file contents, which is clear.

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 like ssh_download or ssh_exec with cat. With many sibling tools, explicit context on usage scenarios or exclusions would greatly help an AI agent choose correctly.

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