create_issue_note

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

The only annotation is openWorldHint: true, which is vague. The description does not disclose any behavioral traits beyond what the schema offers, such as permissions needed, side effects, or error cases. For a tool that creates content, more context is expected.

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 sentence, concise and front-loaded. Every word adds value without redundancy.

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 tool has 5 parameters and no output schema. The description is partially complete: it covers the main purpose but does not describe the return value or behavior when the issue or project is invalid. Given the presence of sibling tools, this omission reduces completeness.

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%, so a baseline of 3 is appropriate. The description adds value by clarifying that discussion_id is for replying, but it does not explain the format of created_at or other nuances beyond the schema.

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 states the verb 'Add' and the resource 'note to an issue' with the optional behavior of replying to a discussion thread. This is specific and distinguishes it from sibling tools like create_merge_request_note or create_note.

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 when to use (when adding an issue note, optionally as a reply) but does not explicitly state when not to use it or provide alternatives. No comparison with sibling note tools is provided.

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