refresh_docs

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

The description adds useful context beyond annotations by specifying what gets refreshed and that it returns a summary of changes. Annotations already cover idempotency and destructiveness, and the description does not contradict them. It does not mention rate limits or failure modes, but does enough with the annotation baseline.

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 a single sentence that front-loads the action and specifies both the affected resources and the return value. It contains no filler or redundant information.

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 no-argument tool with an output schema, the description sufficiently states what it does and what it returns. There are no additional parameters or prerequisites to document, so the description is complete for 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 tool has zero parameters, so there are no parameter semantics to explain. The description is not required to add anything, and an empty schema needs no compensation. A baseline of 4 is appropriate.

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 a specific verb ('Force an immediate refresh') and resource ('documentation, Docker stacks, and vault notes from Gitea repositories'). It distinguishes itself from sibling tools like search_docs and refresh_registries by naming the exact content being refreshed.

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 implies the tool is for forcing an immediate refresh when up-to-date data is needed, but it does not explicitly mention when not to use it or provide alternatives like refresh_registries. Usage context is present but lacks exclusions or comparisons with sibling tools.

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