Create Issue Note

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

The description adds context that it can be a top-level comment or a discussion reply, which is beyond annotations. However, it does not disclose details like auth requirements, what happens to existing threads, or other side effects. Annotations already provide readOnlyHint=false and destructiveHint=false.

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 front-loads the key action and resource. While it is not verbose, it could include more detail without becoming wasteful.

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 lacks details about return values (no output schema), the differences between top-level and discussion notes, and parameter handling. For a tool with 5 parameters and no output schema, the description is too minimal to be fully actionable.

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 must compensate but does not explain any parameter semantics. Terms like 'discussion_id' and 'created_at' are not clarified, leaving the agent with no guidance on their meaning or usage.

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 'Create issue comment (top-level or discussion note),' specifying the verb (create), resource (issue comment), and two distinct modes. This distinguishes it from sibling tools that create notes on other objects like merge requests or work items.

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 gives implied usage for issues but does not explicitly state when to use this tool versus alternatives like gitlab_create_merge_request_discussion_note. No when-not-to-use or prerequisites are mentioned.

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