refresh

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

No annotations are provided, so the description must disclose behavioral traits. It states the action (refreshes index) and return value, but does not clarify if this is a destructive or safe operation, nor any side effects or prerequisites beyond the indexing step. The description carries the full burden but only partially fulfills it.

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 three sentences, each serving a purpose: the first states the core function, the second gives usage context, and the third describes the return value. It is front-loaded and avoids unnecessary detail.

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 simple zero-parameter tool with an output schema, the description is generally complete: it specifies the trigger (after indexing), the effect (refresh BM25 index), and the return (confirmation with count). It could be slightly more explicit about the side-effect nature, but overall it is sufficient for an agent to use correctly.

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 baseline is 4. The description does not need to explain parameters; the schema is empty and coverage is 100%, aligning with the baseline.

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's function: 'Rafraichit l'index BM25' (refreshes the BM25 index) after indexing new notes. It identifies a specific resource (BM25 index) and implies a distinct purpose from siblings like 'index' and 'reload' by focusing on post-indexing refresh for hybrid search.

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 explicitly tells when to use the tool: 'Appeler apres avoir indexe de nouvelles notes via le menu CLI' (call after indexing new notes). This gives clear contextual usage, though it does not mention alternatives or situations where the tool should not be used.

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