Create Quote

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

Adds context beyond annotations: notes QuoteNumber is auto-generated (read-only). Annotations already indicate readOnlyHint=false and destructiveHint=false, but description does not mention auth, rate limits, or side effects.

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?

Two sentences, front-loaded with core purpose, no redundant or irrelevant information. Every word adds value.

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?

Covers creation with DealId requirement and QuoteNumber note, but lacks details about return value, error handling, prerequisite (deal existence), or custom field usage (OtherProperties) beyond schema. Without output schema, more context needed.

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%, so baseline is 3. Description adds no extra detail beyond what schema provides for parameters; only mentions DealId required and QuoteNumber auto-generated (not a param).

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 action (create), object (quote/proposal), and system (Ploomes CRM). It distinguishes from sibling quote tools (delete, get, list, update) by specifying creation.

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?

Mentions DealId is required, which is explicit usage guidance, but does not provide when-to-use vs alternatives or when not to use. No comparison to other quote tools.

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