telys_index_repo

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

Goes well beyond annotations: discloses .gitignore handling, common build/dep dir skipping, binary/symlink refusal, incremental fingerprinting with re-embedding and tombstones, fast no-op when nothing changed, force rebuild, and exact failure conditions. Annotations are all consistent with this behavior.

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?

Dense but efficient: core behavior is front-loaded, followed by incremental semantics, then parameter defaults, then failure modes. Every sentence adds information, though the single long paragraph could be lightly structured with separators.

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 complex, state-mutating indexing tool with nine optional parameters and no output schema, the description covers scope, edge cases, failure conditions, and idempotent behavior. Nothing an agent needs to invoke it safely is missing.

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?

With only 22% schema coverage, the description carries the burden and largely succeeds: it lists all nine parameters with defaults, explains mode values, gives the '0 = unlimited' convention, and defines force. It lacks detail on the exact semantics of max_file_bytes/max_files, but the names plus defaults give enough orientation.

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 opens with a specific multi-step action: walk a repo directory, chunk text files, and ingest chunks into a collection for telys_repo_search. This clearly distinguishes it from read/search siblings like telys_repo_search and telys_search, and from single-document tools like telys_add/telys_upsert.

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 makes the purpose explicit (preparing a repo for telys_repo_search) and gives context-dependent behavior (git checkout vs non-git, skip dirs, refusals). It does not explicitly name alternative tools to use instead, but the sibling separation is clear enough that an agent can infer when indexing is needed.

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