index_project

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains the incremental reindex option and the path requirement, but does not state whether indexing is destructive, whether it replaces or merges an existing index, whether it requires authentication or network access, or how long-running the operation might be. For a mutating tool, these are notable gaps.

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 concise and well structured: a one-sentence purpose followed by bulleted argument explanations. Every sentence adds value, and the purpose is front-loaded. No redundant or filler language is present.

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?

The tool has an output schema, so describing return values is unnecessary. However, the description omits behavioral details that would help an agent call the tool correctly, such as whether the index is rebuilt from scratch or merged, whether existing data is deleted, and when a full reindex would be needed instead of incremental. It also gives no usage guidance relative to the sibling tools. These gaps keep it from being fully 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?

Schema description coverage is 0%, so the description must compensate, and it does completely. It explains that path must be an absolute project root and must contain .md/.mdx files, and defines incremental as 'only reindex changed files' with its default. This adds essential meaning beyond the bare string and boolean types in 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?

The description clearly states a specific action ('Index or reindex a project's content and code') with a concrete resource and a modifier that distinguishes it from the sibling tools (e.g., project_info, search). It lacks explicit sibling differentiation, but the verb and resource make the purpose unambiguous.

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 when to use this tool—when you need to index/reindex a project—but provides no explicit context, exclusions, or comparison to alternatives like fetch_and_index. The path precondition (must contain .md/.mdx files) is the only usage hint, and no guidance on choosing between incremental and full reindex beyond the default is given.

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