Mendefinisikan alat
Tentukan skema alat, tulis deskripsi yang efektif, dan kendalikan kapan Claude memanggil alat Anda.
Penggunaan berbeda menurut produk
tools permintaan, dan kirim hasilnya sebagai blok tool_result.type "custom"; panggilan tiba sebagai event agent.custom_tool_use.Prasyarat
- Pemahaman tentang ikhtisar penggunaan alat
- Kunci API Claude dan pengaturan SDK atau cURL yang berfungsi
Menentukan alat klien
“Client tools” (alat klien) ditentukan dalam parameter tingkat atas tools pada permintaan API. Alat klien berskema Anthropic, seperti alat bash dan editor teks, dideklarasikan dengan type berversi tanggal; lihat halaman masing-masing alat, yang ditautkan dari Referensi alat, untuk field yang diterimanya. Alat penggunaan komputer dan penggunaan browser adalah toolset klien: satu entri tanpa name yang mendeklarasikan sekumpulan alat anggota yang tetap. Definisi alat yang ditentukan pengguna mencakup:
| Parameter | Deskripsi |
|---|---|
name | Nama alat. Harus cocok dengan regex ^[a-zA-Z0-9_-]{1,128}$. |
description | Deskripsi teks biasa yang terperinci tentang apa yang dilakukan alat, kapan alat harus digunakan, dan bagaimana alat berperilaku. |
input_schema | Objek JSON Schema yang mendefinisikan parameter yang diharapkan untuk alat. |
input_examples | (Opsional) Array berisi objek input contoh yang menunjukkan kepada Claude cara menggunakan alat. Lihat Memberikan contoh penggunaan alat. |
Untuk kumpulan lengkap properti opsional yang tersedia pada setiap definisi alat tunggal, termasuk cache_control, strict, defer_loading, dan allowed_callers, lihat Properti definisi alat. Entri toolset klien menerima cache_control dan allowed_callers pada entri tersebut dan menetapkan defer_loading untuk setiap anggota; lihat Toolset klien.
{
"name": "get_weather",
"description": "Get the current weather in a given location",
"input_schema": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA"
},
"unit": {
"type": "string",
"enum": ["celsius", "fahrenheit"],
"description": "The unit of temperature, either 'celsius' or 'fahrenheit'"
}
},
"required": ["location"]
}
}Alat ini, bernama get_weather, mengharapkan objek input dengan string location yang wajib dan string unit opsional yang harus berupa celsius atau fahrenheit.
Prompt sistem penggunaan alat
Saat Anda memanggil Claude API dengan parameter tools, API menyusun “system prompt” (prompt sistem) khusus dari definisi alat, konfigurasi alat, dan prompt sistem apa pun yang ditentukan pengguna. Prompt yang disusun ini dirancang untuk menginstruksikan model agar menggunakan alat yang ditentukan dan menyediakan konteks yang diperlukan agar alat dapat beroperasi dengan benar:
In this environment you have access to a set of tools you can use to answer the user's question.
{{ FORMATTING INSTRUCTIONS }}
String and scalar parameters should be specified as is, while lists and objects should use JSON format. Note that spaces for string values are not stripped. The output is not expected to be valid XML and is parsed with regular expressions.
Here are the functions available in JSONSchema format:
{{ TOOL DEFINITIONS IN JSON SCHEMA }}
{{ USER SYSTEM PROMPT }}
{{ TOOL CONFIGURATION }}Praktik terbaik untuk definisi alat
Untuk mendapatkan kinerja terbaik dari Claude saat menggunakan alat, ikuti panduan berikut:
- Berikan deskripsi yang sangat terperinci. Ini sejauh ini merupakan faktor terpenting dalam kinerja alat. Deskripsi Anda harus menjelaskan setiap detail tentang alat, termasuk:
- Apa yang dilakukan alat
- Kapan alat harus digunakan (dan kapan tidak)
- Apa arti setiap parameter dan bagaimana pengaruhnya terhadap perilaku alat
- Peringatan atau batasan penting apa pun, seperti informasi apa yang tidak dikembalikan alat jika nama alat tidak jelas. Semakin banyak konteks yang dapat Anda berikan kepada Claude tentang alat Anda, semakin baik Claude dalam menentukan kapan dan bagaimana menggunakannya. Usahakan setidaknya 3–4 kalimat untuk setiap deskripsi alat, lebih banyak jika alatnya kompleks.
- Prioritaskan deskripsi, tetapi pertimbangkan penggunaan
input_examplesuntuk alat yang kompleks. Deskripsi yang jelas adalah yang paling penting, tetapi untuk alat dengan input kompleks, objek bersarang, atau parameter yang sensitif terhadap format, Anda dapat menggunakan fieldinput_examplesuntuk menyediakan contoh yang tervalidasi skema. Lihat Menyediakan contoh penggunaan alat untuk detailnya. - Gabungkan operasi terkait ke dalam lebih sedikit alat. Daripada membuat alat terpisah untuk setiap tindakan (
create_pr,review_pr,merge_pr), kelompokkan ke dalam satu alat dengan parameteraction. Alat yang lebih sedikit namun lebih mumpuni mengurangi ambiguitas pemilihan dan membuat permukaan alat Anda lebih mudah dinavigasi oleh Claude. - Gunakan namespace yang bermakna dalam nama alat. Ketika alat Anda mencakup beberapa layanan atau sumber daya, awali nama dengan layanannya (misalnya,
github_list_prs,slack_send_message). Ini membuat pemilihan alat tidak ambigu seiring bertambahnya pustaka Anda, dan sangat penting saat menggunakan pencarian alat. - Rancang respons alat agar hanya mengembalikan informasi bersinyal tinggi. Kembalikan pengenal yang semantik dan stabil (misalnya, slug atau UUID) daripada referensi internal yang tidak jelas, dan sertakan hanya field yang dibutuhkan Claude untuk menalar langkah berikutnya. Respons yang membengkak membuang konteks dan mempersulit Claude mengekstrak hal yang penting.
- Minta penjelasan, bukan penalaran. Jika sebuah parameter menanyakan kepada Claude mengapa ia melakukan panggilan tersebut, mintalah penjelasan singkat atau bukti pendukung. Parameter yang meminta pemikiran model atau penalaran langkah demi langkah dapat menyebabkan penolakan
reasoning_extraction. Lihat Simpan penalaran di blok thinking.
{
"name": "get_stock_price",
"description": "Retrieves the current stock price for a given ticker symbol. The ticker symbol must be a valid symbol for a publicly traded company on a major US stock exchange like NYSE or NASDAQ. The tool will return the latest trade price in USD. It should be used when the user asks about the current or most recent price of a specific stock. It will not provide any other information about the stock or company.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string",
"description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
}
},
"required": ["ticker"]
}
}{
"name": "get_stock_price",
"description": "Gets the stock price for a ticker.",
"input_schema": {
"type": "object",
"properties": {
"ticker": {
"type": "string"
}
},
"required": ["ticker"]
}
}Deskripsi yang baik menjelaskan dengan jelas apa yang dilakukan alat, kapan menggunakannya, data apa yang dikembalikan, dan apa arti parameter ticker. Deskripsi yang buruk terlalu singkat dan meninggalkan banyak pertanyaan terbuka bagi Claude tentang perilaku dan penggunaan alat.
Menyediakan contoh penggunaan alat
Anda dapat memberikan contoh konkret input alat yang valid untuk menunjukkan kepada Claude cara menggunakan alat Anda secara lebih efektif. Ini sangat berguna untuk alat kompleks dengan objek bersarang, parameter opsional, atau input yang sensitif terhadap format.
Penggunaan dasar
Tambahkan field input_examples opsional ke definisi alat Anda dengan array objek input contoh. Setiap contoh harus valid sesuai dengan input_schema alat:
client = anthropic.Anthropic()
response = client.messages.create(
model="claude-opus-5-5",
max_tokens=1024,
tools=[
{
"name": "get_weather",
"description": "Get the current weather in a given location",
"input_schema": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA",
},
"unit": {
"type": "string",
"enum": ["celsius", "fahrenheit"],
"description": "The unit of temperature",
},
},
"required": ["location"],
},
"input_examples": [
{"location": "San Francisco, CA", "unit": "fahrenheit"},
{"location": "Tokyo, Japan", "unit": "celsius"},
{
"location": "New York, NY" # 'unit' is optional
},
],
}
],
messages=[{"role": "user", "content": "What's the weather like in San Francisco?"}],
)
print(response)Contoh disertakan dalam prompt bersama skema alat Anda, menunjukkan kepada Claude pola konkret untuk panggilan alat yang tersusun dengan baik. Pola-pola ini menunjukkan kapan harus menyertakan parameter opsional, format apa yang digunakan, dan bagaimana menyusun input yang kompleks.
Persyaratan dan batasan
- Contoh yang valid: Validasi sendiri setiap contoh terhadap
input_schemaalat. API biasanya mengembalikan error 400 untuk contoh yang tidak valid. Dalam beberapa kasus, seperti skema denganpattern, API melewati pemeriksaan tersebut dan Claude melihat contoh yang tidak valid. - Alat yang didukung: Contoh input berfungsi pada alat yang ditentukan pengguna dan beberapa alat klien dengan skema Anthropic. Untuk memeriksa jenis alat mana yang menerimanya, lihat baris
input_examplespada tabel Properti definisi alat di referensi alat. - Biaya token: Setiap contoh menambah token input: sekitar 100 untuk contoh dengan beberapa nilai datar dan sekitar 200 untuk contoh dengan objek bersarang.
Mengendalikan output Claude
Memaksa penggunaan alat
Dalam beberapa kasus, Anda mungkin ingin Claude menggunakan alat tertentu untuk menjawab pertanyaan pengguna, meskipun Claude sebenarnya akan menjawab langsung tanpa memanggil alat. Anda dapat melakukan ini dengan menentukan alat di bidang tool_choice pada permintaan.
Tidak semua model dan pengaturan mendukung penggunaan alat yang dipaksakan. Jika tidak didukung, tool_choice: {"type": "any"} dan tool_choice: {"type": "tool", "name": "..."} akan gagal, sedangkan tool_choice: {"type": "auto"} (default) dan tool_choice: {"type": "none"} tetap berfungsi:
| Model atau pengaturan | Batasan | Alternatif yang dapat digunakan |
|---|---|---|
Pemikiran diperpanjang manual (thinking: {type: "enabled"}) | any dan tool tidak didukung dan menghasilkan error | auto atau none. Pemikiran adaptif sendiri tidak memblokir penggunaan alat paksa (model dengan thinking aktif secara default, seperti Claude Opus 5 dan Claude Haiku 5.5, menerimanya, tetapi panggilan yang dipaksakan melewati thinking: respons dimulai dengan panggilan alat dan tidak memiliki blok thinking); model di baris berikutnya menolak penggunaan alat paksa terlepas dari pengaturan thinking |
| Claude Fable 5.2, Claude Mythos 5.2, Claude Opus 5.5, Claude Sonnet 5.5, Claude Fable 5.1, dan Claude Mythos 5.1 | any dan tool mengembalikan error 400. Lihat Penggunaan alat paksa tidak didukung | auto dengan penggunaan alat ketat untuk menjamin input alat yang valid sesuai skema, atau output terstruktur ketika Anda membutuhkan respons dalam bentuk JSON yang tetap. Prompting tetap memengaruhi alat mana yang dipilih oleh auto. none juga didukung |
Pada model yang mendukungnya, baris yang disorot adalah satu-satunya perbedaan dari permintaan penggunaan alat standar:
client = anthropic.Anthropic()
tools = [
{
"name": "get_weather",
"description": "Get the current weather in a given location",
"input_schema": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. San Francisco, CA",
}
},
"required": ["location"],
},
}
]
response = client.messages.create(
model="claude-opus-5",
max_tokens=1024,
tools=tools,
tool_choice={"type": "tool", "name": "get_weather"},
messages=[{"role": "user", "content": "What's the weather like in San Francisco?"}],
)
print(response)Saat bekerja dengan parameter tool_choice, ada empat opsi yang mungkin:
automemungkinkan Claude menentukan apakah akan memanggil alat yang disediakan. Ini adalah nilai default ketikatoolsdisediakan.anymemberi tahu Claude bahwa ia harus menggunakan salah satu alat yang disediakan, tetapi tidak memaksa alat tertentu.toolmemaksa Claude untuk selalu menggunakan alat tertentu.nonemencegah Claude menggunakan alat apa pun. Ini adalah nilai default ketika tidak adatoolsyang disediakan.
Diagram ini menunjukkan cara kerja opsi auto, any, dan tool:
Ketika tool_choice adalah any atau tool, API membuat respons Claude dimulai dengan panggilan alat. Akibatnya, Claude tidak mengeluarkan respons atau penjelasan bahasa alami sebelum blok konten tool_use, meskipun Anda memintanya.
Pengujian menunjukkan bahwa hal ini seharusnya tidak mengurangi kinerja. Jika Anda ingin model memberikan konteks atau penjelasan bahasa alami sambil tetap meminta model menggunakan alat tertentu, Anda dapat menggunakan {"type": "auto"} untuk tool_choice (default) dan menambahkan instruksi eksplisit dalam pesan user. Misalnya: What's the weather like in London? Use the get_weather tool in your response.
Memaksa alat juga melewati thinking pada setiap model yang menerima penggunaan alat paksa: respons dimulai dengan blok tool_use dan tidak memiliki blok thinking. Agar model dapat berpikir sebelum memanggil alat, gunakan auto dengan instruksi prompt dengan cara yang sama.
Respons model dengan alat
Saat menggunakan alat, Claude sering mengomentari apa yang sedang dilakukannya atau merespons pengguna secara alami sebelum memanggil alat.
Misalnya, dengan prompt “What’s the weather like in San Francisco right now, and what time is it there?”, Claude mungkin merespons dengan:
{
"role": "assistant",
"content": [
{
"type": "text",
"text": "I'll help you check the current weather and time in San Francisco."
},
{
"type": "tool_use",
"id": "toolu_01A09q90qw90lq917835lq9",
"name": "get_weather",
"input": { "location": "San Francisco, CA" }
}
]
}Gaya respons alami ini membantu pengguna memahami apa yang dilakukan Claude dan menciptakan interaksi yang lebih bersifat percakapan. Anda dapat mengarahkan gaya dan isi respons ini melalui prompt sistem Anda dan dengan menyediakan <examples> dalam prompt Anda.
Penting untuk dicatat bahwa Claude mungkin menggunakan berbagai susunan kalimat dan pendekatan saat menjelaskan tindakannya. Kode Anda harus memperlakukan respons ini seperti teks lain yang dihasilkan asisten, dan tidak bergantung pada konvensi pemformatan tertentu.
Langkah selanjutnya
Parsing blok tool_use dan format respons tool_result.
Biarkan SDK menangani loop agentik secara otomatis.
Direktori alat yang disediakan Anthropic dan properti opsional.
Ketersediaan
Claude API
- API
- Messages API
- Managed Agents
- Model
- Semua model
Amazon Bedrock
- API
- Messages API
- Model
- Semua model
Amazon Bedrock (bedrock-runtime)
- API
- Messages API
- Model
- Semua model
Claude Platform on AWS
- API
- Messages API
- Managed Agents
- Model
- Semua model
Claude Models on Google Cloud (Anthropic managed)
- API
- Messages API
- Model
- Semua model
Claude Models on Google Cloud (Google managed)
- API
- Messages API
- Model
- Semua model
Microsoft Foundry
- API
- Messages API
- Model
- Semua model
Apakah halaman ini membantu?