Claude Academy
Wird geladen

JSON-Schema für Tools

Lektion 235 Min.

Nachdem du deine Tool-Funktion erstellt hast, besteht der nächste Schritt darin, ein JSON-Schema zu schreiben, das sie beschreibt. Dieses Schema sagt Claude, welche Argumente deine Funktion erwartet und wie sie richtig zu verwenden ist. Obwohl die Konfiguration auf den ersten Blick einschüchternd wirken mag, ist sie tatsächlich unkompliziert, sobald du den Prozess verstanden hast.

JSON-Schema verstehen

JSON-Schema ist nicht etwas, das eigens für KI-Tools erfunden wurde - es gibt es schon seit Jahren als Standardmethode zur Validierung von Daten. Das Schema besteht aus zwei Hauptteilen: dem Namen und der Beschreibung oben (die Claude helfen zu verstehen, wann das Tool zu verwenden ist) und dem eigentlichen Schema, das die Argumente der Funktion beschreibt.

Der obere Abschnitt enthält den Namen und die Beschreibung des Tools, die Claude helfen zu verstehen, wann es zu verwenden ist. Der untere Abschnitt ist das eigentliche Schema, das die Argumente deiner Funktion im Detail beschreibt.

Ein JSON-Schema erstellen: Schritt für Schritt

Hier ist der einfachste Weg, ein JSON-Schema für jede Funktion zu erstellen:

Schritt 1: Schreibe ein Dictionary mit Beispieldaten

Nimm deine Funktion und erstelle ein Dictionary aller Keyword-Argumente mit Beispieldaten. Wenn du zum Beispiel eine Funktion wie diese hast:

python
def process_data(ids, profile, primary_id, value):
    pass

Erstelle ein Dictionary mit Beispielwerten:

Schritt 2: In JSON umwandeln

Wandle dein Python-Dictionary in das richtige JSON-Format um. Der Hauptunterschied besteht darin, Pythons True in JSONs true zu ändern.

Schritt 3: Verwende einen Online-Konverter

Suche nach „JSON to JSON Schema converter" und verwende eines der vielen kostenlosen Online-Tools. Füge deine JSON-Daten ein und lass das Tool das Schema automatisch generieren.

Das Tool analysiert deine Beispieldaten und erstellt eine passende Schemastruktur. Entferne alle $schema-Deklarationen aus der Ausgabe - du brauchst sie nicht.

Schritt 4: Beschreibungen hinzufügen

Der wichtigste Schritt ist das Hinzufügen detaillierter Beschreibungen zu jeder Eigenschaft. Diese Beschreibungen helfen Claude zu verstehen, was genau jedes Argument bewirkt und wie es zu verwenden ist.

Gute Beschreibungen schreiben

Beachte beim Schreiben von Beschreibungen für deine Tools und Eigenschaften diese Best Practices:

  • Erkläre, was das Tool macht, wann es zu verwenden ist und was es zurückgibt
  • Strebe 3-4 Sätze in deiner Tool-Beschreibung an
  • Liefere super detaillierte Beschreibungen für jede Eigenschaft
  • Wenn du nicht weiterkommst, füge deine Funktion in Claude ein und bitte es, Beschreibungen für dich zu schreiben

Hier ist ein Beispiel für ein gut beschriebenes Tool-Schema:

Beachte, wie die Beschreibung klar erklärt, was das Wetter-Tool macht, wann es zu verwenden ist, welche Daten es zurückgibt, und spezifische Beispiele für gültige Standortformate liefert.

Alles zusammenfügen

Dein endgültiges JSON-Schema sollte etwa so aussehen, wobei toolSpec den Namen, die Beschreibung und inputSchema mit den detaillierten Argumentspezifikationen enthält:

Das Schema fungiert als Vertrag zwischen deinem Code und Claude und stellt sicher, dass Claude, wenn es sich entscheidet, dein Tool zu verwenden, genau weiß, welche Informationen es in welchem Format bereitstellen muss. Diese klare Kommunikation ist es, was die Tool-Nutzung zuverlässig und effektiv macht.