refresh_deals

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

With no annotations, the description carries the transparency burden. It discloses the time cost (10-20 seconds) and the forced rebuild nature, which implies a mutating operation. However, it does not mention potential side effects, authorization needs, or impact on concurrent operations.

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 compact—three sentences plus a one-line parameter note. Every sentence adds value, with the main purpose and timing front-loaded.

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 single-parameter tool with an output schema, the description covers purpose, timing, usage guidance, and parameter semantics. It lacks only deeper runtime implications such as whether the rebuild blocks other operations or requires specific credentials, but these are not essential for basic invocation.

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 input schema provides only a property name and default, with 0% description coverage. The description's Args section compensates by specifying '5-digit US ZIP code' and noting it is 'Optional if GROCERY_ZIP is set', giving format and conditional requirement.

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 'Force a rebuild of the deal index from Flipp' with a specific verb and resource, distinguishing it from siblings like search_deals which query the index.

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?

'Only needed mid-week; the index otherwise refreshes itself' provides explicit when-to-use and when-not-to-use guidance. It implies the alternative of waiting for automatic refresh, though doesn't name a specific sibling tool.

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