Update opportunity

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

Adds key behavior beyond annotations: 'Only provided fields are changed' clarifies partial-update semantics. Annotations indicate idempotent and non-read-only, but the description supplies the important nuance that unspecified fields remain untouched.

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 concise sentences, front-loaded with the action and resource, with the partial-update rule immediately after. 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?

Adequate for basic updates but missing mention of pipelineId and any return value (no output schema). Does not address error conditions or prerequisites beyond required opportunityId, which is schema-covered. Slightly incomplete for a 7-parameter mutation tool with no output schema.

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?

Description maps common concepts (stage, status, value, name, owner) to schema parameters, covering most fields. However, it omits pipelineId (changing pipeline) despite schema coverage being only 14%. Still compensates well for low schema description coverage.

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 tool's purpose: updating an opportunity, listing specific mutable aspects (stage, status, value, name, owner). Distinguishes from siblings like create_opportunity and get_opportunity.

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 notes that only provided fields are changed, indicating a partial-update use case. Does not explicitly mention when to prefer this over create or get, but the update context is clear.

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