defineHarnessTool

Rôle et comportement

Définit un outil qu’un harness intégré propose au modèle. Valide immédiatement le nom, la description et le schéma d’entrée, et renvoie une définition figée dont validate() contrôle les arguments du modèle avant l’exécution de execute().

Exemple complet et règles détaillées.

Paramètres et propriétés

• optionsRequis
  HarnessToolOptions<Input>
  Nom, description, schéma d’entrée, indicateur de lecture seule, fonction resources et fonction execute de l’outil. Les clés inconnues sont refusées.
• options.nameRequis
  string
  Nom d’outil unique de 1 à 64 lettres, chiffres, tirets bas ou tirets, présenté au modèle.
• options.descriptionRequis
  string
  Explication non vide que le modèle lit pour décider quand et comment appeler l’outil.
• options.inputRequis
  Readonly<Record<string, unknown>> | StandardJsonSchema<Input>
  Schéma d’entrée : un objet JSON Schema contrôlé par le sous-ensemble intégré (type, properties, required, additionalProperties, items, enum, const et bornes de longueur, de valeur et de nombre d’éléments), ou un Standard Schema qui exporte du JSON Schema, comme Zod 4. Les autres mots-clés sont refusés à la définition.
• options.readOnlyOptionnel
  boolean | undefined
  Marque un outil sans effet de bord, false par défaut. Les appels en lecture seule peuvent s’exécuter en parallèle, et les tours de réparation d’une réponse ne gardent que les outils en lecture seule.
• options.resourcesOptionnel
  ((input: Input) => ToolResources) | undefined
  Décrit les chemins et la commande d’une entrée validée pour que les règles de permission puissent les comparer. Un outil sans cette fonction n’est comparé que par son nom.
• options.executeRequis
  (input: Input, context: HarnessToolContext) => ToolOutput | Promise<ToolOutput>
  Exécute l’appel avec l’entrée validée et son contexte, et renvoie du texte ou { content, isError }. Une exception est traitée selon toolExecution.onError ; les résultats de plus de 100000 caractères sont coupés avant d’atteindre le modèle.

Retour

HarnessTool<Input>

Signature

export declare function defineHarnessTool<Input>(
  options: HarnessToolOptions<Input>,
): HarnessTool<Input>;

Contrats associés

• HarnessTool
• HarnessToolOptions