tools
トップレベルパラメータで指定されます。各ツール定義には以下が含まれます:
パラメータ | 説明 |
---|---|
name | ツールの名前。正規表現 ^[a-zA-Z0-9_-]{1,64}$ に一致する必要があります。 |
description | ツールが何をするか、いつ使用すべきか、どのように動作するかの詳細なプレーンテキストの説明。 |
input_schema | ツールの期待されるパラメータを定義する JSON Schema オブジェクト。 |
シンプルなツール定義の例
get_weather
は、必須の location
文字列と、“celsius” または “fahrenheit” のいずれかでなければならないオプションの unit
文字列を含む入力オブジェクトを期待します。tools
パラメータを使用して Anthropic API を呼び出すと、ツール定義、ツール設定、およびユーザー指定のシステムプロンプトから特別なシステムプロンプトを構築します。構築されたプロンプトは、指定されたツールを使用し、ツールが適切に動作するために必要なコンテキストを提供するようにモデルに指示するように設計されています:
良いツール説明の例
悪いツール説明の例
ticker
パラメータが何を意味するかを明確に説明しています。悪い説明は簡潔すぎて、Claude にツールの動作と使用法について多くの未解決の質問を残しています。
tool_choice
フィールドでツールを指定することで実行できます:
auto
は、提供されたツールを呼び出すかどうかを Claude に決定させます。これは tools
が提供された場合のデフォルト値です。any
は、提供されたツールのいずれかを使用する必要があることを Claude に伝えますが、特定のツールを強制しません。tool
は、常に特定のツールを使用するように Claude を強制できます。none
は、Claude がツールを使用することを防ぎます。これは tools
が提供されていない場合のデフォルト値です。tool_choice
パラメータの変更はキャッシュされたメッセージブロックを無効にします。ツール定義とシステムプロンプトはキャッシュされたままですが、メッセージコンテンツは再処理する必要があります。tool_choice
が any
または tool
の場合、ツールの使用を強制するためにアシスタントメッセージを事前入力することに注意してください。これは、明示的に要求された場合でも、モデルが tool_use
コンテンツブロックの前に思考の連鎖 text
コンテンツブロックを出力しないことを意味します。
tool_choice: {"type": "any"}
と tool_choice: {"type": "tool", "name": "..."}
はサポートされておらず、エラーが発生します。拡張思考と互換性があるのは tool_choice: {"type": "auto"}
(デフォルト)と tool_choice: {"type": "none"}
のみです。tool_choice
に {"type": "auto"}
(デフォルト)を使用し、user
メッセージに明示的な指示を追加できます。例:ロンドンの天気はどうですか?応答でget_weatherツールを使用してください。
record_summary
ツールを使用する場合があります。完全な動作例については、Claude でのツール使用を参照してください。
tool_choice
が auto
に設定されている場合にこれを行います(これはデフォルト値です。ツール使用の強制を参照)。Sonnet と Haiku はプロンプトでこれを行うように促すことができます。
例えば、「サンフランシスコの現在の天気はどうで、そこの時間は何時ですか?」というプロンプトが与えられた場合、Claude は次のように応答する場合があります:
auto
の場合に disable_parallel_tool_use=true
を設定すると、Claude が最大1つのツールを使用することが保証されますany
または tool
の場合に disable_parallel_tool_use=true
を設定すると、Claude が正確に1つのツールを使用することが保証されます完全な並列ツール使用の例
並列ツールの完全なテストスクリプト
並列ツール使用のシステムプロンプト
ユーザーメッセージプロンプト
disable_parallel_tool_use
を設定していない場合でも、応答で並列ツール呼び出しを行う可能性が低い場合があります。これを回避するために、トークン効率的ツール使用を有効にすることをお勧めします。これにより、Claude が並列ツールを使用することが促進されます。このベータ機能は、レイテンシを削減し、出力トークンを平均14%節約します。トークン効率的ツール使用ベータにオプトインしたくない場合は、他のツールへの呼び出しを同時にラップするメタツールとして機能する「バッチツール」を導入することもできます。このツールが存在する場合、モデルはそれを使用して複数のツールを並列で同時に呼び出すことがわかります。この回避策の使用方法については、クックブックのこの例を参照してください。tool_use
の stop_reason
と、以下を含む1つ以上の tool_use
コンテンツブロックがあります:
id
:この特定のツール使用ブロックの一意の識別子。これは後でツール結果をマッチアップするために使用されます。name
:使用されているツールの名前。input
:ツールの input_schema
に準拠して、ツールに渡される入力を含むオブジェクト。`tool_use` コンテンツブロックを含むAPI応答の例
tool_use
ブロックから name
、id
、input
を抽出します。input
を渡します。user
の role
と、tool_result
タイプと以下の情報を含む content
ブロックを持つ新しいメッセージを送信して会話を続けます:
tool_use_id
:これが結果となるツール使用リクエストの id
。content
:文字列としてのツールの結果(例:"content": "15度"
)、ネストされたコンテンツブロックのリスト(例:"content": [{"type": "text", "text": "15度"}]
)、またはドキュメントブロックのリスト(例:"content": ["type": "document", "source": {"type": "text", "media_type": "text/plain", "data": "15度"}]
)。これらのコンテンツブロックは text
、image
、または document
タイプを使用できます。is_error
(オプション):ツール実行がエラーになった場合は true
に設定します。成功したツール結果の例
画像を含むツール結果の例
空のツール結果の例
ドキュメントを含むツール結果の例
tool
や function
などの特別な役割を使用する API とは異なり、Anthropic の API はツールを user
と assistant
メッセージ構造に直接統合します。メッセージには text
、image
、tool_use
、tool_result
ブロックの配列が含まれます。user
メッセージにはクライアントコンテンツと tool_result
が含まれ、assistant
メッセージには AI 生成コンテンツと tool_use
が含まれます。max_tokens
停止理由の処理max_tokens
制限に達したために切り捨てられ、切り捨てられた応答に不完全なツール使用ブロックが含まれている場合、完全なツール使用を取得するために、より高い max_tokens
値でリクエストを再試行する必要があります。
pause_turn
停止理由の処理pause_turn
停止理由を返すことがあり、これは API が長時間実行されるターンを一時停止したことを示します。
pause_turn
停止理由を処理する方法は次のとおりです:
pause_turn
を処理する場合:
ツール実行エラー
"is_error": true
と共に content
でエラーメッセージを返すことができます:無効なツール名
description
値を使用してリクエストを再試行することです。ただし、エラーを示す tool_result
で会話を前進させることもでき、Claude は不足している情報を埋めてツールを再度使用しようとします:<search_quality_reflection> タグ
サーバーツールエラー
is_error
結果を処理する必要はありません。ウェブ検索に関して、可能なエラーコードには以下が含まれます:too_many_requests
:レート制限を超過invalid_input
:無効な検索クエリパラメータmax_uses_exceeded
:最大ウェブ検索ツール使用回数を超過query_too_long
:クエリが最大長を超過unavailable
:内部エラーが発生並列ツール呼び出しが機能しない