hmc_sync_lpar_profile

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

Beyond the destructiveHint annotation, the description discloses that the operation 'overwrites the previous profile definition,' warns to confirm identifiers, explains the command executed, and details the UUID-to-name resolution process with fallback behavior. This adds substantial behavioral context not captured in structured fields.

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 concise but information-dense, with each sentence serving a purpose: defining the action, showing the command, stating the overwrite risk, providing a warning, and explaining resolution logic. No redundant or irrelevant content.

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 destructive sync operation, the description covers the operation, command, side effects, parameter handling, and output (raw command output). With good annotations and full schema coverage, this is complete and self-contained.

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 descriptions already cover both parameters fully, but the description adds important semantic context: that names or UUIDs are accepted and that UUIDs are resolved via REST or SSH fallback. This enriches understanding beyond the schema's basic field descriptions.

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 tool's function: 'Sync an LPAR's running configuration back to its current profile.' It specifies the action, resource, and target, and includes the exact HMC command executed. This distinguishes it from sibling tools like hmc_backup_lpar_profiles and hmc_modify_lpar.

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 the tool (to persist running config to a profile) and provides a warning, but it does not explicitly contrast with alternatives or state conditions when not to use it. There is no mention of sibling tools or exclusions, leaving usage context implicit rather than explicit.

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