Esquemas de saída para clientes

Uma ferramenta estruturada também pode anunciar um esquema de saída: um esquema JSON que informa aos clientes exatamente quais campos e tipos esperar.

É uma descrição legível por máquina do seu resultado, listando o nome e o tipo de cada campo. Os clientes leem isso antes de chamar a ferramenta.

Quando você retorna um modelo Pydantic, o SDK deriva o esquema de saída para você. Suas anotações de tipo tornam-se automaticamente o contrato publicado.

O esquema acompanha a listagem da ferramenta, no campo outputSchema. Um cliente que inspeciona as ferramentas aprende o formato sem precisar fazer tentativas e cometer erros.

Com um esquema conhecido, um cliente pode validar resultados e criar a interface antecipadamente. Não é preciso adivinhar quais campos aparecerão.

O esquema marca temp_c como um número e condition como uma cadeia de caracteres. Os consumidores confiam nesses tipos em vez de inferi-los a partir de uma única amostra.

Campos com valores padrão se tornam opcionais no esquema; os demais são obrigatórios. Os clientes aprendem quais chaves têm presença garantida.

Trate o esquema de saída como uma promessa. Depois que os clientes passam a depender dele, alterar nomes ou tipos de campos pode quebrá-los posteriormente.

Clientes rigorosos validam cada resultado em relação ao esquema e rejeitam incompatibilidades. Isso detecta rapidamente erros do servidor, logo na fronteira.

Um esquema de saída também funciona como documentação. Novos desenvolvedores leem o esquema para entender uma ferramenta sem precisar vasculhar seu código.

Certifique-se de que sua ferramenta sempre retorne o que o esquema declara. Um resultado que se afasta do próprio esquema enfraquece a confiança que os clientes depositam nele.

Você viu como uma ferramenta publica um esquema de saída a partir do seu modelo. Ele documenta campos, permite validações e forma um contrato estável. ✅