Create issue note

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

The description does not disclose side effects, return values, or idempotency. Annotations indicate a write operation (readOnly=false) but provide no additional behavioral hints, so the description carries some burden but only adds minor detail.

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, concise sentence without unnecessary fluff, effectively communicating the core purpose.

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 is adequate for a simple create operation, but it omits details about expected return data, input formatting (e.g., body content), or error conditions. Given the low complexity, the missing context is moderate.

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 descriptions cover only 50% of parameters (project and issue_iid), leaving body and internal undocumented. The description does not compensate by explaining these parameters, reducing clarity for users.

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 action ('Add a top-level comment') and the target resource (GitLab issue), distinguishing it from other note operations like list, update, or delete.

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 phrase 'as the authenticated user' gives context on permissions, but it does not explicitly mention when to prefer this over other note-related tools. However, the verb 'Add' implies creation, which is clear from the sibling tool names.

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