odoo_attachment_upload

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

No annotations are provided, so the description must convey behavioral traits. It states the operation is a file upload (creating an attachment) and returns the ID, but it omits details on permissions, file size limits, or side effects. This is adequate but not thorough, scoring a 3.

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, efficiently conveying the purpose, return value, and integration with another tool. It is front-loaded and every word adds value, meeting the highest standard for conciseness.

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 has 6 parameters, no output schema, and no annotations, the description covers the core purpose and return value. It lacks details on error handling or constraints but is reasonably complete for a file upload tool, scoring a 4.

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 83%, high, so baseline is 3. The description adds no information about parameters beyond what the schema already provides (model, res_id, etc.). It focuses on output usage instead, so no extra semantic value for parameters.

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 the verb 'Upload', the resource 'file as an ir.attachment', and the target 'on an Odoo record'. It also specifies the return value (attachment ID) and its usage with odoo_message_post, distinguishing it from the sibling odoo_attachment_download.

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 context on using the tool to upload files for later use with odoo_message_post, but does not explicitly state when not to use it or contrast with alternative methods. It gives a clear usage scenario, earning a 4.

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