disable_github_deploy

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

The description discloses the main behavioral effect (disables auto-deploy, requires manual deploys). However, it does not mention reversal options, permissions, or side effects. Without annotations, this is adequate but minimal.

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 concise sentences with no redundant information. The main action is front-loaded.

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 simple toggle action with two well-described parameters and a direct sibling tool, the description is complete. No gaps in context.

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 input schema provides 100% coverage for both parameters (projectName, serviceName), so the description does not need to add more. No extra semantic context is provided 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 uses a specific verb ('desativa' disables) and resource ('auto-deploy via GitHub'), clearly distinguishing it from the sibling 'enable_github_deploy'.

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 implies when to use (when disabling auto-deploy) and states the consequence (deploys must be manual). It does not explicitly exclude other contexts, but the sibling tool provides clear alternatives.

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