refresh_terraform_service

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'refresh Terraform state and detect configuration drift,' which implies a read-only or diagnostic operation, but doesn't clarify if this modifies state, requires specific permissions, has side effects like network calls, or what the output entails (e.g., drift report). This leaves significant gaps in understanding the tool's behavior.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and wastes no space, making it easy for an agent to parse quickly.

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 complexity of Terraform operations and the lack of annotations and output schema, the description is insufficient. It doesn't cover behavioral aspects like whether this is a safe read operation or a state-modifying action, what the output looks like (e.g., drift details), or how it differs from sibling tools. This leaves the agent with incomplete context for proper tool selection and invocation.

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 100% description coverage, so parameters like 'service_name' and 'hostname' are well-documented in the schema itself. The description adds no additional semantic context beyond what the schema provides, such as explaining how 'refresh' interacts with these parameters. Thus, it meets the baseline for high schema coverage without enhancing parameter understanding.

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 action ('refresh Terraform state and detect configuration drift') and the resource ('Terraform service'), making the purpose immediately understandable. However, it doesn't explicitly differentiate this from sibling tools like 'plan_terraform_service' or 'destroy_terraform_service', which would require more specific language about when to refresh versus plan or destroy.

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 provides no guidance on when to use this tool versus alternatives like 'plan_terraform_service' or 'destroy_terraform_service', nor does it mention prerequisites such as needing SSH access or Terraform setup. It lacks explicit context for usage, leaving the agent to infer based on the tool name alone.

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