clear_index

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

With no annotations provided, the description carries the full burden. It clearly discloses that all files and chunks are removed, and the index becomes empty, with a path to recovery via reindex. This is sufficient for a destructive operation, though it doesn't mention irreversibility explicitly.

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 short sentences, front-loaded with the action, followed by a detailed explanation and a statement of consequences. There is no wasted text, and the structure is clear and efficient.

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 parameterless tool, the description covers what it does, the scope (all indexed data), and the recovery mechanism (reindex). It doesn't discuss side effects on other subsystems, but given the tool's narrow purpose, this is complete enough.

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 the schema is fully covered (100%). The description adds no parameter-specific detail, but none is needed. Baseline of 4 for zero params 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 the tool's purpose: 'Clear all indexed data' and 'Removes all files and chunks from the index.' This is a specific verb+resource combination that distinguishes it from siblings like reindex_file or cancel_indexing, which operate on individual items or pending operations.

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 usage by noting the index will be empty until reindex is called, but it does not explicitly state when to use this tool versus alternatives like exclude_paths or cancel_indexing. There is no direct comparison or exclusion guidance.

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