pressable_toggle_maintenance_mode

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

With no annotations, the description carries the full burden of disclosing behavioral traits. It merely says 'toggle maintenance mode' but does not explain that this is a mutating action affecting site availability, nor does it mention reversibility, propagation time, or impact on visitors. The lack of warnings or consequences makes it opaque.

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 a single concise sentence that is easy to parse and front-loaded with the action. However, it is slightly redundant with the tool name and could have used the space to offer parameter hints, but it remains appropriately minimal for a simple toggle.

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?

The tool has two required parameters and no output schema, so the description is the only context. It fails to specify the semantics of 'enabled' or the effect on the site, and lacks any note about potential downtime or relationship to site status. This is incomplete for an agent 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?

Schema description coverage is 0%, and the description adds no meaning for the parameters. It does not explain that 'id' refers to the site ID or that 'enabled' controls whether maintenance mode is on (true) or off (false). The agent must infer from property names alone, which is insufficient.

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 the verb (toggle) and resource (maintenance mode for a site), which is specific enough to distinguish it from sibling tools like pressable_toggle_edge_cache or pressable_disable_site. The phrase 'maintenance mode' disambiguates the action despite the tool name being similar.

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?

No guidance is provided on when to use this tool versus alternatives such as pressable_disable_site or pressable_enable_site. There is no mention of prerequisites, side effects, or contexts where this toggle is appropriate, leaving the agent without information to decide.

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