Rebuild Semantic Index

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

Annotations already establish that this is a write operation and idempotent, but the description adds useful context: it explains the automatic sync behavior for new documents, the one-time rebuild requirement for existing ones, and the Pro-only restriction. It does not mention operational details like confirmation or runtime, but the annotation coverage lowers the bar.

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?

The description is front-loaded with the main purpose and is concise, using only three short sentences. Each sentence earns its place by explaining the what, when, and background context without 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?

The description thoroughly covers the purpose and timing of the rebuild, and with an output schema present return values are not needed. However, it omits any guidance on the 'confirm' parameter, which defaults to false and could cause an invocation to be a no-op or fail if not set. This is a crucial gap for an otherwise simple tool.

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 only parameter 'confirm' is not mentioned in the description, and the schema has no description for it. With schema coverage at 0%, the description should compensate, but it leaves the agent without guidance on whether confirm must be true for the rebuild to proceed.

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 a specific verb ('Rebuild') and resource ('LanceDB semantic search index from all stored documents'), which fully defines the tool's purpose. It is distinct from sibling search and document management tools, and the 'Pro only' note adds a unique constraint.

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?

The description gives explicit when-to-use scenarios: after installing Pro deps or after restoring from backup. It also provides a when-not-to-use cue by noting that new documents are auto-synced, so the rebuild is only needed for existing documents.

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