Read a remote file as text (SFTP)

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

Discloses redaction of secrets and byte limit, but lacks details on error handling, permissions, symlink behavior, or encoding fallback. With no annotations, more transparency 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 fluff, directly conveys core functionality and key behavioral note.

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?

No output schema, missing return structure and behavior for binary files or non-UTF-8 encoding. Adequate for simple reads but incomplete for edge cases.

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 33%; description only reinforces maxBytes. Parameters remotePath and connectionName lack both schema and description elaboration, leaving agents guessing.

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 the tool reads a remote file as UTF-8 text with a byte limit and redaction, distinguishing it from siblings like write_remote_file and download_file.

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 explicit guidance on when to use this tool vs alternatives like download_file or exec. The purpose is clear from sibling names, but no when-not-to-use context is provided.

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