write_file

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

No annotations provided, so full burden on description. It says 'overwrite' implying destruction, but lacks detail on whether it truncates existing files, handles binary vs text, permissions, or how the createDirs parameter affects behavior. Agent cannot assess safety or side effects.

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 sentence is very concise and front-loaded with the core action. No unnecessary words, but could improve by mentioning the optional createDirs parameter briefly.

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?

With no output schema and no annotations, the description is insufficient for a 3-parameter tool. It lacks details on return values, error handling, whether content is appended or truncated, and the role of createDirs. Agent needs to guess or infer from other contexts.

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 covers 67% of parameters with descriptions, but description adds no extra meaning for any parameter. The 'createDirs' parameter is missing from description and schema lacks a description, leaving its purpose unclear. Agent must infer from name.

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 identifies the verb 'write' and resource 'file', indicating creation or overwriting. It distinguishes from sibling tools like list_directory and file_info, but doesn't specify the exact behavior (e.g., creates new file if missing).

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 on when to use this tool vs alternatives, such as choosing between write and other file operations. No mention of prerequisites or side effects like needing directory existence (though createDirs parameter exists in schema but not described).

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