Skip to main content
Glama

iaas_shutdown_machine

Shut down a specified machine by ID through the VCF Automation IaaS API, stopping running workloads when they are no longer needed.

Instructions

Shut down operation for machine Second day shut down operation machine POST /iaas/api/machines/{id}/operations/shutdown

Input Schema

NameRequiredDescriptionDefault
idYesThe id of the Machine. (path)
apiVersionNoThe version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.5/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is partly covered. The description adds nothing beyond that: it does not say whether the shutdown is graceful or forced, whether it is asynchronous and returns a request tracker, or what happens to the guest OS state. The stray "Second day shut down" line is noise rather than behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The text is very short, but the middle line is incoherent filler and the raw HTTP path duplicates what the annotations title already conveys. Front-loading the intent is fine; the extra line does not earn its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a state-changing machine operation with no output schema and no description of the result (task/request id), timeout, or permission requirements. Given the complexity of a power-state mutation and the crowded sibling set, the definition is too thin for an agent to invoke it confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With schema description coverage at 100%, the schema already documents both the required machine id and the optional apiVersion. The description only echoes the {id} path parameter embedded in the POST route and adds no format or constraint detail beyond it, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first line, "Shut down operation for machine," states a recognizable verb and resource, but the second line ("Second day shut down operation machine") is garbled and adds no meaning. With siblings like iaas_power_off_machine, iaas_suspend_machine, iaas_reset_machine and iaas_reboot_machine in the same family, the description never distinguishes this shutdown operation from those closely related ones.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool rather than iaas_power_off_machine or iaas_suspend_machine, and no prerequisites are given (e.g. the machine must be powered on). The agent must infer all usage conditions from the name alone.

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

Deploy Server

Other Tools