smartsuite_validate_formula

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

Adds significant detail beyond the readOnlyHint annotation: describes return format (valid, safe, warnings or error), error handling, and field reference syntax. No contradiction with annotations.

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. First sentence states purpose and safety. Second explains output and syntax. 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?

No output schema, but description adequately explains return types and error messages. Covers field reference syntax, safety, and typical use case. Complete for a validation 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%, so baseline is 3. The description adds usage context for formula syntax and returnType optionality, going 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 verb 'validate' and the resource 'SmartSuite formula expression', and explicitly notes it is safe and non-writing. This distinguishes it from sibling tools like smartsuite_analyze_formulas or field creation tools.

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?

Explicitly says to use before creating or updating a field, and emphasizes safety. However, it does not mention when not to use or list alternatives, though the sibling context is broad.

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