get_automation

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

With no annotations, the description does the heavy lifting. It clearly conveys that this is a read operation returning configuration data, not executing the automation or modifying anything. Naming the specific payload components adds useful behavioral context, though it does not discuss error cases, permissions, or other 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?

A single, front-loaded sentence that states the action and the contents of the result without any filler. Every word contributes meaning.

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?

For a one-parameter getter with no output schema, the description gives a solid overview of the return value (trigger, payload shape, targets). It could be slightly more explicit about the exact shape of the returned configuration, but 'in full' plus the listed elements is sufficient for a simple tool.

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 already fully documents config_id, so the baseline is 3. The description adds value by clarifying that the ID is from list_automations and that the returned content includes trigger, payload shape, and targets — linking the parameter to expected inputs and outputs beyond the raw type definition.

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 uses a specific verb ('Get') and resource ('one automation configuration') and enumerates what is included ('its trigger, payload shape and targets'). This cleanly distinguishes it from siblings like list_automations (which presumably returns summaries) and run_automation (which executes rather than retrieves).

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 usage context is implied by the phrase 'one automation configuration in full' — an agent can tell it is for fetching full details rather than listing all configs. However, there is no explicit statement of when to choose this tool over siblings such as list_automations or run_automation, and no exclusions are mentioned.

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