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

Annotations already establish the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description adds conditional behavior not in the annotations: in the unlinked state it returns connection instructions, and once connected it lists the user's repositories. It does not mention that this likely makes remote API calls that can fail or be rate limited.

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?

Two sentences, front-loaded with the usage trigger before the enumeration of returned facets. Dense but every clause carries information; only the trailing 'lists their repositories once GitHub is connected' edges toward output restatement.

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?

An output schema exists, so return formatting need not be explained, and the description covers the main facets plus the unlinked edge case. The one gap is the site_id input, which is undocumented in both schema and description, but overall the definition is complete enough to invoke correctly.

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?

There is one parameter (site_id) with 0% schema description coverage and no enum. The phrase 'for one of their WebTwizz sites' implies the parameter scopes to a specific site, but no format, ID source, or lookup hint is given. The description adds modest meaning over the bare string type.

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 specific resource (GitHub integration status for a WebTwizz site) and enumerates exactly what it reports: linkage state, drift between GitHub and the site, last push, recent commits, and open pull requests. This is clearly a read-only status aggregator, which an agent can distinguish from push-to-github and pull-from-github without opening any schema.

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?

It gives an explicit trigger condition: 'Use this when the user asks about GitHub for one of their WebTwizz sites.' It further clarifies behavior in two states (nothing linked vs. connected), which tells the agent when the tool is still the right call even before a repo exists. It does not, however, name the push/pull siblings or state when to prefer them.

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