update_journal_entry

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

No annotations are supplied, so the description carries the full behavioral burden and does not meet it. It never mentions the SyncToken concurrency requirement, whether the update replaces or merges fields (the sparse flag), what happens to omitted lines, or permission 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?

A single front-loaded sentence with zero wasted words, but brevity here reflects under-specification rather than efficient structure. There is no second sentence to convey the required-call sequence or mutation semantics.

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?

This is a deeply nested mutation tool with a required params.journalEntry object, no annotations, and no output schema. Given that complexity, a one-sentence description leaves out the read-modify-write pattern, SyncToken handling, and sparse-vs-full update semantics that an agent needs to invoke it correctly.

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 reported at 0%, so the description is expected to compensate, and it adds nothing about Id, SyncToken, sparse, TxnDate, Line, or the PostingType/AccountRef nesting. Some ad-hoc descriptions exist inside the schema, but the tool description itself provides no parameter meaning.

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 states a specific verb and resource ("Update a journal entry") and names the target system, QuickBooks Online. An agent can tell it mutates an existing journal entry rather than creating, reading, or deleting one, though it does not explicitly distinguish itself from siblings such as get_journal_entry or delete_journal_entry.

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?

There is no guidance on when to use this tool versus alternatives, nor any prerequisite workflow. Notably, updating a QuickBooks journal entry requires the current SyncToken, which normally implies calling get_journal_entry first — the description never says so.

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