smartsuite_update_formula_field

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

The description discloses behavioral traits beyond the annotations: it is not read-only (readOnlyHint=false) and explains that it fetches the current definition, selectively updates fields, validates the expression, and supports a dry-run mode via the confirm parameter. This provides full behavioral transparency, complementing the annotations effectively.

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?

Two well-structured sentences cover purpose, prerequisites, and behavior without any fluff. The information is front-loaded and every sentence adds value. Highly concise and effective.

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 (6 parameters, no output schema), the description covers prerequisites, update mechanism, validation, and dry-run mode. It is complete for an AI agent to understand the operation and its nuances, and it differentiates well from siblings like smartsuite_update_field.

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%, so the baseline is 3. The description adds value by explaining how parameters interact (only supplied fields changed) and the role of confirm (validate vs apply). This goes beyond the schema descriptions, hence a 4.

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 action (update) and the resource (existing formula field), specifying that it can update expression, label, and return type. This distinguishes it from sibling tools like smartsuite_create_formula_field (create new) and smartsuite_update_field (generic field update). The verb 'update' with a specific resource provides excellent purpose clarity.

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 AND SMARTSUITE_ENABLE_SCHEMA_WRITE=true) and explains the behavior (fetches current definition, only supplied fields changed, validates expression, dry-run with confirm). While it doesn't explicitly state alternatives or when not to use, the context is clear enough for an AI agent to decide usage.

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