GitHub repo

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds a crucial prerequisite—'needs GITHUB_TOKEN'—which is exactly the kind of auth requirement that annotations do not convey. This is valuable behavioral context beyond the structured metadata.

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 two short phrases and zero filler. It front-loads the core purpose and immediately states the critical prerequisite. Every word earns its place, appropriate for a simple one-parameter tool.

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?

Although the tool is simple and an output schema exists, the complete absence of parameter semantics is a significant gap. The agent needs to know the expected format of 'full_name' to call the tool correctly, and neither the description nor the schema provides it. The auth note helps but does not fill the essential missing input contract.

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?

The schema description coverage is 0%, and the description does not explain the required 'full_name' parameter. The name itself is ambiguous (e.g., does it need an 'owner/repo' format?), and nothing in the description compensates for the missing schema documentation. The agent cannot determine the correct input format from any available source.

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 states the resource ('Repo metadata') and clearly implies a retrieval action, distinguishing it from siblings like github_issue and github_pr which target different GitHub resources. However, it lacks an explicit verb like 'get' or 'fetch', so it is clear but not maximally explicit.

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 use this tool instead of alternatives such as github_issue, github_pr, or git_show. The only hint is the tool name itself, which forces the agent to infer selection criteria rather than being told.

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