smartsuite_set_field_visibility

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

Discloses mutation (annotations confirm readOnlyHint:false), details effect on layout's hidden_fields list, record-wide scope, and preview mode. 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?

Three sentences efficiently convey purpose, requirements, and behavior. Front-loaded with main action, then details.

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 inputs and behavior well, though no output schema means return values are not described. Still sufficient for a mutation tool with clear inputs.

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 description adds value by explaining behavioral impact of hidden (true/false) and confirm, e.g., 'hidden:true hides the field (adds it to the layout's record-wide hidden_fields list).'

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?

Description clearly states 'Hide or show a field in the record view.' with specific verb and resource, distinguishing it from siblings like smartsuite_delete_field or smartsuite_create_field.

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?

Description specifies required permissions ('readwrite/admin + SMARTSUITE_ENABLE_SCHEMA_WRITE'), explains dry-run behavior unless confirm:true, and notes that hiding is record-wide. Lacks 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.