Add Note to RD Station CRM Deal

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

Annotations already declare readOnlyHint=false, openWorldHint=true, destructiveHint=false, so the mutation nature is largely established. The description adds author-resolution context and that the note goes to the deal timeline, but doesn't clarify whether the operation is additive/non-destructive beyond what annotations state, nor what happens on partial failure. It adds a moderate amount beyond structured data without contradiction.

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 tight and efficient — roughly three sentences covering purpose, author options, and a concrete usage example. Every sentence earns its place; no filler or redundancy.

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 4-parameter tool with 100% schema coverage and explicit annotations, the description adds the key missing context: author resolution semantics and a practical use-case example. It does not explain return values, but with no output schema and a simple mutate operation, that's a minor gap. Fairly complete for the tool's complexity.

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 description coverage is 100%, with each param (text, user, deal_id, user_id) documented in the schema itself. The description adds the author-resolution logic (priority order, single-user omission), which is genuinely non-obvious value. However, most parameter meaning is already carried by the schema, so the baseline-3 applies.

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 specifies the exact verb ('Add a text note/annotation to a deal's timeline') and resource (deal timeline). It is clearly distinct from sibling tools like list/create/update/close deal or task tools — none of which describe adding timeline notes. The scope is precise and immediately actionable.

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 explicitly states author resolution rules (by user_id, by email/name in 'user', or omitted when single-user account) and provides an explicit 'Use when:' example with a concrete phrase. This gives clear guidance on when to invoke and how author parameters should be chosen, exceeding minimal expectations.

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