smartsuite_create_formula_field

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

Discloses validation before creation, automatic slug generation, and dry-run functionality. Annotations only indicate write intent; description adds critical behavioral traits.

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?

Four sentences, no fluff. Purpose and prerequisites in first sentence. Logical flow from requirements to behavior. Every sentence adds value.

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?

Covers auth, dry-run, validation, and slug. No output schema, so description could hint at return value for confirm:true, but overall adequate for a moderately complex 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 covers all parameters. Description adds meaning: formula validation purpose, slug auto-generation, confirm toggling dry-run, and afterFieldSlug placement logic. Goes beyond raw schema.

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?

Verbs 'create' and resource 'formula field' are explicit. Distinguishes from siblings like smartsuite_create_field and smartsuite_update_formula_field by specifying field type and concurrency.

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?

Specifies required modes (readwrite/admin) and environment variable. Explains dry-run vs actual creation with confirm parameter. No explicit when-not-to-use, but context is clear.

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