gitlab_issue_comment

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

Annotations already declare readOnlyHint=false and openWorldHint=true, so the agent knows this mutates external state. "Append-only" usefully adds that no update/delete path exists, but the description says nothing about required auth scope, failure behavior, or what is returned for the new note.

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 short sentences, action first and the append-only constraint immediately after. Zero filler and nothing to trim.

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 write tool with no output schema and two undocumented required parameters, the definition leaves real gaps: an agent gets no hint that `iid` is the issue number within `project`, nor what the response contains. It is callable but under-specified.

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 only 33%: the workspace-relative `iid` and the `body` parameter are completely undocumented, and the description supplies no meaning for either. Only `project` carries a schema description, so the description fails to compensate for the coverage gap on the two required params.

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?

Specific verb ("Post") plus resource ("a comment (note) on an issue") makes the action unambiguous, and the parenthetical clarifies GitLab's note terminology. It is clearly distinct from siblings like gitlab_issue_get and gitlab_issues_list, though it never names an alternative explicitly.

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?

"Append-only" implies the use case (adding commentary that cannot later be edited or removed) but does not state when to prefer this over any sibling or mention prerequisites such as issue state or permissions. Usage is inferable rather than stated.

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