List Custom Fields

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds meaningful behavioral context: it returns 'curated' metadata, defaults to searchable fields, and notes the include_non_searchable option. This goes beyond the annotations and helps the agent understand the response set.

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 concise, two sentences long, and front-loaded with the core purpose. It avoids redundant information and uses the second sentence for a key parameter behavior, earning its place.

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 the output schema, annotations, and parameter coverage, the description is nearly complete. It covers what the tool lists, for which entity types, and the default vs optional behavior. It could mention pagination or relationship to get_custom_field_details, but those are not critical for this simple list operation.

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 value by explicitly stating the default behavior ('Returns searchable fields by default') and the effect of setting include_non_searchable=true. This supplements the schema descriptions, making parameter semantics clearer.

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 'List' and resource 'custom field metadata' with a specific scope of entity types (candidates, contacts, companies, jobs, deals). It distinguishes itself from sibling tools like get_custom_field_details by focusing on listing curated metadata rather than fetching a single field's details.

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 clear context on what the tool does (lists custom field metadata for a specific entity type) and explains the default behavior (searchable fields only) with an option to include non-searchable. It does not explicitly name alternatives or when-not-to-use, but the context is sufficient for an AI agent to choose this tool over a details or dependencies endpoint.

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