ansible-role

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

With no annotations, the description must disclose behavioral traits. It lists parameters like check, diff, and verbose that hint at execution behavior, and notes the return is an ansible_playbook() result. However, it does not explicitly state side effects (e.g., potential system changes), cleanup of temporary playbooks, or required permissions, which are important for a tool that executes code remotely.

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 concise, with a clear one-sentence purpose, a structured list of parameters, and a return type note. Every sentence adds value, and there is no redundant information.

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 tool's complexity (9 parameters, Ansible role execution with potential side effects) and existence of an output schema, the description covers the essential purpose and parameter details. It could be improved by including prerequisites (e.g., Ansible installation, role availability) or common usage patterns, but it is generally sufficient.

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 description coverage is 0%, so the description must compensate. It provides a meaningful one-line description for 8 of 9 parameters in the 'Args' section, including constraints like 'Verbosity level 1-4' for verbose and 'Target hosts pattern' for hosts. However, it misses the 'env' parameter, leaving its purpose unclear.

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 starts with 'Execute an Ansible role by generating a temporary playbook,' which clearly states the verb (execute) and resource (Ansible role) and the mechanism (generating a temporary playbook). This distinguishes it from sibling tools like ansible-playbook and ansible-task, which execute entire playbooks or tasks directly.

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 provides no explicit guidance on when to use this tool versus alternatives, such as ansible-playbook or ansible-task. It does not mention conditions, prerequisites, or when not to use it, leaving the agent to infer usage from the purpose alone.

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