halt_system

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

The description adds a specific consequence ('This will power off the system') beyond the destructiveHint annotation, clarifying that the operation is not just destructive but a hard shutdown. This helps the agent understand the irreversible nature, though it could mention that the system remains off until manually powered on.

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 extremely concise: one action sentence plus a warning. Every word earns its place, and the critical warning is front-loaded for immediate visibility.

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 destructive operation, the description, combined with the rich parameter schema and annotations, is sufficiently complete. It could have included a note about using dry_run first, but the schema already documents this capability, so the gap is minor.

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 covers both parameters (confirm and dry_run) with clear descriptions, so baseline is 3. The tool description adds no additional parameter-specific meaning, but none is needed given the schema coverage.

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 and resource: 'Halt (shut down) the pfSense system.' It also distinguishes from the sibling reboot_system by explicitly specifying that the system will be powered off, making the intent unambiguous.

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 like reboot_system. The warning indicates caution but does not state explicit use cases, exclusions, or prerequisite conditions (e.g., 'only when full shutdown is required').

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