file.read

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

Discloses return values and explains that content_hash enables precondition for surgical edits, providing behavioral context. With no annotations, this carries the full burden and does so well.

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 concise sentences: first states purpose, second adds return value details and use case. No superfluous information.

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 core functionality and return values, but omits explanation of 'vault' parameter, file path expectations, or any limitations. Adequate for a simple tool but incomplete given missing parameter info.

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?

Description adds no meaning beyond the input schema for parameters 'file' and 'vault'. Schema coverage is 0% and description does not explain parameter roles or formats.

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?

Clearly states 'Read a file's full content' and enumerates return values (content, content_hash, totalLines), distinguishing it from siblings like file.read_range that read partial content.

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?

Implied usage for reading full file content, but no explicit guidance on when to use this versus alternatives like file.read_range or file.diff among the 30+ sibling tools.

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