Add Note to Issue

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

Goes beyond minimal annotations: describes return object, UTF-8 support, Markdown handling dependency on config, and view_state access levels. 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?

Five well-organized sentences with no redundancy. Front-loaded with purpose and return, then details, then prerequisites.

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?

Complete coverage for a tool with 3 parameters and no output schema: describes return fields, encoding, behavior, and prerequisites. No gaps.

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 coverage is 100%; description adds practical context for each parameter, such as details on encoding for text and how to obtain issue_id. Adds value beyond 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?

Clearly states the action 'Add a note (comment) to an existing MantisBT issue' and specifies the return object with fields. Distinguishes from sibling tools like delete_note and list_notes.

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 prerequisites for obtaining issue_id and explains when to use private vs public view_state. Lacks explicit guidance on when not to use this tool or alternatives, but context is clear.

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