woo_scaffold_shipping_method

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

No annotations are present, so the description carries the full burden. It only mentions code generation but does not disclose side effects (e.g., file creation, namespace registration), prerequisites, or potential destructive actions. For a scaffold tool, agents need to know what changes are made to the project.

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 sentence that is front-loaded with the verb and resource. It is concise and includes essential details about the output. Minor improvement could be breaking into multiple lines for readability.

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 scaffolding a class and the lack of output schema, the description provides a reasonable outline of what is generated (specific methods and registration). However, it omits details like file location, namespace conventions, and whether existing files are modified, leaving some ambiguity.

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 all parameters with descriptions (100% coverage). The description adds value by specifying the generated class contents (methods), which is not in the schema, but does not enhance understanding of parameter usage beyond what the schema provides.

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 (Generate) and the resource (WooCommerce Shipping Method class) with specific methods included (calculate_shipping, init_form_fields, ServiceProvider registration). This distinctly differentiates it from sibling tools like woo_scaffold_payment_gateway or woo_scaffold_email.

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 is provided on when to use this tool versus alternatives. Given the large number of sibling scaffold tools, the description should indicate when this tool is appropriate (e.g., for adding a custom shipping method) and when to use other tools.

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