reindex_documents

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

Describes mutating behavior, CPU/IO intensity with example times, detailed effects of each parameter (smart reindex vs. nuclear rebuild), and return value. No annotations exist, but description fully covers behavioral traits.

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?

Well-structured with headers, but slightly verbose; all sentences are valuable, making it efficient overall.

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?

Covers purpose, usage guidelines, parameter behavior, performance, and return value comprehensively, with no obvious gaps given the tool's simplicity and presence of output schema.

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?

Despite 0% schema coverage, the description fully explains both parameters with concrete meanings, defaults, and usage contexts, adding significant value 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?

Clearly states 'Index or reindex all documents,' distinguishing it from siblings that auto-index (add_document, update_document, add_from_url) and from purely informational tools like get_index_stats.

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 that normal workflow does not require this tool due to auto-indexing in other tools, and provides specific use cases for force and full_rebuild parameters.

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