test_github_connection

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

With no annotations, the description carries the full behavioral burden. It usefully discloses that credentials are not exposed, which is a security-relevant trait, but it does not specify authentication prerequisites, failure behavior, side effects, or rate limits.

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?

A single sentence with zero waste, front-loading the core purpose and including the notable credential-safety behavior without unnecessary detail.

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 diagnostic with no output schema and no annotations, the description covers purpose and a key security trait. It would be stronger if it mentioned authentication prerequisites or expected failure modes, but it is largely complete for the tool's complexity.

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 100%, so both owner and repo are already fully documented. The description adds only the idea of a 'specific repository' and does not elaborate on parameter meaning beyond what the schema provides.

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 a specific verb ('Tests connectivity') and resource ('GitHub' and 'a specific repository'), and it distinguishes itself from the sibling sync_github_repository by clearly being a diagnostic rather than a data transfer operation.

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?

Usage is implied: validate GitHub connectivity and repository access before other operations or when troubleshooting. However, it does not explicitly state when to use this tool versus the health_check sibling or when not to use it, so guidance remains inferential.

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