consultar_corretora

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

No annotations provided, but description covers return format (JSON) and fields included. Does not mention rate limits or error handling, but sufficient for a simple query tool.

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?

Single paragraph with clear sections for purpose, return data, and usage guidelines. Concise but thorough, no wasted 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?

Given simple lookup with one parameter and no output schema, description is complete: explains what it does, what it returns, and when to use it.

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 100% of parameter, description adds value by specifying format (com ou sem máscara, 14 dígitos) and providing an example, which exceeds schema description.

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?

Description clearly states it consults cadastral data of a securities broker authorized by CVM via BrasilAPI, specifies the resource and source, and distinguishes from sibling tools like consultar_cnpj.

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?

Explicitly provides when to use (user provides CNPJ to check if authorized broker) and when not to use (for general companies, insurance brokers, or search by name), with clear alternatives.

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