scan_addons_source

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

Annotations already indicate readOnlyHint, idempotentHint, and non-destructive. The description adds the behavioral trait of avoiding code import, which is valuable context beyond annotations. Additional details about scanning behavior could improve transparency, but the description supplements annotations well.

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 a single, well-structured sentence that front-loads the core action and constraint. Every word earns its place with no redundancy.

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 low complexity (3 optional parameters, output schema exists, annotations cover safety), the description is adequate but lacks details on return values or parameter constraints. It provides the essential purpose but could be more helpful with usage examples or output description.

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 description does not explain any of the three parameters (max_files, addons_paths, max_file_bytes). Schema description coverage is 0%, so the description bears the responsibility but fails to clarify their purpose or usage. Parameter names are self-explanatory to some extent, but the description adds no semantics.

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 tool scans local Odoo addon source, with the key constraint 'without importing addon code', which distinguishes it from import operations. The verb 'scan' and resource 'local Odoo addon source' are specific.

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 implied usage by stating it scans without importing, but does not explicitly state when to use this tool versus alternatives. It lacks guidance on when not to use it or how it compares to sibling tools like diagnose_odoo_call or read_record.

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