Lose Deal

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

Discloses that it sets StatusId to 3, requires LossReasonId, and only works on open deals. Complements annotations (idempotentHint, non-destructive) with operational details.

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, each serving a purpose: purpose, technical detail, prerequisite. Front-loaded with action and entity. No wasted words.

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?

Lacks output schema but given tool simplicity (2 required params), it adequately covers inputs and conditions. Could mention error handling for non-open deals but not necessary.

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%, and the description adds value by explaining the required LossReasonId and referencing the list tool. However, it doesn't add much beyond schema for the id parameter.

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 the action (mark as lost) and the resource (deal in Ploomes CRM). Adds specific StatusId value (3) which differentiates it from sibling tools like win and reopen.

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 prerequisite (only open deals can be lost) and instruction to use ploomes_deals_loss_reasons_list for the required loss reason. Does not explicitly state when not to use, but condition is implicit.

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