odoo_website_update_snippet

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

The description explains the update process (find, modify, write back) and mentions the substitution syntax, but lacks details on permissions, error scenarios (e.g., xpath not found), or side effects. Since no annotations are provided, the description carries the full burden and is only partly adequate.

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 four sentences long, front-loaded with the primary action, and efficiently conveys the mechanism and use cases. It could potentially combine the common use cases sentence with the substitution syntax reference for even greater efficiency.

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 (8 parameters, nested object, no output schema), the description adequately covers the core operation but omits return value details, error handling, and clear guidance on the model/res_id/field_name triple. It is sufficient for basic use but not fully complete.

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?

With only 13% schema description coverage, the description adds meaning for snippet_xpath and substitutions (with examples of use cases) but leaves critical parameters like connection, model, res_id, field_name, lang, and dry_run unexplained. The substitution object structure is not elaborated.

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 that the tool 'Update[s] an existing snippet on a target HTML field' and explains the mechanism (locating via snippet_xpath, applying substitutions). It lists common use cases and distinguishes itself from siblings like odoo_website_add_snippet by noting identical substitution syntax.

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 common use cases (e.g., changing text, swapping images) which imply when to use the tool. However, it does not explicitly contrast with alternatives like odoo_website_remove_snippet or odoo_website_add_snippet, nor does it state when not to use it.

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