refresh_cache

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

No annotations are provided, but the description discloses behavioral traits: incremental mode only re-parses changes, full mode discards and rebuilds cache. It also describes the return values. However, it does not mention potential side effects beyond cache modification.

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 succinct and well-structured: a one-line summary followed by explanations of each mode and the return format. The bilingual text adds redundancy but remains clear and 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?

Given the tool's simplicity, lack of output schema, and no annotations, the description covers the purpose, behavior, and return values adequately. It lacks examples or error conditions but is reasonably complete for its complexity.

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 has 2 parameters with 0% description coverage. The description adds meaning for the 'full' parameter (explaining its default and the two modes), but does not explain 'repo_path' beyond its name. This partially compensates for the schema gap but not fully.

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 tool refreshes the cache, with two distinct modes: incremental (default) and full rebuild (recovery). It specifies the operation on a cache resource and, given the context of sibling tools (get_repo_map, hello), it is clearly differentiated from them.

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 when to use full=True (recovery) and full=False (default, incremental). It provides clear guidance on the two modes, though it does not explicitly state prerequisites or when not to use the tool.

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