append_project_file

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

With no annotations, the description carries the burden of explaining behavior. It does state that content is appended and that the file is created if missing, but it does not mention side effects, permissions, error handling, or restrictions beyond 'plain, user-visible'.

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?

The description is a single, concise sentence with no redundant wording. The core action and key condition are front-loaded and immediately understandable.

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?

The description covers the primary behavior and creation fallback, but it omits context such as what happens if project_dir is invalid, whether existing content is preserved, or what the tool returns. Given the simple operation, this is adequate but not complete.

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 input schema provides no per-parameter descriptions, and the tool description only indirectly suggests that project_dir is the file location, filename names the file, and content is what gets appended. This is insufficient for fully unambiguous parameter understanding.

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 action (append), the target (a plain, user-visible file at the project root), and the fallback behavior (creating it if missing). It is easy to distinguish from sibling write operations because 'append' is explicit.

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 gives no direct guidance about when to choose this tool over alternatives like write_file, write_project_file, or copy_file. The word 'append' implies adding to existing content, but no explicit usage conditions or exclusions are provided.

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