budget_vs_actual

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

With no annotations, the description carries the behavior transparency burden. It discloses that all values are read directly from Odoo's computed fields and never recalculated, which is a meaningful behavioral trait. It also implies a read-only operation, though it does not cover error handling or authorization.

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, well-structured sentence that front-loads the tool's purpose and lists the key output components. No redundant filler; every phrase adds value.

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?

The description details exactly what the summary includes (per line and totals for five cost metrics) and clarifies data provenance. Given the tool's simplicity and one parameter, this is reasonably complete, though it omits any explanation of the response structure or error behavior.

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 only one parameter, budget_id, with no description in the schema. The tool description ties it to 'one budget,' which provides minimal contextual meaning. Since the parameter is self-explanatory as an identifier, the description adds just enough for the agent to select the right budget, but not much beyond that.

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 specifies a budget-vs-actual summary for one budget, enumerating the exact fields returned (planned cost, actual cost, ETC, EAC, available budget). It distinguishes itself from sibling tools like search_budget_lines and get_budget by focusing on the variance analysis summary.

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 makes the tool's use case evident: retrieve a budget-vs-actual comparison from Odoo's computed fields. However, it does not explicitly state when to use this over alternatives (e.g., search_budget_lines) or any exclusion conditions, so guidance is only implied.

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