create_blackout

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

The description discloses the main behavioral effect: creating a blackout window prevents scans. However, with no annotations, it does not provide details about side effects, whether changes are reversible, or any permissions required. Since the tool is a simple create operation and the effect is clearly stated, this is adequate but not rich.

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 sentence that front-loads the action and purpose. It contains no filler or redundant information.

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 schema's comprehensive parameter descriptions and the tool's straightforward purpose, the description provides sufficient context for an agent. It doesn't cover edge cases like overlapping windows or immediate effect, but for a create tool this is adequate. The lack of an output schema is mitigated by the simplicity of the operation.

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 has 100% coverage with descriptions for all five parameters. The description adds no additional parameter information, but the schema already documents name, start, stop, enabled, and all_scan_configs. Baseline 3 applies.

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 the specific verb 'create' with the resource 'blackout window' and clearly states the purpose: 'prevent scans during maintenance periods.' This distinguishes it from sibling tools like list_blackouts, update_blackout, and delete_blackout.

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 it (during maintenance periods to prevent scans), but it does not explicitly mention alternatives or when not to use it. For example, it doesn't say to use update_blackout for modifying existing blackouts. This is clear context but no explicit exclusions.

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