repo_overview

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

With no annotations, the description carries the full burden. It implies a read-only, aggregate operation and lists the payload fields, which gives the agent a reasonable behavioral picture. It says nothing about auth requirements, rate limits, or cost of the call, and the field list duplicates the output schema rather than adding operational context.

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 short sentences, purpose front-loaded, no filler. The metric enumeration is somewhat redundant with the output schema, but it is scannable and earns most of its space.

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 simple two-parameter read tool with an output schema present, the return-value explanation is unnecessary and the description could instead cover parameter format and sibling routing. It is adequate to call the tool but leaves the overlap with adjacent repo tools unresolved.

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% and the description never mentions the owner or repo parameters. It does not clarify the expected format (bare owner and repo names vs. an 'owner/repo' slug), case sensitivity, or whether the repository must be public. The 2-parameter baseline of 4 is not met because the description adds zero parameter 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 concrete verb+resource ('High-level overview of a GitHub repository') and enumerates the returned metrics, so the agent knows exactly what class of information this tool surfaces. However, it never distinguishes itself from the sibling tools, several of which overlap (issue_backlog covers open issues, commit_activity covers push recency), leaving the agent to guess which summary is authoritative.

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?

There is no guidance on when to call this versus commit_activity, issue_backlog, contributor_stats, recent_releases, or stale_pull_requests. Usage is only implied by the word 'overview'; no prerequisites, no 'call this first' framing, no exclusions.

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