get_catalog_plan

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

No annotations are provided, so the description must disclose behavioral traits. It does not mention that the tool is read-only, requires authentication, or handles errors (e.g., invalid SKU). The description implies a safe query but lacks explicit transparency.

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: first explains what the tool returns, second tells when to use it. No fluff, every sentence earns its place. Ideal length for a simple tool.

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?

The description enumerates the return contents (plans, specs, pricing, billing tracks) and usage context. It lacks details on error handling or output structure, but for a one-parameter tool with no output schema, this is reasonably complete.

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 schema covers the single 'sku' parameter 100%, and the description adds value by specifying the source ('from list_catalog_products') and providing an example. This goes beyond the schema's description, earning a 4.

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 explicitly states the tool retrieves 'full details for a single catalog product including all plans, specs, pricing, and billing tracks'. It clearly distinguishes from sibling tools like 'list_catalog_products' which lists SKUs, and 'get_product_details' which may be less specific.

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 advises using the tool 'before generating a Terraform plan or before recommending a specific SKU', providing clear context. It lacks explicit when-not-to-use or alternative tool mentions, but the guidance is sufficient for a focused tool.

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