Create Issue Note

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

Annotations already indicate readOnlyHint=false and destructiveHint=false, so the agent knows this is a write operation. The description adds no extra behavioral context, such as permission requirements, that creating a note is non-idempotent (each call adds a new note), or that it appends to the issue. Since it adds nothing beyond annotations, the score is low.

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, front-loaded sentence with no wasted words. It is concise and easy to parse. However, it is so terse that it misses opportunities to include meaningful guidance, which keeps it from a perfect score.

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?

Given the tool's moderate complexity (6 parameters, 3 required) and the rich schema descriptions, the minimal description is functional but leaves gaps. It does not mention return values, typical use cases, or the significance of parameters like 'created_at' or 'internal'. The schema and annotations compensate partially, but the description alone is not fully 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 clear descriptions for each parameter (e.g., 'body' as 'The content of the note/comment'). The tool description itself does not mention any parameter details, so it relies on the schema. This meets the baseline of 3, as the schema already provides the necessary meaning.

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 tool's action with a specific verb ('Create') and a specific resource ('a new note/comment on an issue'). This distinguishes it from sibling tools like gitlab_edit_issue_note (edit an existing note) and gitlab_get_issue_notes (list notes).

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 provides no guidance on when to use this tool versus alternatives. It does not mention scenarios (e.g., 'Use this to add a comment to an issue') or exclude cases where other tools are more appropriate. It is a bare definition with no usage context.

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