index_workspace

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

Basic behavior is described: triggers re-scan and rebuilds index. However, no details on whether the operation is synchronous/asynchronous, performance impact, or what happens to existing data. With no annotations, more disclosure would be helpful.

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?

Single sentence, 17 words, front-loads the verb 'Triggers' and clearly states the action and outcome. No wasted words.

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 administrative tool, the description covers the purpose and effect. Could mention that re-indexing is needed for accurate results from sibling tools, but it is sufficient as is.

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?

Tool has zero parameters, so baseline is 4. Description does not need to add parameter info, and it correctly describes the action without parameter details.

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?

Description clearly states the tool triggers a re-scan of the workspace to rebuild the symbol and call graph index. It distinguishes itself from siblings like find_definitions or get_call_graph by focusing on index rebuilding.

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 explicit guidance on when to use this tool versus alternatives. The description does not mention prerequisites, scenarios that require re-indexing, or when other tools like find_definitions might be sufficient without re-indexing.

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