create_issue_note

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

With no annotations, the description carries the full behavioral burden and falls short. It implies a mutation (a note is created) but does not disclose permission requirements, whether notes can be edited or deleted afterward, or any rate/side-effect behavior — significant gaps for a write tool.

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?

A single front-loaded sentence with no filler. It is appropriately tight, though arguably it is terse enough that some useful context was dropped.

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 simple 3-parameter tool with full schema coverage and no output schema, the description covers the core concept. However, with zero annotation coverage on a mutation tool, it omits the behavioral grounding an agent would need, leaving it only minimally 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?

Schema description coverage is 100%, so the schema already documents project_id, issue_iid, and body in detail. The description adds the notion of 'progress/verification note' as content intent but no syntax or format beyond the schema — baseline 3 applies.

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?

States a specific verb ('Post') and resource ('comment or progress/verification note to an issue'), which distinguishes it from create_issue, list_issue_notes, and create_merge_request_note by scope. It is clear but never explicitly contrasts itself with those 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?

The description implies the use case (posting comments/progress notes) but gives no explicit when-to-use guidance and no alternatives. It doesn't tell the agent when to prefer this over create_issue or list_issue_notes, leaving routing entirely to inference.

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