find_pitfall

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

The description does not disclose what the tool returns, whether it is read-only, or any side effects. Without annotations, the agent has no information about the tool's behavior beyond the basic search action.

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 a single, concise sentence with no unnecessary words. It efficiently conveys the core purpose.

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?

The description lacks information about the output format, return data, or any usage constraints. Given the tool's simplicity, it is still incomplete without stating what a successful search yields.

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 schema descriptions cover all parameters, and the tool description's mention of categories aligns with the 'kind' parameter. However, the description adds no additional meaning about how parameters interact or affect results, so the value is moderate.

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 resource (pitfalls) and the action (search), listing several categories. However, it does not differentiate from sibling tools like find_api or find_example, making the purpose somewhat generic.

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?

There is no guidance on when to use this tool versus alternatives such as search_docs or find_api. The description provides no context for selection, leaving the agent to infer use cases.

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