Win Deal

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

Annotations indicate idempotent, non-destructive mutation. Description adds that it sends an empty body to POST endpoint, sets StatusId to 2, and lists prerequisites. No contradiction with annotations.

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, front-loaded with action. Each sentence adds value: what it does, status mapping, prerequisites, endpoint info. 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?

For a simple mutation with one param and no output schema, description covers all needed details: action, prerequisites, endpoint, and checks. References sibling tool for pipeline verification.

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 covers id with description, coverage 100%. Description adds no extra param info beyond endpoint usage. Baseline 3 is appropriate as schema does the heavy lifting.

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?

Description clearly states the tool marks a deal as won, sets StatusId to 2, and includes prerequisites. It distinguishes from siblings like ploomes_deals_lose and ploomes_deals_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?

Explicitly says when to use (win a deal) and specifies prerequisites (pipeline MayWinDeals=true, deal StatusId=1). References sibling tool ploomes_pipelines_list for checking. Could be more explicit about when not to use, but conditions imply alternatives.

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