Skip to main content
Glama

hcl_generate_operations

Read-onlyIdempotent

Generate a declarative HCL operation manifest from a topology plan for offline review; operations remain non-executable until live adapters are accepted.

Instructions

Generate a declarative HCL operation manifest; executable=false until live adapters are accepted.

Input Schema

NameRequiredDescriptionDefault
planYes
include_configsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

C2.8/5.0
Behavior3/5

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

The readOnly, idempotent, and non-destructive annotations already establish safety. The description adds useful behavioral context that the generated manifest is non-executable until live adapters are accepted, but it does not explain the manifest's contents, output shape, or how the executable flag changes.

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

Conciseness5/5

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

The description is a single front-loaded sentence with no filler. It is concise and easy to scan, though its brevity contributes to gaps elsewhere.

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?

For a tool accepting a large nested topology plan and returning a generated manifest with no output schema, the description is far too thin. It does not explain the expected plan structure, the meaning of 'include_configs', or what the resulting operation manifest contains.

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

Parameters2/5

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

Schema description coverage is 0% and the description never mentions the two top-level parameters, 'plan' or 'include_configs'. With a very large nested plan schema and no parameter prose, the description does not compensate for the coverage gap.

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 description names a specific action and artifact: generating a declarative HCL operation manifest. However, it does not distinguish this from close siblings such as hcl_generate_configs, hcl_export_artifacts, or hcl_plan_topology, and 'operation manifest' remains undefined.

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?

It gives no guidance on when to use this tool versus generating configs, exporting artifacts, or planning topology. The 'executable=false until live adapters are accepted' caveat is a status note, not a selection guideline.

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