connect_github_repo

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

With no annotations, the description carries the full disclosure burden and falls well short. It does not say that this is a mutating operation, whether it fails or overwrites when the repository name already exists, what authentication is required, or what side effects occur on the cPanel filesystem beyond the vague 'configure deployment paths'.

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 front-loaded sentence with the main action first and the optional step second, wasting no words. Its brevity is efficient but also the source of the coverage gaps, not a model of completeness.

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 five-parameter mutating tool with three required parameters, no annotations and no output schema, one sentence is not enough. An agent still lacks prerequisites, failure behavior, and the relationship to the deployment and token-configuration siblings.

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 branch, deploy_path, github_repo_url, repository_name and repository_root are already documented in the schema; baseline 3 applies. The description only echoes that deploy_path is optional and adds no format, default, or constraint detail beyond the 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 names a concrete verb pair (connect and clone) and a resource (a GitHub repository), plus the destination (cPanel). It is clear what the tool does, but it never distinguishes itself from close siblings such as create_git_repo, deploy_git_repo, or redeploy_from_github, so an agent cannot route on this text alone.

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 when-to-use guidance: no prerequisites (e.g. a configured GitHub token via configure_github_token), no exclusions, and no mention of when to choose this over create_git_repo or deploy_git_repo. The word 'optionally' hints at a variant mode but does not explain the condition for choosing it.

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