create_issue_note

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

No annotations are provided, so the description must carry the behavioral disclosure burden. It indicates a create/mutation action but offers no information on side effects, permissions, notification behavior, or whether a discussion_id is required to reply within a thread. For a write operation with zero annotation coverage, this is a significant gap.

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 with no filler. It front-loads the verb and resource, making the core purpose immediately visible.

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 plus the fully covered schema is minimally sufficient to invoke the tool for a basic issue note. However, the phrase 'issue thread' is slightly ambiguous between the issue's overall comment thread and a specific discussion thread, and the unusual optional created_at backdating behavior is not contextualized. The lack of usage differentiation also weakens completeness, though schema/name cover most of the mapping.

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 all five parameters are already documented in the input schema. The description adds no extra parameter-level meaning, so the baseline of 3 applies.

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 a specific verb ('Add'), resource ('new note'), and target ('existing issue thread'), which clearly identifies this as the issue-note creation tool. This differentiates it from the many sibling note tools such as create_merge_request_note, create_draft_note, and generic create_note without needing to open the schema.

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 no explicit guidance on when to use this tool versus alternatives, and there are many note-related siblings. It does not state exclusions (e.g., 'for merge request notes, use create_merge_request_note') or mention any conditions that would route an agent to a different tool.

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