homestead_index_build

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

With no annotations, the description carries the full burden of behavioral disclosure. It reveals the asynchronous nature by returning a job id and referencing polling, but it does not disclose potential side effects (e.g., overwriting the index), prerequisites beyond downloaded documents, permissions, or error conditions. This is a significant gap for an operation that rebuilds a search index.

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?

A single, front-loaded sentence that states the action, source, and result. No wasted words, and the key information (job id and polling) is included immediately.

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?

For a zero-parameter tool with no output schema, it adequately covers purpose, return value, and next step (poll homestead_job). It could add a note about the operation being long-running or destructive, but the job id implies asynchrony, and the tool's simplicity makes it reasonably complete.

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 tool has zero parameters and an empty input schema, so per the baseline, 4 is appropriate. The description adds context about what the rebuild operates on (documents already downloaded) but does not need to explain parameters since none exist.

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 a specific verb and resource: 'Rebuild the search index from the documents already downloaded.' It clearly distinguishes this from siblings like homestead_search (which searches) and homestead_add (which adds documents), and it names the return value (job id).

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 context 'from the documents already downloaded' implies when it should be used, but there is no explicit guidance on when not to use it or alternatives. It does mention polling homestead_job as a follow-up, but that is a next step, not a usage condition.

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