create_note

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It confirms the operation is a create action and names the target, but it does not mention required permissions, whether the note is immediately published versus a draft, how the note body is handled, or what the tool returns. For a mutation tool with no 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 that front-loads the action and target. It contains no filler or redundant wording; every word contributes to the core meaning. While it is minimal, it is appropriately concise for what it states.

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 four parameters, no output schema, no annotations, and a large sibling list, a one-sentence description is not enough. It never explains how to identify the target when project_id and noteable_iid are optional, whether this tool overlaps with create_issue_note/create_merge_request_note, or what the agent can expect in the response. An agent could invoke it incorrectly or select the wrong sibling.

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 the baseline is 3; the schema already documents all parameters and the noteable_type enum. The description adds only the clarification that a note is a comment, which is helpful but does not meaningfully expand param semantics or clarify how the optional project_id and noteable_iid are used to identify the target.

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 uses a specific verb and resource: 'Create a new note (comment) to an issue or merge request.' It clearly identifies the action and target object types. However, it does not differentiate this generic tool from sibling tools like create_issue_note or create_merge_request_note, so it stops short of a 5.

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?

No guidance is given about when to use this tool versus the many sibling note tools, such as create_issue_note, create_merge_request_note, or create_draft_note. There are no conditions, exclusions, or alternative recommendations provided, leaving an agent to guess which tool fits a given scenario.

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