Create Hotlist

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

Annotations already indicate non-read-only and destructive behavior, so the description's job is lighter. It adds useful context by explaining the meaning of 'shared' (team-shared vs private) and by recommending a way to resolve user IDs, which goes beyond the schema. It doesn't contradict the 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?

Two sentences: first states the action, second lists requirements and a helpful tip. No redundant information, and every sentence contributes to the agent's decision-making and execution.

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 create operation with 4 required parameters and an output schema present, the description fully covers purpose, requirements, parameter semantics, and a key dependency (list_users). It lacks clutter and provides everything an agent needs to successfully invoke the tool.

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 covers all parameters, so baseline is 3. The description adds value by clarifying the 'shared' flag semantics and explicitly identifying 'created_by' as a user ID with a resolution method, improving parameter understanding 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's action with a specific verb and resource: 'Creates one Recruit CRM hotlist.' It distinguishes itself from sibling tools like search_hotlists and add_records_to_hotlist by focusing solely on the creation aspect.

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 gives clear usage context by listing required parameters and explicitly mentions resolving user IDs with list_users, which provides a helpful prerequisite. It does not exclude alternative tools, but the purpose is unambiguous enough that an agent can decide when to invoke it.

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