Enable Price Alert

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

Annotations indicate idempotentHint=true, and the description confirms the behavior by stating the return object on success. It adds the specific return format {alert_id, enabled: true}. No contradictions.

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 with no wasted words. Each sentence provides essential information: the action and the tool for finding the ID.

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 enable operation with one parameter and no output schema, the description explains the return format and references the necessary sibling tool. It is complete and self-contained.

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?

The schema describes alert_id as 'Alert indicator id' with type string. The description adds that the ID is numeric and suggests using alert_list to obtain it, which adds meaning beyond the schema.

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 the action 'Enable a price alert' with the specific resource 'by alert_id'. It distinguishes itself from siblings like alert_disable by focusing on enabling, and references alert_list for finding the ID.

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 advises to 'Use alert_list to find the numeric alert_id', providing helpful context on obtaining the required parameter. However, it does not explicitly state when to use this tool versus alternatives like alert_disable or alert_add, though the name and purpose are self-explanatory.

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