list_attachments

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

Discloses key behavior: returns metadata only, never binary data, and src field is usable as URL. With no annotations, this is sufficient for a read-only search tool. Could add more about pagination or rate limits.

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?

Three sentences with no wasted words. Information is front-loaded: first sentence gives purpose, second clarifies behavior, third provides usage guidance.

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?

No output schema, so description should detail return format—it only mentions metadata and src. Does not explain relationship to sibling tools like search_records. Adequate but incomplete for a search tool.

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?

Description does not explain any of the 4 parameters (name, limit, res_id, res_model). Schema coverage is 0%, so description should compensate but fails to do so. Only implies model and ID filtering indirectly.

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?

Clearly states it searches ir.attachment records for any model, specifies it returns metadata only (never binary), and distinguishes from upload/download tools. The use case is explicitly mentioned.

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?

Explicitly says to use for finding existing files before uploading duplicates. Does not explicitly state when not to use, but the behavior distinction is clear. Could mention alternatives like search_records for other models.

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