generate_config

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

Discloses non-destructive nature (no deployment), available host variables, and notably what is not exposed (credentials). Missing details on error handling or throttling, but solid given no annotations.

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 focused paragraphs, no fluff, key points front-loaded. Effective use of examples for variables.

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?

Covers purpose, parameters, behavior, and output schema exists to explain return values. No obvious gaps.

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?

With 0% schema coverage, description compensates by explaining template_string as Jinja2 template with examples of available variables, and filter_criteria as filter dictionary. Filter_criteria could be more descriptive.

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?

Description explicitly states it generates config from a Jinja2 template and does NOT deploy, clearly distinguishing it from siblings like run_netmiko_config.

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?

Indicates use case (dry-runs/auditing) and non-deployment nature, but does not explicitly name alternatives like run_netmiko_config for actual deployment.

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