Add Note to Redmine Issue

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

Annotations already signal that this is a non-read-only, non-idempotent, non-destructive operation, so the bar is lower. The description adds a useful behavioral guarantee that no other fields are modified and mentions that a confirmation is returned, but it does not describe error cases, permissions, or duplicate-note behavior. The added context is meaningful but limited.

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 concise and well-structured, with the core purpose front-loaded and an Args list for quick scanning. The Args block largely duplicates schema informationcars, but it is compact and not padded. The 'Returns: Confirmation' line is minimal but not wasteful.

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?

For a simple three-parameter mutation tool with fully documented schema and annotations, the description is nearly complete. It explains the operation, the key distinction from field updates, the parameter defaults, and the return expectation. The main gap is the lack of explicit routing guidance toward this tool instead of redmine_update_issue, but overall the definition is sufficient for correct invocation.

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 schema already documents all three parameters fully. The description's Args section repeats the parameter names, requiredness, and the private_notes default, but it does not add any meaning beyond what the input schema already provides. Baseline 3 is appropriate.

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: 'Add a comment/note to an existing Redmine issue'. The clause 'without changing any other fields' sharply distinguishes it from redmine_update_issue and redmine_create_issue, so an agent can tell what this tool is for even without inspecting 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 phrase 'without changing any other fields' implies this tool is for adding a note only, not for broader issue editsable, but it never explicitly names alternatives such as redmine_update_issue or states when not to use this tool. Usage context is present but only implicit.

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