reindex_documents

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

Describes that tool runs in background and returns immediately. Explains that force does smart reindex, full_rebuild deletes all vectors. Missing details on error handling or auth needs, but disclosures are solid given no annotations.

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 separate sections for Args, Returns, Usage. Every sentence adds value. Front-loaded with purpose and background. No redundant 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 2 optional boolean params and no output schema, the description explains return format and polling procedure. Adequately covers usage context, including when NOT to use.

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 has 0% coverage but description fully explains each parameter including their purpose and when to use them. Compensates entirely for lack of schema descriptions.

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 it indexes/reindexes all documents. Distinguishes from sibling tools like add_document which auto-index. Specifies the two parameters and their effects.

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 says when to use force=True (after manual file edits) and full_rebuild=True (model upgrade or corruption). Notes that normal workflow does not require this tool, and directs to get_reindex_status for monitoring.

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