index_project

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

No annotations are provided, so the description must disclose behavioral traits. It only states 'Index all documents' without explaining side effects (e.g., potential long duration, mutation of state, idempotency, or required permissions). The short description leaves significant behavioral ambiguity.

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 with zero waste. It is front-loaded and efficient, earning its length.

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 of an indexing operation (potentially expensive, irreversible), the description is incomplete. It lacks details about return values, error conditions, or operational impact. No output schema exists, and annotations are absent, so the description fails to provide sufficient context for safe agent invocation.

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% (the single parameter is well-described in the schema). The tool description adds no additional meaning beyond the schema. Baseline 3 is appropriate since the description does not enhance parameter understanding.

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 indexes all documents in a project, using a specific verb and resource. It distinguishes from sibling tools like 'index_file' (single file) and 'search' (querying). However, it lacks specifics on what indexing entails (e.g., building a search index).

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 guidance on when to use this tool vs alternatives, such as 'index_file' for selective indexing. The description does not mention prerequisites, limitations, or when not to use it. The parameter hint about querying a different project is the only context, but it is directive, not usage guidance.

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