odoo_refresh

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

With no annotations, the description carries the full burden. It discloses the main effect (send refresh notification) and the module requirement. However, it does not detail potential failure modes, rate limits, or what happens if the module is absent. The behavioral disclosure is adequate but not exhaustive.

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 two sentences long, front-loads the action, and contains no superfluous information. Every sentence serves a purpose: stating the action and the prerequisite.

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 low complexity, no output schema, and no annotations, the description provides adequate information: what it does, when to use it, and a prerequisite. It could mention that the user must have the Odoo tab open, but overall it is sufficiently complete for an agent to use 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?

The input schema already provides descriptions for two of three parameters (model, res_id), giving 67% coverage. The description does not add new semantics beyond what the schema offers; it repeats or implies the same. The 'connection' parameter lacks description in both schema and description, but the default value hints its purpose. Overall, no significant value 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 'Send a refresh notification... after creating, updating, or deleting records so the user's view reloads automatically.' This specifies the verb (send refresh), resource (user's Odoo browser tab), and context (post-mutation). It effectively distinguishes from sibling tools, none of which offer similar refresh functionality.

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 explicitly states when to call: 'after creating, updating, or deleting records.' It also mentions a prerequisite: requires the 'l10n_bg_claude_terminal' module. While it does not explicitly exclude other scenarios or name alternatives, the guidance is clear and helpful for an agent.

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