hs4.admin.system.service.restart

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

With no annotations, the description carries full burden for behavioral disclosure. It states it restarts a service via admin controls, implying a mutating operation, but does not describe consequences (e.g., downtime, dependency impacts), required permissions, or whether the action is reversible. The description is insufficient for a potentially destructive operation.

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 directly states the tool's purpose. No extraneous information is present, and it fulfills its role efficiently.

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 the tool (10 parameters, admin mutation with risk/confirm fields), the description is too minimal. It does not explain key parameters like confirm, maintenanceWindowId, or riskLevel, nor does it address return values (no output schema). The description leaves significant gaps for an agent to understand usage.

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 coverage is 90%, so most parameters are well-documented in the schema. The description adds no additional context beyond the schema, but is not needed to compensate. Baseline 3 is appropriate.

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 action ('Restart') and resource ('an HS4 service'), indicating it is an admin operation. However, it does not explicitly differentiate from sibling restart tools like hs4.admin.plugins.restart or hs4.admin.interfaces.restart, which could cause confusion about which service is being restarted.

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 (e.g., plugins.restart or interfaces.restart). There is no mention of prerequisites, context, or scenarios where this tool is appropriate or should be avoided.

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