Index a GitHub repository

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

Annotations declare readOnlyHint=false, idempotentHint=false, and destructiveHint=false, so the write nature is partly covered structurally. The description adds real context by stating that fetched data is tagged as 'verified' evidence because it is directly observed — a behavioral trait not in the annotations. It does not, however, explain the idempotentHint=false implication (what happens on re-indexing the same repo) or auth requirements beyond 'token-accessible'.

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 tight sentences that front-load the operation and its scope, then state the evidence-classification consequence. No filler; every sentence carries distinct information.

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?

There is no output schema, so the description should ideally describe what the call returns or confirms. For a state-mutating index operation with idempotentHint=false and no output schema, the absence of return/re-run behavior leaves a real gap, though the tool's core effect (storing verified evidence) is covered.

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 60%; commitLimit and pullRequestLimit have no descriptions. The description's mention of 'recent commits' and 'pull requests' hints that those parameters bound what is retrieved, but it adds no syntax, defaults, or meaning for candidateId and projectName beyond the schema. Baseline 3 is appropriate given partial coverage and only marginal added meaning.

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?

States a specific verb ('Indexes') and resource ('GitHub repository') and enumerates what is pulled: commits, PRs, README/architecture docs, and dependency manifests. This is clearly distinguishable from sibling tools like analyse_job_description or generate_star_answer, though it doesn't explicitly differentiate itself from careerproof_add_project_evidence, which also writes evidence.

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 the operation by name but gives no explicit when-to-use/when-not guidance and names no alternatives. Given the sibling set includes careerproof_add_project_evidence, an agent has no stated rule for choosing between manual evidence entry and automated repo indexing.

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