redmine_update_journal

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It thoroughly covers: in-place editing, the behavior of clearing notes (deletes journal if no other changes), input formatting rules (actual newlines, not escape sequences), Markdown rendering, read-only flag honoring, and permission model. This is comprehensive and leaves no ambiguity about side effects or constraints.

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 well-structured with a clear lead sentence, followed by a requirements note, a prerequisite reference, parameter details in a bullet-like format, and additional context. It is concise overall, though the parameter details could be slightly more streamlined. However, every sentence serves a purpose, making it efficient for an AI agent 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?

Given the tool's complexity (mutation with side effects, permissions, formatting rules, output schema exists so return value documentation not required), the description is remarkably complete. It covers prerequisites, required inputs, edge cases (empty notes, deletion), formatting, permissions, and read-only behavior. No additional information seems necessary 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 0%, so the description must compensate. It does so excellently: for journal_id it notes it's numeric; for notes it explains it's replacement text, the impact of empty string (clear note and potentially delete journal), the requirement for actual newlines, and that Redmine renders notes as Markdown. This adds critical meaning beyond the bare schema with just types and titles.

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 action ('Edit an existing journal entry's notes in place') and identifies the specific resource (journal entry). It distinguishes itself by referencing the need to use redmine_get_journals to find the journal_id, implying a prerequisite that sets it apart from other tools. The verb and resource are specific and unambiguous.

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 provides explicit prerequisites: Redmine 5.0+ and the need to obtain a journal_id via redmine_get_journals. It also mentions that the tool honors the REDMINE_MCP_READ_ONLY flag and describes permission requirements (user can only edit own notes unless they have edit_issue_notes permission). However, it does not directly contrast with sibling tools like redmine_add_comment or redmine_update_issue, which could be alternatives for adding comments vs. editing existing journal notes.

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