Delete Custom Field

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

With no annotations, the description carries the full burden and explicitly warns that the operation permanently removes the field and all data stored in it across all records. This discloses critical destructive behavior that goes beyond the basic action description.

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 short sentences: the first states the purpose, the second adds a critical warning. Every word earns its place, and the warning is front-loaded directly after the action.

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?

For a simple delete operation without an output schema, the description fully covers the essential behavior: what it does and the irreversible data loss consequence. The schema covers parameters, leaving no major gaps.

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?

The input schema provides 100% coverage with clear descriptions for both parameters ('The CustomFieldId to delete' and 'If deleting a section, also delete nested fields'). The description adds no further parameter meaning, so baseline 3 is appropriate.

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 ('Delete a custom field definition') with a specific verb and resource, distinguishing it from sibling tools like create_custom_field, edit_custom_field, and get_custom_field. The warning adds specificity about scope (across all records).

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 implies usage for removing a custom field definition, but does not explicitly state when to use it versus alternatives (e.g., edit_custom_field for modifications instead of deletion). No exclusions or alternative tool references are provided.

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