scan_terraform_file

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

With no annotations, the description carries the full burden of behavioral disclosure, and it does well by outlining what the tool returns (Checkov check ID, title, resource, line range, code snippet). It does not mention limitations such as invalid Terraform or external dependencies, but it clearly communicates the main behavior and output shape.

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 compact and well-structured: a one-sentence definition, a use indicator, and an argument list that adds value beyond the schema. There is no redundant or filler 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?

Given the small parameter count, output schema availability, and sibling context, the description covers the essential inputs and expected outputs. It could be slightly more explicit about behavior on invalid/nonexistent Terraform content, but for the average call it is complete enough.

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 coverage is 0%, but the description fully compensates by documenting both arguments: file_content as the raw .tf text and filename as only a friendlier output label. This gives an agent everything needed to construct correct parameters.

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 ('scan') and resource type (Terraform .tf files) and states the goal ('security misconfigurations') and engine (Checkov). It is easily distinguished from sibling scan_dockerfile_file by mentioning Terraform explicitly.

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 explicitly says to use it whenever the user asks to review, audit, or check Terraform code. It does not explicitly mention excluding other file types or name the Dockerfile sibling as an alternative, so it slightly misses the top guidance bar.

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