repo.refresh_index

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

The description discloses the core behavior (incremental refresh vs. full rebuild with force=true) but does not elaborate on potential side effects like resource usage or locking. Given no annotations, it covers the essential aspects for a simple index refresh tool.

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 extremely concise, consisting of two short sentences. The first sentence states the purpose, the second provides usage conditions and parameter guidance. No unnecessary 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?

Given the simplicity of the tool (one parameter, no output schema), the description fully covers what an agent needs to know: purpose, when to use, how to force a rebuild. It is 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 single parameter force has a schema description, and the tool description adds further context by explaining when to use force=true. With 100% schema coverage, the description provides meaningful additional guidance beyond the schema.

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 verb 'Build or incrementally refresh' and the resource 'BM25 search index'. It differentiates from siblings by noting that this tool should be used before searching or bundling, implying it is a prerequisite for repo.search and repo.build_context_bundle.

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?

Explicitly states when to use the tool: 'if the index is stale or not yet built'. It also provides guidance on the force parameter for full rebuilds. While it does not explicitly list when not to use it, the conditions are clear.

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