github_connect

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

No annotations are provided, so the description carries full burden. It discloses credential caching behavior ('automatically cached for future reconnection'), which is useful. However, it doesn't mention security considerations of handling tokens, potential errors, or idempotency of reconnection.

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?

Well-structured with a brief prose section plus an Args list. Information is front-loaded with the core purpose first. Each parameter gets a short, useful annotation. No fluff or redundancy.

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?

Connection/session tools benefit from documenting caching, default values, and alternative use cases (GitHub Enterprise). The description covers these. Given a rich output schema exists and this is a connection bootstrap tool, the coverage is reasonable, though error behaviors and reconnection semantics could be more explicit.

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%, so the description must compensate for all 5 parameters. The description does explain each parameter inline (token generation URL, api_url for enterprise, protocol options, timeout meaning, session_name naming). However, it omits the 'default: ssh' value for protocol unlike the schema, and doesn't add format/validation details beyond what the schema provides. The token generation URL is genuinely helpful added value.

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 'Connect to GitHub API with a Personal Access Token' using a specific verb+resource. It distinguishes from siblings like github_save_credentials by indicating it performs the connection itself, though the distinction from github_save_credentials could be sharper.

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 mentions 'Credentials are automatically cached for future reconnection', clarifying when to use this tool vs re-using cached connections. However, it doesn't explicitly contrast with github_save_credentials or say when NOT to use it (e.g., if already connected).

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