discover_terraform_resources

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

With no annotations provided, the description should cover behavioral traits. It describes the return format and mentions it is a discovery operation, but does not explicitly state if it is read-only or if it has side effects. It is moderately transparent.

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 with two clear sentences and a structured Args section. Every sentence adds value, and it is front-loaded with the primary purpose.

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 tool has one parameter, no annotations, and an output schema referenced in the description, the description fully explains what the tool does, what it returns, and when to use it. It is complete for the tool's complexity.

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?

The input schema has 0% description coverage, so the description must compensate. It provides a clear explanation for the only parameter 'module_path': 'Path to the module directory containing Terraform files.' This adds value beyond the schema's title.

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 purpose: 'Discover all Terraform resources in a module directory.' It also specifies the use case: 'Use this first to see what resources are available for import.' This differentiates it from sibling tools that handle import, writing, or deployment.

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 advises to use this tool first in the import workflow, providing a clear context of use. It does not explicitly mention alternatives or when not to use, but the guidance is strong.

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