describe_compliance_report

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

With no annotations, description carries the full burden. It clearly states this is a retrieve operation and explains the content of compliance reports (configuration validation outcomes, rule violations, status). Implicitly read-only, but does not explicitly mention that it has no side effects. Adds meaningful context beyond the tool name.

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?

Two sentences, both purposeful. The first gives the high-level action, the second provides necessary context about what compliance reports contain. No fluff.

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 simple 1-parameter tool with an output schema, the description is complete. It explains the tool's purpose and the nature of the data returned. No missing critical context given the presence of an output schema.

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 100% for the sole parameter report_id, with a description already provided. The description text does not add extra semantics about the parameter format or where to obtain the ID, so baseline 3 applies.

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?

Clear verb 'Retrieve' with specific resource 'detailed compliance report results' and platform context. Distinguishes from other describe_* tools by naming the exact entity (compliance report) and elaborating on what results include.

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?

No guidance on when to use this tool versus alternatives. Doesn't mention related tools like run_compliance_plan or get_compliance_plans, nor any prerequisites or exclusions. Usage context is only implied by the verb 'Retrieve'.

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