append_trail

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

With no annotations provided, the description carries the behavioral disclosure burden. It explicitly reveals the external side effect of posting a comment on a GitHub issue and the precondition that an issue must exist. This is useful because the operation is mutating and depends on external state, even though it does not detail failure modes or idempotency.

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 dense sentences with no filler. The action and mechanism are front-loaded, and the crucial prerequisite is stated in the second sentence. Every clause earns its place.

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 tool with an output schema and six parameters, the description provides the essential operational context: what it does, how it does it, why it is useful, and the prerequisite to satisfy before calling it. An agent has enough information to select it and invoke it correctly.

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 100%, so the schema already documents every parameter. The description adds only indirect context by framing the operation as appending a comment-based trail entry, which hints at the role of note but does not materially improve on the schema's own parameter descriptions.

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 and resource: 'Append one entry to a task's trail by posting a comment on its GitHub issue.' This clearly differentiates it from the sibling get_trail, which reads the trail, and from edit_task/amend_task, which modify task fields rather than append trail entries.

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 states a clear prerequisite and directs the user to sync first: 'Requires the task to have an issue (sync it first).' It also gives the intended purpose ('so a later session can backtrack it'), which helps the agent decide when this tool is appropriate, though it does not explicitly describe exclusions or compare with alternatives.

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