convert_to_gateway_api

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

With no annotations, the description carries full burden. It outlines the pipeline steps but does not disclose error handling, idempotency, or whether the tool is destructive (likely it returns converted YAML without side effects).

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 well-structured with a summary line, pipeline steps, and parameter list. It front-loads the purpose. While slightly lengthy, the parameter list is justified due to low schema coverage.

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 (12 parameters, 0% schema coverage) and presence of output schema, the description covers the conversion pipeline and parameter meanings well. It lacks mention of error conditions or output format, but output schema may address that.

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%, so the description adds value by explaining most parameters, e.g., 'ingress_yaml: Nginx Ingress YAML content or file path' and 'gateway_grouping: Gateway consolidation strategy...'. However, some health-check parameters are only named without detail.

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 'Convert Nginx Ingress YAML to AWS Gateway API resources (full pipeline)', with a specific verb and resource. It distinguishes from sibling tools like analyze_ingress and validate_output by being the actual conversion step.

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 implies usage for converting Nginx Ingress to AWS Gateway API but does not explicitly state when to use vs alternatives like check_prerequisites or generate_migration_report. No when-not guidance is provided.

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