reindex

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

Describes incremental behavior, auto-index enablement, and force deletion. No annotations exist, so description covers key behaviors well, though missing rate limits or auth.

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?

Three sentences, front-loaded with main purpose, each sentence adds new information without redundancy or fluff.

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 use cases and parameter behavior but misses return value description and potential side effects like locking, given no 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?

Schema coverage is 100% with moderate descriptions. The tool description adds contextual usage (e.g., 'after switching EMBEDDING_PROVIDER') but mostly reiterates schema info.

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 'Force incremental reindex of the project codebase' with a specific verb and resource, and it distinguishes from sibling 'reindex_file' by focusing on the entire codebase.

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?

Provides explicit use cases: initial index, after switching providers with force. Lacks explicit 'when not to use' but implies normal updates are automatic.

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