reindex

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

With no annotations provided, description adds context on return format (ok flag + durationMs) and scoping. But it does not disclose potential blocking, locking, or concurrency implications of rebuilding indexes.

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?

Single sentence that efficiently conveys purpose, version, behavioral details, parameter usage, and return value. No wasted words, front-loaded with key action.

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 no output schema, description adequately specifies return format. Lacks details on potential side effects or prerequisites, but for a maintenance operation with simple boolean params, it is mostly complete.

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?

Schema already describes both boolean parameters with defaults (coverage 100%). Description adds value by explaining how to 'scope' the rebuild by passing false, which is not apparent from schema alone.

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?

Description clearly states verb 'Rebuild' and resource 'search-side indexes (TF-IDF/BM25 ranked + spell-checker vocabulary)'. It distinguishes from sibling 'spell_rebuild_vocabulary' by offering a combined reindex operation with optional scoping.

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?

Description implies usage when indexes may have drifted and explains how to scope using parameters. However, it does not explicitly exclude calling separate tools or provide when-not-to-use guidance.

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