log_append

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

With no annotations, the description carries the behavioral disclosure burden. It clearly marks the call as a WRITE, states that it appends rather than overwrites, and documents the create-if-missing side effect. It stops short of auth/error behavior, but the core side effects are transparent.

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 tight sentences front-load the core action and then add cadence plus the create-if-missing behavior. There is no filler, repetition, or unnecessary detail.

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 action, target, usage timing, and an important side effect, which is most of what an agent needs for this simple write tool. The presence of an output schema reduces the need to document return values; the main gap is the undocumented optional area parameter.

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 description coverage is 0%, so the description must add meaning. It maps repo, line, and commits to real semantics, but the optional area parameter is never mentioned, and format details for dates or commit identifiers are absent.

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 uses a specific verb ('appends') and a precise resource ('the repo log'), and clarifies scope: 'one dated line ... with the commits it produced.' This clearly distinguishes it from append_file and other file-oriented siblings.

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?

It gives explicit cadence guidance: 'Run once at the end of a session per repo.' It does not list alternatives or when-not-to-use conditions, but the session-end trigger is a clear usage context.

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