Create Deal

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

Despite annotations indicating write operation (readOnlyHint=false), the description adds behavior beyond annotations: it notes DealNumber is read-only and auto-generated, explains default StageId behavior if omitted, and describes how OtherProperties handles custom fields with multiple data types. No contradictions 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?

The description is front-loaded with the main purpose and then systematically covers each parameter. It is relatively long but every sentence provides necessary guidance. Could be slightly more concise, but structure is logical.

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 complexity (9 parameters, many requiring external lookups) and no output schema, the description is complete: it covers required field, optional fields, defaults, and where to find valid IDs for reference data. No gaps remain for an agent to invoke the tool correctly.

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 for all 9 parameters, giving a baseline of 3. The description adds significant value by clarifying the distinct roles of ContactId vs PersonId, explaining StageId pipeline dependency, and detailing OtherProperties value types.

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 'Create a new deal (opportunity) in Ploomes CRM' with a specific verb ('Create') and resource ('deal'). It distinguishes from other deal-related tools (like ploomes_deals_update, ploomes_deals_list) and other entity creation tools by focusing on deals.

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 clear context for when to use the tool (to create a deal) and advises on prerequisite lookups (pipelines, stages, currencies, etc.). However, it does not explicitly state when not to use it or contrast with alternatives like ploomes_contacts_create or ploomes_orders_create.

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