Read File (Deprecated)

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

Annotations correctly indicate read-only. But the description only mentions 'complete contents', failing to disclose that tail/head allow partial reads. This omission is misleading despite annotations covering the read-only nature.

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?

Extremely concise: two sentences, front-loaded with deprecation warning. Every word earns its place.

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 output schema exists and annotations are present, the description is minimally sufficient. However, it omits details like encoding or error handling, and the deprecation status reduces its significance.

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 description adds no parameter information beyond the input schema. Schema coverage is 67% (tail and head have descriptions, path does not). The description does not clarify path format or restrictions.

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 it reads a file as text, and the deprecation hints at the sibling tool. However, the phrase 'complete contents' is slightly misleading since the tool can return partial content via tail/head parameters.

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?

Explicitly states it is deprecated and directs to use `read_text_file` instead. This provides clear when-not-to-use guidance and an alternative, which is excellent.

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