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

While annotations cover safety (readOnlyHint: true), the description provides rich behavioral context by detailing the specific data points it monitors. It explains the tool's functional behavior across different states—unlinked vs. linked—which goes far beyond the scope of a simple safety hint.

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 highly efficient, providing a wealth of technical information in a focused, single paragraph. Every sentence directly contributes to defining the tool's scope and expected behavior without any redundant language.

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?

Given the complexity of status reporting (requiring knowledge of PRs, commits, and link status), the description is exceptionally complete. It manages to describe the operational logic and the two major states (connected/unconnected) of the tool without needing an output schema.

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?

Since schema coverage is 0%, the description must define the parameter's context. It clarifies that the 'site_id' must correspond to 'one of their WebTwizz sites,' providing essential semantic context. It scores a 4 instead of 5 because it doesn't describe the format or constraints of the ID itself, only its domain.

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 purpose is perfectly clear: to retrieve comprehensive status information regarding a GitHub integration for a specific WebTwizz site. It specifically enumerates the data retrieved (link status, changes, last push, commits, and PRs), distinguishing it from action-oriented siblings like push-to-github or pull-from-github.

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 guidelines are explicit, stating the exact scenario for usage ('when the user asks about GitHub for one of their WebTwizz sites'). Furthermore, it covers the necessary behavioral guidance for the tool's states, addressing what happens when nothing is linked yet versus when it is connected.

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