format_file

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

With no annotations, the description must disclose behaviors itself. It mentions 'in-place' modification, a key behavior. However, it lacks details on error handling, prerequisites (fprettify installation), backup behavior, or what happens on failure. Basic but not thorough.

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?

Single concise sentence front-loading the key action, resource, method, and purpose. No wasted words.

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 6 parameters, no annotations, and an output schema, the description covers basic purpose and behavior. However, it omits information about return values, error states, and does not differentiate from 'format_code' sibling. Moderately complete but could be improved.

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% with each parameter described. The description adds no additional meaning beyond what the schema provides; it reinforces the auto-formatting context but does not explain parameter nuances.

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 'Auto-formats', the resource 'local Fortran file', the method 'using fprettify', and the goal 'enforce modern indentation and spacing'. It distinguishes from siblings like 'format_code' (likely for other languages) and 'lint_file' (checking style).

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 implies use for Fortran files but does not explicitly state when to use this tool over alternatives like 'format_code', nor does it mention when not to use it or any prerequisites. Guidance is minimal.

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