index_repo

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

No annotations are provided, so the description bears the full burden of disclosing behavior. It states the tool indexes and persists a file, but does not mention whether it overwrites existing files, requires authentication, or has any side effects. The description is minimally adequate but lacks depth.

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 a single sentence that efficiently conveys the main purpose and outcome without any wasted words. It is front-loaded with the key action and result.

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?

Given that the tool performs a complex operation (indexing a repo into a graph), the description provides the basic function but lacks details about the graph contents, performance implications, or whether the operation is reversible. It is minimally adequate for a simple tool but could be more informative.

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 input schema has one parameter ('root') with a description that matches the schema's own description. Since schema coverage is 100%, the description does not add additional meaning beyond what the schema already provides. Baseline score of 3 is appropriate.

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 the tool's purpose: indexing a TS/React repo into a code graph and persisting it to a specific file. It uses a specific verb ('Index') and resource ('TS/React repo'), and distinguishes from sibling tools which perform different actions like searching or finding references.

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 implies that the tool should be used when one wants to index a repo, but it does not provide explicit guidance on when to use it versus alternatives, nor does it mention prerequisites or exclusions. Given the numerous sibling tools, more context would be helpful.

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