smartsuite_set_field_help_text

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

Annotations only provide readOnlyHint=false, indicating a write operation. The description adds extensive behavioral details: markdown conversion, clearing help text, display format options, that the full field definition is rewritten, async application, and dry-run preview. 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 of 5 sentences, each providing essential information without redundancy. It front-loads the core purpose and adds concrete details efficiently.

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 no output schema, the description fully covers the tool's behavior, prerequisites, and effects. No missing context for proper 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 coverage is 100%, but the description adds significant value beyond parameter descriptions: explains markdown syntax for helpText, the effect of empty string, the meaning of displayFormat values, and the confirm parameter's role in dry-run vs apply.

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 purpose: 'Set or modify a field's help text (any field type).' This is a specific verb+resource combination, and the sibling tools like smartsuite_set_field_visibility and smartsuite_update_field handle different aspects, providing distinction.

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 mentions required conditions ('Requires readwrite/admin mode AND SMARTSUITE_ENABLE_SCHEMA_WRITE=true') and explains the dry-run behavior with confirm. While it doesn't explicitly contrast with siblings, the context is clear enough for appropriate use.

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