index_repository

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

Describes the effect of indexing (knowledge graph insertion) and special mode (specific edges). No annotations provided, so description carries full burden. Lacks details on destructive behavior, idempotency, or error conditions.

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 efficient sentences with front-loaded main action. Every sentence adds value with no redundancy. Special mode details are concise yet informative.

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 the complexity (4 params, enum modes, no output schema), the description covers key aspects: modes, prerequisites for cross-repo mode, and persistence benefit. Lacks return value detail but that's acceptable per rules.

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?

Schema coverage is 100%, but description adds significant value: elaborates on mode semantics, provides usage tips for target_projects, and explains persistence artifact purpose. Greatly enhances meaning beyond the 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?

Clear action ('Index a repository') with specific resource and special mode explanation. Distinguishes from siblings like delete_project, query_graph, etc., as indexing is a unique operation.

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?

Provides guidance for the special mode (requires target_projects, ensures fresh indexes) and mentions persistence for team sharing. Does not explicitly list when to use other modes vs alternatives, but parameter descriptions cover mode selection.

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