Cara mengimplementasikan penggunaan alat

Memilih model

Kami merekomendasikan menggunakan model Claude Opus terbaru (4.6) untuk alat kompleks dan kueri yang ambigu; model ini menangani beberapa alat dengan lebih baik dan mencari klarifikasi saat diperlukan.

Gunakan model Claude Haiku untuk alat yang sederhana, tetapi perhatikan bahwa mereka mungkin menyimpulkan parameter yang hilang.

Jika menggunakan Claude dengan penggunaan alat dan pemikiran yang diperluas, lihat panduan pemikiran yang diperluas untuk informasi lebih lanjut.

Menentukan alat klien

Alat klien (baik yang ditentukan Anthropic maupun yang ditentukan pengguna) ditentukan dalam parameter tingkat atas tools dari permintaan API. Setiap definisi alat mencakup:

Parameter	Deskripsi
`name`	Nama alat. Harus cocok dengan regex `^[a-zA-Z0-9_-]{1,64}$`.
`description`	Deskripsi plaintext terperinci tentang apa yang dilakukan alat, kapan harus digunakan, dan bagaimana perilakunya.
`input_schema`	Objek JSON Schema yang mendefinisikan parameter yang diharapkan untuk alat.
`input_examples`	(Opsional) Larik objek input contoh untuk membantu Claude memahami cara menggunakan alat. Lihat Memberikan contoh penggunaan alat.

Prompt sistem penggunaan alat

Ketika Anda memanggil API Claude dengan parameter tools, kami membuat prompt sistem khusus dari definisi alat, konfigurasi alat, dan prompt sistem yang ditentukan pengguna. Prompt yang dibangun dirancang untuk menginstruksikan model menggunakan alat yang ditentukan dan memberikan konteks yang diperlukan agar alat beroperasi dengan baik:

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 ini:

Berikan deskripsi yang sangat terperinci. Ini adalah faktor paling penting dalam kinerja alat. Deskripsi Anda harus menjelaskan setiap detail tentang alat, termasuk:
- Apa yang dilakukan alat
- Kapan harus digunakan (dan kapan tidak boleh)
- Apa arti setiap parameter dan bagaimana pengaruhnya terhadap perilaku alat
- Peringatan atau batasan penting, seperti informasi apa yang tidak dikembalikan alat jika nama alat tidak jelas. Semakin banyak konteks yang dapat Anda berikan Claude tentang alat Anda, semakin baik dalam memutuskan kapan dan bagaimana menggunakannya. Targetkan setidaknya 3-4 kalimat per deskripsi alat, lebih banyak jika alat kompleks.
Prioritaskan deskripsi, tetapi pertimbangkan menggunakan input_examples untuk alat kompleks. Deskripsi yang jelas paling penting, tetapi untuk alat dengan input kompleks, objek bersarang, atau parameter sensitif format, Anda dapat menggunakan bidang input_examples untuk memberikan contoh yang divalidasi skema. Lihat Memberikan contoh penggunaan alat untuk detail.

Deskripsi yang baik dengan jelas menjelaskan apa yang dilakukan alat, kapan menggunakannya, data apa yang dikembalikan, dan apa arti parameter ticker. Deskripsi yang buruk terlalu singkat dan meninggalkan Claude dengan banyak pertanyaan terbuka tentang perilaku dan penggunaan alat.

Memberikan contoh penggunaan alat

Anda dapat memberikan contoh konkret input alat yang valid untuk membantu Claude memahami cara menggunakan alat Anda dengan lebih efektif. Ini sangat berguna untuk alat kompleks dengan objek bersarang, parameter opsional, atau input sensitif format.

Penggunaan dasar

Tambahkan bidang input_examples opsional ke definisi alat Anda dengan larik objek input contoh. Setiap contoh harus valid sesuai dengan input_schema alat:

Contoh disertakan dalam prompt bersama skema alat Anda, menunjukkan Claude pola konkret untuk panggilan alat yang terbentuk dengan baik. Ini membantu Claude memahami kapan harus menyertakan parameter opsional, format apa yang harus digunakan, dan cara menyusun input kompleks.

Persyaratan dan batasan

Validasi skema - Setiap contoh harus valid sesuai dengan input_schema alat. Contoh yang tidak valid mengembalikan kesalahan 400
Tidak didukung untuk alat sisi server - Hanya alat yang ditentukan pengguna yang dapat memiliki contoh input
Biaya token - Contoh menambah token prompt: ~20-50 token untuk contoh sederhana, ~100-200 token untuk objek bersarang kompleks

Pelari alat (beta)

Pelari alat menyediakan solusi siap pakai untuk menjalankan alat dengan Claude. Alih-alih menangani panggilan alat, hasil alat, dan manajemen percakapan secara manual, pelari alat secara otomatis:

Menjalankan alat ketika Claude memanggilnya
Menangani siklus permintaan/respons
Mengelola status percakapan
Menyediakan keamanan tipe dan validasi

Kami merekomendasikan agar Anda menggunakan pelari alat untuk sebagian besar implementasi penggunaan alat.

Pelari alat saat ini dalam beta dan tersedia di SDK Python, TypeScript, dan Ruby.

Manajemen konteks otomatis dengan pemadatan

Pelari alat mendukung pemadatan otomatis, yang menghasilkan ringkasan ketika penggunaan token melebihi ambang batas. Ini memungkinkan tugas agentic jangka panjang untuk melanjutkan melampaui batas jendela konteks.

Penggunaan dasar

Tentukan alat menggunakan pembantu SDK, kemudian gunakan pelari alat untuk menjalankannya.

Fungsi alat harus mengembalikan blok konten atau larik blok konten, termasuk teks, gambar, atau blok dokumen. Ini memungkinkan alat untuk mengembalikan respons multimodal yang kaya. String yang dikembalikan akan dikonversi ke blok konten teks. Jika Anda ingin mengembalikan objek JSON terstruktur ke Claude, enkode ke string JSON sebelum mengembalikannya. Angka, boolean, atau primitif non-string lainnya juga harus dikonversi ke string.

Iterasi di atas pelari alat

Pelari alat adalah iterable yang menghasilkan pesan dari Claude. Ini sering disebut sebagai "tool call loop". Setiap iterasi, pelari memeriksa apakah Claude meminta penggunaan alat. Jika ya, ia memanggil alat dan mengirim hasilnya kembali ke Claude secara otomatis, kemudian menghasilkan pesan berikutnya dari Claude untuk melanjutkan loop Anda.

Anda dapat mengakhiri loop pada iterasi apa pun dengan pernyataan break. Pelari akan berulang sampai Claude mengembalikan pesan tanpa penggunaan alat.

Jika Anda tidak memerlukan pesan perantara, Anda dapat mendapatkan pesan akhir secara langsung:

Penggunaan lanjutan

Dalam loop, Anda dapat sepenuhnya menyesuaikan permintaan berikutnya pelari alat ke API Pesan. Pelari secara otomatis menambahkan hasil alat ke riwayat pesan, jadi Anda tidak perlu mengelolanya secara manual. Anda dapat secara opsional memeriksa hasil alat untuk logging atau debugging, dan memodifikasi parameter permintaan sebelum panggilan API berikutnya.

Debugging eksekusi alat

Ketika alat melempar pengecualian, pelari alat menangkapnya dan mengembalikan kesalahan ke Claude sebagai hasil alat dengan is_error: true. Secara default, hanya pesan pengecualian yang disertakan, bukan stack trace lengkap.

Untuk melihat stack trace lengkap dan informasi debug, atur variabel lingkungan ANTHROPIC_LOG:

# View info-level logs including tool errors
export ANTHROPIC_LOG=info

# View debug-level logs for more verbose output
export ANTHROPIC_LOG=debug

Ketika diaktifkan, SDK mencatat detail pengecualian lengkap (menggunakan modul logging Python, konsol di TypeScript, atau logger Ruby), termasuk stack trace lengkap ketika alat gagal.

Mengintersepsi kesalahan alat

Secara default, kesalahan alat diteruskan kembali ke Claude, yang kemudian dapat merespons dengan tepat. Namun, Anda mungkin ingin mendeteksi kesalahan dan menanganinya secara berbeda—misalnya, untuk menghentikan eksekusi lebih awal atau menerapkan penanganan kesalahan khusus.

Gunakan metode respons alat untuk mengintersepsi hasil alat dan memeriksa kesalahan sebelum dikirim ke Claude:

Memodifikasi hasil alat

Anda dapat memodifikasi hasil alat sebelum dikirim kembali ke Claude. Ini berguna untuk menambahkan metadata seperti cache_control untuk mengaktifkan prompt caching pada hasil alat, atau untuk mengubah output alat.

Gunakan metode respons alat untuk mendapatkan hasil alat, memodifikasinya, kemudian tambahkan versi yang dimodifikasi ke pesan:

Menambahkan cache_control ke hasil alat sangat berguna ketika alat mengembalikan jumlah data besar (seperti hasil pencarian dokumen) yang ingin Anda cache untuk panggilan API berikutnya. Lihat Prompt caching untuk detail lebih lanjut tentang strategi caching.

Streaming

Aktifkan streaming untuk menerima acara saat tiba. Setiap iterasi menghasilkan objek stream yang dapat Anda iterasi untuk acara.

Pelari alat SDK dalam beta. Sisa dokumen ini mencakup implementasi alat manual.

Mengontrol output Claude

Memaksa penggunaan alat

Dalam beberapa kasus, Anda mungkin ingin Claude menggunakan alat tertentu untuk menjawab pertanyaan pengguna, bahkan jika Claude berpikir dapat memberikan jawaban tanpa menggunakan alat. Anda dapat melakukan ini dengan menentukan alat dalam bidang tool_choice seperti ini:

tool_choice = {"type": "tool", "name": "get_weather"}

Saat bekerja dengan parameter tool_choice, kami memiliki empat opsi yang mungkin:

auto memungkinkan Claude memutuskan apakah akan memanggil alat yang disediakan atau tidak. Ini adalah nilai default ketika tools disediakan.
any memberitahu Claude bahwa ia harus menggunakan salah satu alat yang disediakan, tetapi tidak memaksa alat tertentu.
tool memungkinkan kami memaksa Claude untuk selalu menggunakan alat tertentu.
none mencegah Claude menggunakan alat apa pun. Ini adalah nilai default ketika tidak ada tools yang disediakan.

Saat menggunakan prompt caching, perubahan pada parameter tool_choice akan membatalkan blok pesan yang di-cache. Definisi alat dan prompt sistem tetap di-cache, tetapi konten pesan harus diproses ulang.

Diagram ini mengilustrasikan cara kerja setiap opsi:

Perhatikan bahwa ketika Anda memiliki tool_choice sebagai any atau tool, kami akan mengisi pesan asisten sebelumnya untuk memaksa alat digunakan. Ini berarti model tidak akan mengeluarkan respons bahasa alami atau penjelasan sebelum blok konten tool_use, bahkan jika secara eksplisit diminta untuk melakukannya.

Saat menggunakan pemikiran yang diperluas dengan penggunaan alat, tool_choice: {"type": "any"} dan tool_choice: {"type": "tool", "name": "..."} tidak didukung dan akan menghasilkan kesalahan. Hanya tool_choice: {"type": "auto"} (default) dan tool_choice: {"type": "none"} yang kompatibel dengan pemikiran yang diperluas.

Pengujian kami menunjukkan bahwa ini seharusnya tidak mengurangi kinerja. Jika Anda ingin model memberikan konteks bahasa alami atau penjelasan 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.

Panggilan alat yang dijamin dengan alat ketat

Gabungkan tool_choice: {"type": "any"} dengan penggunaan alat ketat untuk menjamin bahwa salah satu alat Anda akan dipanggil DAN input alat akan mengikuti skema Anda dengan ketat. Atur strict: true pada definisi alat Anda untuk mengaktifkan validasi skema.

Output JSON

Alat tidak perlu menjadi fungsi klien — Anda dapat menggunakan alat kapan saja Anda ingin model mengembalikan output JSON yang mengikuti skema yang disediakan. Misalnya, Anda mungkin menggunakan alat record_summary dengan skema tertentu. Lihat Penggunaan alat dengan Claude untuk contoh kerja lengkap.

Respons model dengan alat

Saat menggunakan alat, Claude sering kali akan mengomentari apa yang sedang dilakukan atau merespons secara alami kepada pengguna sebelum memanggil alat.

Misalnya, diberikan prompt "Bagaimana cuaca di San Francisco sekarang, dan jam berapa di sana?", Claude mungkin merespons dengan:

JSON

{
  "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 percakapan. Anda dapat memandu gaya dan konten respons ini melalui prompt sistem Anda dan dengan menyediakan <examples> dalam prompt Anda.

Penting untuk dicatat bahwa Claude dapat menggunakan berbagai frasa dan pendekatan saat menjelaskan tindakannya. Kode Anda harus memperlakukan respons ini seperti teks yang dihasilkan asisten lainnya, dan tidak mengandalkan konvensi pemformatan tertentu.

Penggunaan alat paralel

Secara default, Claude dapat menggunakan beberapa alat untuk menjawab pertanyaan pengguna. Anda dapat menonaktifkan perilaku ini dengan:

Mengatur disable_parallel_tool_use=true ketika jenis tool_choice adalah auto, yang memastikan bahwa Claude menggunakan paling banyak satu alat
Mengatur disable_parallel_tool_use=true ketika jenis tool_choice adalah any atau tool, yang memastikan bahwa Claude menggunakan tepat satu alat

Memaksimalkan penggunaan alat paralel

Meskipun model Claude 4 memiliki kemampuan penggunaan alat paralel yang sangat baik secara default, Anda dapat meningkatkan kemungkinan eksekusi alat paralel di semua model dengan prompting yang ditargetkan:

Penggunaan alat paralel dengan Claude Sonnet 3.7

Claude Sonnet 3.7 mungkin kurang mungkin membuat panggilan alat paralel dalam respons, bahkan ketika Anda belum mengatur disable_parallel_tool_use. Kami merekomendasikan upgrade ke model Claude 4, yang memiliki penggunaan alat yang efisien token dan pemanggilan alat paralel yang ditingkatkan.

Jika Anda masih menggunakan Claude Sonnet 3.7, Anda dapat mengaktifkan header beta token-efficient-tools-2025-02-19, yang membantu mendorong Claude untuk menggunakan alat paralel. Anda juga dapat memperkenalkan "alat batch" yang dapat bertindak sebagai meta-alat untuk membungkus invokasi ke alat lain secara bersamaan.

Lihat contoh ini dalam cookbook kami untuk cara menggunakan solusi ini.

Menangani blok konten penggunaan alat dan hasil alat

Lebih sederhana dengan Tool runner: Penanganan alat manual yang dijelaskan di bagian ini secara otomatis dikelola oleh tool runner. Gunakan bagian ini ketika Anda memerlukan kontrol khusus atas eksekusi alat.

Respons Claude berbeda berdasarkan apakah menggunakan alat klien atau alat server.

Menangani hasil dari alat klien

Respons akan memiliki stop_reason dari tool_use dan satu atau lebih blok konten tool_use yang mencakup:

id: Pengenal unik untuk blok penggunaan alat tertentu ini. Ini akan digunakan untuk mencocokkan hasil alat nanti.
name: Nama alat yang digunakan.
input: Objek yang berisi input yang diteruskan ke alat, sesuai dengan input_schema alat.

Ketika Anda menerima respons penggunaan alat untuk alat klien, Anda harus:

Ekstrak name, id, dan input dari blok tool_use.
Jalankan alat aktual dalam codebase Anda yang sesuai dengan nama alat tersebut, meneruskan input alat.
Lanjutkan percakapan dengan mengirim pesan baru dengan role dari user, dan blok content yang berisi jenis tool_result dan informasi berikut:
- tool_use_id: id dari permintaan penggunaan alat ini adalah hasil untuk.
- content: Hasil alat, sebagai string (misalnya, ), daftar blok konten bersarang (misalnya, ), atau daftar blok dokumen (misalnya, ). Blok konten ini dapat menggunakan jenis , , atau .

Persyaratan pemformatan penting:

Blok hasil alat harus segera mengikuti blok penggunaan alat yang sesuai dalam riwayat pesan. Anda tidak dapat menyertakan pesan apa pun antara pesan penggunaan alat asisten dan pesan hasil alat pengguna.
Dalam pesan pengguna yang berisi hasil alat, blok tool_result harus datang PERTAMA dalam array konten. Teks apa pun harus datang SETELAH semua hasil alat.

Misalnya, ini akan menyebabkan kesalahan 400:

{"role": "user", "content": [
  {"type": "text", "text": "Here are the results:"},  // ❌ Text before tool_result
  {"type": "tool_result", "tool_use_id": "toolu_01", ...}
]}

Setelah menerima hasil alat, Claude akan menggunakan informasi tersebut untuk melanjutkan menghasilkan respons terhadap prompt pengguna asli.

Menangani hasil dari alat server

Claude mengeksekusi alat secara internal dan menggabungkan hasil langsung ke dalam responsnya tanpa memerlukan interaksi pengguna tambahan.

Perbedaan dari API lain

Tidak seperti API yang memisahkan penggunaan alat atau menggunakan peran khusus seperti tool atau function, API Claude mengintegrasikan alat langsung ke dalam struktur pesan user dan assistant.

Pesan berisi array blok text, image, tool_use, dan tool_result. Pesan user mencakup konten klien dan tool_result, sementara pesan assistant berisi konten yang dihasilkan AI dan tool_use.

Menangani alasan penghentian `max_tokens`

Jika respons Claude terpotong karena mencapai batas max_tokens, dan respons terpotong berisi blok penggunaan alat yang tidak lengkap, Anda perlu mengulangi permintaan dengan nilai max_tokens yang lebih tinggi untuk mendapatkan penggunaan alat lengkap.

Menangani alasan penghentian `pause_turn`

Saat menggunakan alat server seperti pencarian web, API dapat mengembalikan alasan penghentian pause_turn, menunjukkan bahwa API telah menjeda giliran yang berjalan lama.

Berikut cara menangani alasan penghentian pause_turn:

Saat menangani pause_turn:

Lanjutkan percakapan: Teruskan respons yang dijeda kembali apa adanya dalam permintaan berikutnya untuk membiarkan Claude melanjutkan gilirannya
Ubah jika diperlukan: Anda dapat secara opsional mengubah konten sebelum melanjutkan jika Anda ingin mengganggu atau mengarahkan kembali percakapan
Pertahankan status alat: Sertakan alat yang sama dalam permintaan lanjutan untuk mempertahankan fungsionalitas

Pemecahan masalah kesalahan

Penanganan Kesalahan Bawaan: Tool runner menyediakan penanganan kesalahan otomatis untuk sebagian besar skenario umum. Bagian ini mencakup penanganan kesalahan manual untuk kasus penggunaan lanjutan.

Ada beberapa jenis kesalahan berbeda yang dapat terjadi saat menggunakan alat dengan Claude:

import anthropic

client = anthropic.Anthropic()

response = client.messages.create(
    model="claude-opus-4-6",
    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?"}],
)

"content": "15 degrees"

"content": [{"type": "text", "text": "15 degrees"}]

"content": ["type": "document", "source": {"type": "text", "media_type": "text/plain", "data": "15 degrees"}]

text

image

document

# Check if response was truncated during tool use
if response.stop_reason == "max_tokens":
    # Check if the last content block is an incomplete tool_use
    last_block = response.content[-1]
    if last_block.type == "tool_use":
        # Send the request with higher max_tokens
        response = client.messages.create(
            model="claude-opus-4-6",
            max_tokens=4096,  # Increased limit
            messages=messages,
            tools=tools,
        )

import anthropic

client = anthropic.Anthropic()

# Initial request with web search
response = client.messages.create(
    model="claude-3-7-sonnet-latest",
    max_tokens=1024,
    messages=[
        {
            "role": "user",
            "content": "Search for comprehensive information about quantum computing breakthroughs in 2025",
        }
    ],
    tools=[{"type": "web_search_20250305", "name": "web_search", "max_uses": 10}],
)

# Check if the response has pause_turn stop reason
if response.stop_reason == "pause_turn":
    # Continue the conversation with the paused content
    messages = [
        {
            "role": "user",
            "content": "Search for comprehensive information about quantum computing breakthroughs in 2025",
        },
        {"role": "assistant", "content": response.content},
    ]

    # Send the continuation request
    continuation = client.messages.create(
        model="claude-3-7-sonnet-latest",
        max_tokens=1024,
        messages=messages,
        tools=[{"type": "web_search_20250305", "name": "web_search", "max_uses": 10}],
    )

    print(continuation)
else:
    print(response)

Memilih model

Menentukan alat klien

Contoh definisi alat sederhana

Prompt sistem penggunaan alat

Praktik terbaik untuk definisi alat

Contoh deskripsi alat yang baik

Memberikan contoh penggunaan alat

Penggunaan dasar

Persyaratan dan batasan

Pelari alat (beta)

Penggunaan dasar

Iterasi di atas pelari alat

Penggunaan lanjutan

Debugging eksekusi alat

Mengintersepsi kesalahan alat

Memodifikasi hasil alat

Streaming

Mengontrol output Claude

Memaksa penggunaan alat

Output JSON

Respons model dengan alat

Penggunaan alat paralel

Contoh penggunaan alat paralel lengkap

Memaksimalkan penggunaan alat paralel

Prompt sistem untuk penggunaan alat paralel

Prompting pesan pengguna

Menangani blok konten penggunaan alat dan hasil alat

Menangani hasil dari alat klien

Contoh respons API dengan blok konten `tool_use`

Contoh hasil alat yang berhasil

Contoh hasil alat dengan gambar

Menangani hasil dari alat server

Menangani alasan penghentian max_tokens

Menangani alasan penghentian pause_turn

Pemecahan masalah kesalahan

Kesalahan eksekusi alat

Contoh deskripsi alat yang buruk

Skrip uji lengkap untuk alat paralel

Contoh hasil alat kosong

Contoh hasil alat dengan dokumen

Nama alat tidak valid

Tag \<search_quality_reflection>

Kesalahan alat server

Penggunaan alat paralel tidak berfungsi

Menangani alasan penghentian `max_tokens`

Menangani alasan penghentian `pause_turn`