refresh_index

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

With no annotations provided, the description carries the full burden, and it does well: it discloses that the operation is conditional (ETag check makes it a no-op), that force=True bypasses the check and rebuilds unconditionally, and that the result is a JSON status. It could go further by noting operational costs or side effects of a forced rebuild, but the core behavioral traits are transparent.

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 and front-loaded: the opening sentence states the action, followed by behavior, parameter, and return-value notes. The only minor redundancy is that force semantics are stated twice ('Use force=True...' and 'Args: force...'), which is a standard docstring pattern and not wasteful.

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 maintenance tool with an output schema, this is nearly complete: default vs. forced behavior, parameter semantics, and return shape are all covered. Minor missing context includes operational caveats (e.g., cost/duration of a forced rebuild, whether the index is briefly unavailable), but nothing required to invoke the tool correctly is absent.

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 0%, so the description must fully compensate, and it does: it explains that force bypasses the ETag check and re-downloads/re-indexes everything, which goes beyond the schema's bare boolean type and default. The agent gets complete semantic understanding of the only parameter.

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 uses a specific verb ('Re-harvest') plus a clear resource ('the CKAN-meta archive to update the mod index'). This clearly distinguishes it from the sibling read-oriented tools (search, get, list, status), so an agent can tell what this tool does without opening the 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?

The description explains the default behavior (no-op via ETag check) and when to use force=True, giving the agent conditional invocation guidance. However, it does not explicitly name alternatives or state when not to use this tool versus the sibling tools, so exclusion criteria are only implied by sibling names.

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