smartsuite_set_automation_ai_prompt

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

Annotations only set readOnlyHint=false, so the description carries the burden. It discloses that the tool writes the prompt, leaves the rest intact, builds rich-text from plain text, resolves field references, and dry-runs by default. Auth and environment requirements are noted. 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 a single dense paragraph of about 100 words. It is front-loaded with the main action and contains no fluff, but could benefit from slight structuring (e.g., bullet points or separate sentences for prerequisites). Still very concise.

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 6 parameters, no output schema, and no annotations beyond readOnlyHint, the description thoroughly explains the mechanism, edge cases, and safe usage (dry-run preview). It mentions the underlying GetAutomation call for reliability. The agent has enough to use the tool correctly.

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 vital context: promptTemplate format with {{field_slug}} syntax, applicationId as the resolution table, actionInstanceId for multi-action scenarios, and confirm's dry-run behavior. This goes beyond the schema 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 the tool's action: 'Set the dynamic prompt on an automation's AI action.' It specifies the exact resource and distinguishes itself by calling itself 'the reliable way' compared to hand-building.

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?

Explicit prerequisites are given (readwrite/admin mode, SMARTSUITE_ENABLE_SCHEMA_WRITE=true), usage instructions for dry-run vs confirmation with confirm:true, and handling multiple AI actions via actionInstanceId. It also warns against hand-building the prompt.

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