redmine_issue_add_comment

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

There are no annotations, so the description carries the full burden of behavioral disclosure. The description only states it adds a note, which implies a mutation, but does not mention whether it is reversible, requires specific permissions, or what happens to the issue beyond the note. It also doesn't disclose any potential side effects or rate limits. For a write operation, 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 concise sentence that front-loads the primary purpose and includes a useful comparison. There is no wasted words or redundant information. It is appropriately sized for its content.

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 the tool has 3 parameters, no annotations, no output schema, and no schema descriptions, the description is too sparse. It does not explain what a 'journal note' is, how the parameters interact, or any behavioral expectations. An agent might not know whether the operation is atomic, what the response looks like, or if there are any constraints (e.g., note length limits). It is incomplete for a mutation tool.

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?

The schema has no descriptions (0% coverage), so the description must explain the parameters. It does not elaborate on 'id' (beyond being an issue ID), 'notes' (the note content), or 'private_notes' (its effect). While the parameter names are somewhat self-explanatory, the description fails to add meaning beyond the schema's type and requirement information. It does not even mention that private_notes controls visibility, which is crucial for correct usage.

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 a specific action ('Add a journal note') on a specific resource ('an issue'). It also explicitly differentiates from the sibling tool by noting it is 'same as update with notes only', which tells an agent this is a focused subset of redmine_issue_update. This leaves no ambiguity about what the tool does.

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 'same as update with notes only' implicitly tells the agent to use this when the sole intent is to add a note, rather than the broader update tool. However, it does not explicitly state 'use this when you only need to add notes' nor does it mention any exclusions or prerequisites. Still, the comparison to update provides clear enough guidance for most cases.

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