get_remediation

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

With no annotations, the description details the output format (copy-paste ready CLI and HCL). It does not disclose error handling, authentication needs, or behavior on invalid IDs, but it is adequate for a straightforward read operation.

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, front-loads the purpose, and provides examples without superfluous information. Every sentence adds value.

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 output schema exists (not shown), the description sufficiently explains what the tool returns. It covers the essential context for a simple retrieval tool, though it could mention the output format types.

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 coverage is 0%, but the description adds concrete examples for check_id (e.g., 'aws-iam-001'), clarifying the expected format beyond the schema's type definition alone.

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 specifies the tool's purpose: retrieving remediation details (CLI command + Terraform code) for a specific check. It distinguishes from sibling tools like list_checks and get_findings by focusing on remediation actions.

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 indicates the tool is used for a specific check ID, providing examples. While it does not explicitly state when not to use it or compare to alternatives, the context is clear for a simple retrieval tool.

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