Restart Application

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

Annotations already indicate destructiveHint=true, but description adds key behavioral details: it attempts to restart and waits for RUNNING state, and raises InvalidStateError for non-running states. This goes beyond annotations and gives the agent actionable expectations about side effects and errors.

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?

Description is concise: one opening sentence, then a bulleted list of state-based behaviors. No unnecessary words. Front-loaded with the main purpose.

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 restart tool with annotations and an output schema, the description covers the essential state-dependent behavior and error handling. It does not describe the output schema contents, but that is not required since an output schema exists. Slightly more could be said about timeout behavior or prerequisites, but overall it is sufficiently complete.

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?

Input schema covers 100% of parameters with descriptions ('name' and 'timeout'), so baseline is 3. The description does not add additional parameter-specific semantics beyond what the schema already provides, though it indirectly ties 'timeout' to 'waits for RUNNING state'.

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?

Description clearly states 'Restart an application on Itential Platform', which is a specific verb+resource. It distinguishes from sibling tools like restart_adapter (different resource) and start/stop_application (different operations).

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?

Provides clear context: restart only applies to RUNNING state, and explicitly states invalid states (STOPPED/DEAD/DELETED) raise InvalidStateError. This implies when not to use the tool, though it does not name alternative tools like start_application.

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