redmine_edit_journal

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

With no annotations, the description carries the burden. It discloses the constraint 'Only the notes text can be changed' and the version requirement 'Requires Redmine 5.0+'. However, it does not mention permissions, reversibility, or what happens if the journal doesn't exist, leaving some behavioral gaps.

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, front-loaded with purpose, then prerequisite, then constraints. No wasted words; every sentence provides necessary context.

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 two-parameter tool with no annotations or output schema, the description covers the essential workflow (how to get ID), the limitation (only notes), and a compatibility note. It lacks error handling or response details, but those are not critical for this scope, so it is reasonably 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 description coverage is 100% for both parameters, so the schema already documents them well. The description adds a workflow hint about using redmine_get_issue to obtain journal_id, but this is also in the schema ('visible in redmine_get_issue output'). No significant parameter meaning added 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?

The description clearly states it edits existing journal text on a Redmine issue, using the specific verb 'edit' and identifying the resource as a journal. It distinguishes from siblings by noting 'Only the notes text can be changed', which differentiates from broader update_issue or add_note.

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 guidance: 'Use redmine_get_issue first to find the journal ID you want to edit.' It implies this tool is for modifying existing notes rather than adding or updating entire issues. Lacks explicit exclusions but gives clear context for when to use it.

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