Detalhar Código CNAE

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

Beyond the readOnlyHint and idempotentHint annotations, the description discloses that for classes/subclasses it returns 'as atividades incluídas' (included activities) and mentions the return of the complete hierarchy. This adds useful behavioral context without contradicting 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?

The description is well-structured: a concise first sentence states the core purpose, followed by a clear 'Args:' section with examples and a 'Retorna:' section. Every sentence adds value, and the formatting is easy to scan.

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 covers the essential inputs and return elements, including the note about activities for classes/subclasses. However, with no output schema, it could be more explicit about the structure of the 'hierarquia completa' or error handling for invalid codes, but overall it is sufficient for a simple detail 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?

The schema already provides a description for 'codigo', but the tool description significantly enriches it by enumerating all accepted formats with examples (e.g., 'G', '47', '47.1', '4711-3', '4711-3/02'). This goes well beyond the schema's minimal description, clarifying exact string patterns and hierarchical levels.

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 'Retorna detalhes completos de um código CNAE' (returns complete details of a CNAE code), specifying the resource and scope. It distinguishes itself from siblings like ibge_cnae_buscar (search) and ibge_cnae_secoes (sections) by focusing on detailing any hierarchical level.

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 implies usage by stating it accepts section, division, group, class, or subclass codes, but it does not explicitly mention when to use this tool over alternatives or provide exclusions. No comparison with sibling tools is given.

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