Wird geladen

JSON-Schema für Tools

Lektion 235 Min.
Wird geladen

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. Auch wenn die Konfiguration zunächst einschüchternd wirken mag, ist sie tatsächlich unkompliziert, sobald du den Prozess verstanden hast.

JSON-Schema verstehen

JSON-Schema wurde nicht nur für KI-Tools erfunden – 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) sowie dem eigentlichen Schema, das die Argumente der Funktion beschreibt.

Eine get_weather-toolSpec mit ihrem Namen und ihrer Beschreibung oben eingerahmt und einem inputSchema darunter, das "location" erfordert.

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 mit allen Keyword-Argumenten samt 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:

Dictionary für process_data: "ids" ist eine Liste mit 1, "profile" hat "active" True, "primary_id" ist "abc", "value" ist 20.

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.

Das Dictionary aus Schritt 1 als JSON, gleiche Werte mit ids 1, primary_id "abc" und value 20, außer dass "active" jetzt klein geschrieben true ist.

Schritt 3: Verwende einen Online-Konverter

Suche nach "JSON zu JSON Schema Konverter" und verwende eines der vielen kostenlosen Online-Tools. Füge deine JSON-Daten ein und lass es das Schema automatisch generieren.

Online-JSON-zu-JSON-Schema-Konverter: die eingefügten Beispiel-JSON-Daten, eine Schaltfläche "Generate Schema" und das daraus abgeleitete Schema darunter.

Das Tool analysiert deine Beispieldaten und erstellt eine passende Schemastruktur. Entferne alle $schema-Deklarationen aus der Ausgabe – du benötigst 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.

JSON-Schema, bei dem das ids-Array aus Zahlen und der primary_id-String jeweils einen "description"-Schlüssel erhalten, der auf drei Punkte gesetzt ist.

Gute Beschreibungen schreiben

Befolge 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
  • Gib super detaillierte Beschreibungen für jede Eigenschaft
  • Wenn du nicht weiterweißt, füge deine Funktion in Claude ein und bitte Claude, Beschreibungen für dich zu schreiben

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

JSON-Schema für get_weather, das Temperatur, Bedingungen und Luftfeuchtigkeit zurückgibt, mit einem erforderlichen "location" wie "London,UK".

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

Alles zusammenfügen

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

Das get_weather-toolSpec-Schema: Name, eine mehrsätzige Beschreibung und inputSchema mit einem erforderlichen location-String.

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