Create MR Discussion Note

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

Annotations indicate a write operation (readOnlyHint=false) and openWorldHint=true, but the description adds no behavioral context beyond the verb 'Add note'. It does not disclose side effects, permissions, or other traits that would help an agent assess risk.

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 that immediately conveys the core purpose. It is efficiently front-loaded without unnecessary 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?

Given 5 parameters and no output schema, the description is too brief. It lacks information on prerequisites, return values, error cases, or the relationship to other tools like gitlab_create_merge_request_note, leaving the agent underinformed.

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?

With 0% schema description coverage, the description should compensate but only gives high-level context. It does not explain individual parameters (e.g., 'project_id' or 'created_at') nor provide format or usage details beyond what parameter names imply.

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 note') and the target resource ('existing MR discussion thread'), which effectively distinguishes it from creating a new thread. However, it does not explicitly differentiate from other note-creation tools like gitlab_create_merge_request_note, leaving some ambiguity.

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 tool is for existing threads but provides no explicit guidance on when to use it vs. alternatives (e.g., gitlab_create_merge_request_thread or gitlab_create_merge_request_note). No exclusion criteria or usage context is given.

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