scaffold_terraform

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

With no annotations, the description discloses important behavioral traits: the provider always assumes IAM_ROLE_NAME, static credentials are not an option, and aws_account_id is filled automatically. It also documents the return format. However, it does not mention whether existing files are overwritten or if a module must already exist.

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 front-loaded with the core purpose, followed by a compact file list, IAM role constraint, and Args/Returns sections. Every sentence adds necessary context, and there is no filler.

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 two-parameter tool with an output schema, the description covers file structure, IAM role behavior, and return format. It lacks edge cases like overwrite behavior or module existence prerequisites, but is otherwise adequate for a scaffolding task.

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 description coverage is 0%, but the description compensates by explaining service_name with an example and variables as an optional dict for preloading terraform.tfvars. Both parameters are covered, though the exact structure of variables could be more detailed.

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 uses a specific verb 'Genera' and identifies the resource as a complete Terraform configuration using a module. It enumerates the standard files created, making the tool's scope clear and distinguishing it from sibling read/search tools.

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 makes the tool's function clear but provides no explicit guidance on when to use this tool versus alternatives like search_modules or get_module. Usage is implied rather than explicitly contrasted with sibling tools.

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