読み込み中

ツール用のJSONスキーマ

レッスン 235 分
読み込み中

ツール関数を作成したら、次のステップはそれを記述するJSONスキーマを書くことです。このスキーマは、Claudeに関数がどのような引数を期待し、どのように正しく使用するかを伝えます。設定は最初は難しく見えるかもしれませんが、プロセスを理解すれば実際には簡単です。

JSONスキーマを理解する

JSONスキーマはAIツールのために発明されたものではなく、何年も前からデータを検証するための標準的な方法として存在しています。このスキーマには2つの主要な部分があります。上部にある名前と説明(Claudeがツールをいつ使用すべきかを理解するのに役立ちます)と、関数の引数を記述する実際のスキーマです。

上部にname(名前)とdescription(説明)が枠で囲まれ、下部に"location"を必須とするinputSchemaが枠で囲まれたget_weather toolSpec。

上部のセクションには、ツールの名前と説明が含まれており、Claudeがそれをいつ使用すべきかを理解するのに役立ちます。下部のセクションは、関数の引数を詳細に記述する実際のスキーマです。

JSONスキーマの作成:ステップバイステップ

任意の関数に対してJSONスキーマを作成する最もシンプルな方法を紹介します。

ステップ1:サンプルデータを含む辞書を書く

関数を取り、すべてのキーワード引数をサンプルデータとともに辞書にまとめます。例えば、次のような関数があるとします。

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

サンプル値を持つ辞書を作成します。

process_data用の辞書: "ids"は1を含むリスト、"profile"は"active"がTrue、"primary_id"は"abc"、"value"は20。

ステップ2:JSONに変換する

Pythonの辞書を適切なJSON形式に変換します。主な違いは、PythonのTrueをJSONのtrueに変更することです。

ステップ1の辞書をJSONにしたもの。値はids 1、primary_id "abc"、value 20と同じですが、"active"は小文字のtrueになっています。

ステップ3:オンラインコンバーターを使う

「JSON to JSON Schema converter」を検索し、多数ある無料のオンラインツールのいずれかを使用します。JSONデータを貼り付けると、自動的にスキーマが生成されます。

オンラインのJSON to JSON Schemaコンバーター: 貼り付けられたサンプルJSON、Generate Schemaボタン、その下に推論されたスキーマ。

このツールはサンプルデータを解析し、適切なスキーマ構造を作成します。出力から$schema宣言は削除してください。これは必要ありません。

ステップ4:説明を追加する

最も重要なステップは、各プロパティに詳細な説明を追加することです。これらの説明は、各引数が何をするものか、どのように使用すべきかをClaudeが正確に理解するのに役立ちます。

JSONスキーマで、数値のids配列とprimary_id文字列のそれぞれに、3つのドットが設定された"description"キーが追加されている。

良い説明を書く

ツールやプロパティの説明を書く際には、以下のベストプラクティスに従ってください。

  • ツールが何をするのか、いつ使用するのか、何を返すのかを説明する
  • ツールの説明は3〜4文を目安にする
  • 各プロパティについては非常に詳細な説明を提供する
  • 行き詰まったら、関数をClaudeに貼り付けて説明を書いてもらうよう依頼する

よく説明されたツールスキーマの例を示します。

get_weatherのJSONスキーマ。温度、天候、湿度を返し、"London,UK"のような"location"を必須としている。

この説明が、天気ツールが何をするのか、いつ使用するのか、どのようなデータを返すのかを明確に説明し、有効な地名形式の具体例を提供していることに注目してください。

すべてをまとめる

最終的なJSONスキーマは、このような構造になるはずです。toolSpecには名前、説明、そして詳細な引数仕様を持つinputSchemaが含まれます。

get_weather toolSpecスキーマ: 名前、複数文からなる説明、そして必須のlocation文字列を持つinputSchema。

このスキーマは、あなたのコードとClaudeの間の契約として機能し、Claudeがあなたのツールを使用することを決定したとき、どのような情報をどのような形式で提供すべきかを正確に把握できるようにします。この明確なコミュニケーションが、ツール使用を信頼性が高く効果的なものにしているのです。