write_file

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

No annotations are provided, so the description carries the burden. It adds two useful behaviors: 'safely' (implying guard rails) and 'audit logging' (a side effect not visible in schema). However, it does not disclose permissions required, what 'safely' means operationally, or reversal semantics for destructive overwrites.

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, front-loaded with the verb and resource, with no filler.

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?

For a mutating file-write tool with no annotations and no output schema, the description omits critical context: required repository permissions, behavior on overwrite:false when the file exists, and what 'safely' guarantees. It leaves the agent unable to predict failure modes.

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% and documents all four parameters including 'overwrite' default true. The description adds no parameter-level detail beyond what the schema already provides.

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?

Clear verb+resource: 'write or update a file inside an NSTOK repository'. Distinguishes from read_file and create_* siblings by naming the write action and scoping to file operations, though it doesn't explicitly name an alternative for when not to use it.

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 indication of when to use this vs. alternatives (e.g., create_branch/create_commit for versioned changes, or read_file for reads). The agent must infer usage purely from the verb 'write'.

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