gh_auth_login

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

With no annotations, the description carries full behavioral burden, but it only states 'Authenticate with GitHub CLI.' It does not disclose side effects, such as opening a web browser, storing credentials, or requiring interactive input, nor does it describe the output or potential errors.

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 a single concise sentence with no filler words. However, it is so short that it sacrifices valuable context, yet for what it includes, it is well-structured and efficient.

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?

This tool has side effects (authentication) and is likely a prerequisite for many sibling GitHub tools, but the description provides no context about when to use it, what happens after authentication, or how it integrates with other tools. The output is not described either.

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%. The description does not explain the 'method' parameter or its enum values ('web' vs 'token'), leaving the agent to guess the implications of each choice. No additional meaning is provided beyond the raw schema.

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 clearly states the action (authenticate) and the resource (GitHub CLI). It is distinct from the sibling gh_auth_status, which checks authentication status, though it does not explicitly differentiate itself.

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?

No guidance is given on when to use this tool versus alternatives, such as checking gh_auth_status first or using token-based vs web-based authentication. There is no mention of prerequisites or post-authentication steps.

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