smartsuite_describe_automation

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

Annotations declare readOnlyHint=true, and the description reinforces that this is a read operation by stating 'Get'. It adds specific behavioral context by detailing what the full configuration includes (trigger, actions, name, enabled state, timezone), which goes beyond the annotation to give agents a clear picture of the output. No contradictions.

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 two sentences long, front-loaded with the primary purpose, and contains no extraneous words. Every sentence serves a clear function: stating what the tool does and providing a usage hint.

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?

The description covers the essentials for a describe tool: what it returns and how to obtain the required ID. While there is no output schema, the description mentions the key fields. Given the tool's simplicity and the presence of good annotations, it is sufficiently complete.

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 100%, with both parameters (solutionId, automationId) described in the input schema. The description does not add further semantics beyond the schema, but the schema itself is clear. Given high coverage, a score of 3 is appropriate.

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 verb 'Get' and the resource 'automation', listing the specific components returned (trigger config, action groups, name, enabled state, timezone). It also distinguishes from the sibling tool smartsuite_list_automations by directing users to use that for finding automation IDs.

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 explicitly instructs users to use smartsuite_list_automations to find automation IDs before calling this tool, providing clear context for usage. It does not mention when not to use it, but for a describe tool that depends on knowing the ID, this guidance is sufficient.

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