Update Custom Field

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

The description adds key behavioral context beyond annotations by disclosing that the type field cannot be changed after creation and by stating that the updated custom field is returned. It aligns with annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=true) without contradiction.

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 two sentences long, front-loaded with the action, followed by a necessary note and return statement. Every sentence adds value with no unnecessary words.

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 an update tool with full schema coverage and relevant annotations, this description adequately covers the key constraints, alternatives, and return behavior. It does not delve into error handling or exhaustive parameter details, but those are largely served by the schema and annotations.

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?

All 8 parameters have complete descriptions in the schema (100% coverage), so the description does not need to repeat them. It provides a high-level summary of updatable fields (name, description, settings) but does not add significant meaning beyond the 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?

The description clearly states the tool updates a custom field's name, description, or settings, which is a specific verb+resource. It distinguishes itself from related siblings like create/delete/get custom field and explicitly points to enum option tools for that specific use case.

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 provides an explicit alternative for enum options (asana_create_enum_option or asana_update_enum_option) and notes that the type field is immutable. It does not explicitly state the general 'when to use' context, but the alternative and constraint give clear guidance on when not to use this tool.

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