freee_update_deal

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

Discloses that details array replaces all existing details, a key behavioral trait. However, with no annotations, it lacks information on permissions, side effects on other fields, or error conditions. Moderate but not comprehensive.

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?

Two sentences that efficiently convey purpose, key behavior, and prerequisite. No fluff, front-loaded with primary action.

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?

Covers purpose, destructive replacement behavior, and prerequisite. Lacks description of return value or behavior of unspecified fields, but given no output schema and moderate complexity, it provides essential context.

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 coverage is 100%, so schema already documents parameters. Description mentions fields (issue date, type, detail lines) but adds no new semantic meaning beyond what schema provides, resulting in baseline 3.

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?

Clearly states action (update), resource (deal/transaction), and modifiable fields (issue date, type, detail lines). Distinguishes from sibling tools like freee_create_deal by focusing on updating existing deals.

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?

Explicitly advises to use freee_get_deal first to review current state before updating, providing clear guidance on when to use this tool and a prerequisite action.

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