rebuild_index

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

No annotations are provided, so the description carries full burden. It does not disclose that re-indexing is likely a heavy, potentially disruptive operation (e.g., downtime, performance impact). The wording 'change the workspace directory' is confusing and incomplete.

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?

Two sentences, front-loaded with the main action. No redundant words, but the second sentence is unclear. Acceptable conciseness for a simple tool.

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?

Despite having an output schema, the description does not mention return values or behavior during/after rebuild. It lacks critical context: what 'complete re-indexing' entails, whether it blocks queries, and that 'path' specifies which directory to re-index (not to change the workspace). Incomplete for safe usage.

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 single 'path' parameter has no schema description (0% coverage). The description adds 'Provide a path to change the workspace directory', which gives some context but is ambiguous and does not specify format, constraints, or whether it's required. Moderately helpful beyond the empty 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?

The description states the action 'trigger a complete re-indexing' and mentions a path parameter. It is clear that the tool rebuilds the index, but the phrase 'change the workspace directory' is vague and may mislead about the path's role. Distinction from sibling tools (e.g., get_index_status) is evident.

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?

No guidance on when to use this tool vs alternatives, prerequisites, or consequences. The description simply states what it does without contextual advice.

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