Add Redmine Issue 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 disclosing behavior. It does disclose that the tool requires REDMINE_ENABLE_WRITE=true, which indicates a write operation. However, it does not mention side effects, error handling, or idempotency, leaving significant gaps for a mutation tool.

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, concise sentence. It includes the essential purpose and a critical prerequisite with no unnecessary words, making it efficient and easy to parse.

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 tool is simple with only two clearly named parameters, and the description covers the core action and a key environment requirement. However, it does not explain what happens after the operation (e.g., return value, error responses), nor does it clarify whether notes are appended or replaced. For a write operation, this leaves some ambiguity.

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 0%, so the description must compensate, but it does not. The parameter names 'id' and 'notes' are somewhat self-explanatory, and the schema provides constraints, but the description adds no explicit meaning about what these parameters represent or how they should be used.

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 clearly states the tool's function with a specific verb ('Add') and a specific resource ('a note/comment to a Redmine issue'). It distinguishes itself from the sibling tool create_issue by focusing on adding a note to an existing issue rather than creating a new one.

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 like create_issue. It mentions the REDMINE_ENABLE_WRITE requirement but does not explain the context in which this tool should be selected, nor does it state any exclusions or when not to use it.

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