List Deals

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

Annotations already mark readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds OData capabilities, pagination (top/skip up to 300), expand options, and note that StatusId mapping may vary (suggesting confirmation). No contradiction.

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?

Compact yet information-dense. Front-loaded with purpose, uses clear sentence structure and bullet-like listing of expand options. Every sentence contributes actionable 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, but the description explains filtering, sorting, field selection, pagination, and expand. References to other tools for valid IDs fill missing context. Adequately complete for a list operation.

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 coverage is 100% with descriptions, but the description adds value: provides common filter examples, lists available $expand options, and explains pagination parameters. This goes beyond schema definitions.

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 searches and lists deals (opportunities) in Ploomes CRM, using specific verbs and resource. It distinguishes from siblings like ploomes_deals_get (single) and other list tools.

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?

Provides explicit usage context: OData filtering, pagination, and common filters. References sibling tools for valid ID values (ploomes_deals_status_list, ploomes_stages_list, ploomes_users_list). Lacks explicit when-not-to-use (e.g., for single deal use get), but implied by tool name and sibling set.

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