smartsuite_update_form

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

Annotations show readOnlyHint=false, and the description elaborates on the write behavior, including dry-run preview, confirm to apply, and the advanced formState escape hatch. 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 paragraph that efficiently covers requirements, options, and behavior. Every sentence adds value without redundancy.

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 10 parameters, nested objects, and no output schema, the description covers primary behaviors and the dry-run mechanism. It lacks return value details but is adequate for agent invocation.

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 has 50% description coverage; the description adds meaning by explaining settings merging, fields replacement, and formState wholesale replacement. It compensates for missing schema descriptions on parameters like title, submitLabel, etc.

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 'Update a form's settings and/or structure.' It specifies what can be updated (settings, fields, formState) and distinguishes from sibling tools like list, describe, create, submit forms.

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 explicit prerequisites (readwrite/admin mode, SMARTSUITE_ENABLE_SCHEMA_WRITE=true) and explains the dry-run vs apply flow via confirm parameter. It does not explicitly state when not to use, but the alternatives are implied by sibling tool names.

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