Add Note to Issue

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

Annotations indicate non-read-only, non-destructive, non-idempotent. Description adds value by detailing return fields (id, created_at, reporter, etc.) and noting UTF-8/Markdown behavior. No contradictions with annotations.

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?

Three sentences covering purpose, return data, text support, view_state guidance, and prerequisites. No redundancy, front-loaded with essential info.

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?

Fully explains return data without output schema, addresses text encoding and privacy settings, provides prerequisites. Given 3 simple params and annotations present, description is complete.

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 descriptions already cover all 3 parameters (100% coverage). Description adds nuance (e.g., 'reporter-level access or higher' for view_state) and reaffirms UTF-8 support. Baseline 3, extra context justifies 4.

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?

States verb 'Add' and resource 'note to an existing MantisBT issue'. Clearly distinguishes from siblings like delete_note and list_notes by specifying the operation and return object.

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?

Provides explicit prerequisite ('obtain issue_id from list_issues, get_issue, or search_issues') and guidance on when to use private vs public view_state. No explicit 'when not to use' but context from siblings and description is clear.

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