listar_semana

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

Sem annotations, a descrição precisa revelar comportamento e o faz bem: informa a inferência da semana, o fallback de turma, e o truncamento padrão de ~200 caracteres com a opção 'detalhado'. Esse nível de detalhe vai além do esquema e ajuda o agente a prever o resultado da chamada.

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?

A descrição é objetiva, com frase de propósito na frente e seção 'Args' organizada. Cada frase agrega valor: o comportamento de cada parâmetro é explicado sem redundância ou texto desnecessário.

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?

Para uma ferramenta de leitura com três parâmetros opcionais e nenhuma annotation, a descrição cobre todos os comportamentos relevantes: inferência, fallbacks, truncamento e contexto de uso. A existência de output schema cobre a necessidade de explicar o retorno, tornando a definição completa.

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?

O schema não fornece descrições dos parâmetros, mas a descrição cobre todos os três com semântica adicional: numero_semana com exemplo de correspondência, turma aceitando caption ou uuid, e detalhado controlando o nível de detalhe. A descrição compensa totalmente a cobertura de 0% do 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?

A descrição começa com verbo específico e recurso claro: 'Lista as atividades de uma semana de uma turma do Adalove'. Define exatamente o escopo da operação, diferenciando-a claramente de outras possíveis ferramentas por nome e descrição, mesmo sem tools irmãs listadas.

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?

A descrição explica o comportamento de cada parâmetro opcional e o que acontece quando ele é omitido, incluindo inferência da semana e seleção de turma aberta. Não há alternativas explícitas, mas o contexto de uso é claro e suficiente para um agente decidir quando chamar a ferramenta.

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