smartsuite_create_automation

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

Annotations only provide readOnlyHint=false, so the description carries the full burden. It discloses the required readwrite/admin mode and environment variable, explains credentialId propagation, describes two action passing formats, and notes optional fields. This adds significant behavioral context beyond what annotations offer.

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 paragraph of moderate length, front-loaded with the core purpose and prerequisites. It is efficient without unnecessary repetition, though it could benefit from bullet points or more structured formatting for high scanability.

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 (nested objects, optional parameters, alternative inputs), the description covers prerequisites, shape discovery, action formats, credential propagation, and optional fields. It does not detail return values or errors, but lacks output schema and sibling tools cover those aspects. Overall, it is fairly complete for a create 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?

Schema coverage is 100%, but the description adds meaning: it explains the mutual exclusivity of 'actions' and 'actionGroups', how 'credentialId' fills gaps, and that 'automaticDescription' is a phrase-builder JSON string. This clarifies usage beyond the schema's property descriptions.

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 'Create an automation in a solution' with a specific verb and resource. It distinguishes itself from sibling tools like smartsuite_update_automation and smartsuite_describe_automation by being the only creation tool for automations, making intent unambiguous.

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 prerequisites (readwrite/admin mode, SMARTSUITE_ENABLE_SCHEMA_WRITE=true) and recommends using smartsuite_describe_automation_step for learning trigger/action shapes. It covers key usage context but does not explicitly state when not to use this tool (e.g., for updates vs creation), though it is implied.

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