Après avoir créé votre fonction d'outil, l'étape suivante consiste à écrire un schéma JSON pour la décrire. Ce schéma indique à Claude quels arguments votre fonction attend et comment l'utiliser correctement. Bien que la configuration puisse sembler intimidante au premier abord, c'est en fait simple une fois que vous comprenez le processus.
Comprendre le JSON Schema
Le JSON Schema n'est pas quelque chose inventé uniquement pour les outils d'IA - il existe depuis des années comme moyen standard de valider des données. Le schéma comporte deux parties principales : le nom et la description en haut (qui aident Claude à comprendre quand utiliser l'outil), et le schéma proprement dit qui décrit les arguments de la fonction.
La section supérieure contient le nom et la description de l'outil, ce qui aide Claude à comprendre quand l'utiliser. La section inférieure est le schéma proprement dit qui décrit en détail les arguments de votre fonction.
Créer un JSON Schema : étape par étape
Voici la manière la plus simple de créer un schéma JSON pour n'importe quelle fonction :
Étape 1 : Écrire un dictionnaire avec des données d'exemple
Prenez votre fonction et créez un dictionnaire de tous les arguments nommés avec des données d'exemple. Par exemple, si vous avez une fonction comme celle-ci :
def process_data(ids, profile, primary_id, value):
passCréez un dictionnaire avec des valeurs d'exemple :
Étape 2 : Convertir en JSON
Convertissez votre dictionnaire Python au format JSON approprié. La principale différence est de changer le True de Python en true de JSON.
Étape 3 : Utiliser un convertisseur en ligne
Recherchez « JSON to JSON Schema converter » et utilisez l'un des nombreux outils gratuits en ligne. Collez vos données JSON et laissez-le générer le schéma automatiquement.
L'outil analysera vos données d'exemple et créera une structure de schéma appropriée. Supprimez toute déclaration $schema de la sortie - vous n'en avez pas besoin.
Étape 4 : Ajouter des descriptions
L'étape la plus importante consiste à ajouter des descriptions détaillées à chaque propriété. Ces descriptions aident Claude à comprendre exactement ce que fait chaque argument et comment l'utiliser.
Écrire de bonnes descriptions
Lorsque vous écrivez des descriptions pour vos outils et propriétés, suivez ces bonnes pratiques :
- Expliquez ce que fait l'outil, quand l'utiliser et ce qu'il renvoie
- Visez 3 à 4 phrases dans la description de votre outil
- Fournissez des descriptions super détaillées pour chaque propriété
- Si vous êtes bloqué, collez votre fonction dans Claude et demandez-lui d'écrire les descriptions pour vous
Voici un exemple de schéma d'outil bien décrit :
Remarquez comment la description explique clairement ce que fait l'outil météo, quand l'utiliser, quelles données il renvoie, et fournit des exemples spécifiques de formats de localisation valides.
Assembler le tout
Votre schéma JSON final devrait ressembler à cette structure, avec le toolSpec contenant le nom, la description, et inputSchema avec les spécifications détaillées des arguments :
Le schéma agit comme un contrat entre votre code et Claude, garantissant que lorsque Claude décide d'utiliser votre outil, il sait exactement quelles informations fournir et dans quel format. Cette communication claire est ce qui rend l'utilisation d'outils fiable et efficace.