create_issue_note_tool

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

With no annotations provided, the description carries the full burden of behavioral disclosure. The single word 'Create' implies a write operation, but the description discloses no side effects, idempotency semantics, required permissions, rate limits, or what happens on duplicate submissions. It provides only the barest indication of behavior.

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, efficiently worded sentence with no fluff or redundancy. Its main weakness is being almost too terse, bordering on under-specification, but strictly in terms of conciseness it wastes no words.

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 create-with-3-parameters tool with full schema coverage and an output schema, the description is minimally sufficient. However, given the dense sibling context with similar note-creation tools, a sentence clarifying this creates a standalone note versus a discussion or MR note would make it 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%, with all three parameters (body, issue_iid, project_id) having meaningful descriptions in the schema. The description adds no additional parameter-level detail, but since the schema already documents everything, the baseline of 3 is appropriate.

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 a specific verb and resource ('Create a note (comment) on an issue'), which is understandable. However, it essentially restates the tool's name and provides no differentiation from siblings like create_mr_note_tool, which is a missed opportunity given the many similar note/discussion tools.

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 guidance is provided on when to use this tool versus alternatives such as create_mr_note_tool or list_issue_notes_tool. With 60+ sibling tools, explicit context on when an agent should invoke this specific tool (e.g., to comment on an issue rather than an MR) is absent.

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