refresh_catalog

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

With no annotations supplied, the description carries the full burden and does well: it discloses the write target (data/catalog.parquet), that no credentials are required, that the .env app token only raises the anonymous rate limit, and the return value. It stops short of saying whether the refresh replaces or merges existing cache entries, which matters for a cache-overwriting operation.

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?

Front-loaded with the action and source, followed by payload contents, trigger conditions, constraints, and return value in that order. Dense but every sentence carries information; the parenthetical field list is the only mildly expendable element.

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 zero-parameter cache-refresh tool with an output schema already documenting the return shape, the description covers source, destination, scale (~280 datasets), prerequisites, rate-limit caveat, and invocation timing. Nothing an agent needs in order to call it correctly is missing.

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 tool takes zero parameters, so there is nothing for the description to disambiguate; baseline 4 applies. The description correctly spends no words on argument syntax.

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?

States a specific verb and resource ('Refresh the local catalog cache') and names the exact upstream source (Socrata Discovery API), so the agent can distinguish it from read-only siblings like search_datasets or list_cached_datasets without opening a schema.

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?

Gives two explicit trigger conditions — 'Run first if search_datasets reports a missing cache' and 'when the portal may have new datasets' — and routes the agent to the sibling that signals the need. This is the when-to-use guidance most definitions omit.

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