Izin SDK
Claude Agent SDK menyediakan kontrol izin yang kuat yang memungkinkan Anda mengelola bagaimana Claude menggunakan alat dalam aplikasi Anda. Panduan ini mencakup cara mengimplementasikan sistem izin menggunakan callbackcanUseTool, hooks, dan aturan izin settings.json. Untuk dokumentasi API lengkap, lihat referensi TypeScript SDK.
Gambaran Umum
Claude Agent SDK menyediakan empat cara komplementer untuk mengontrol penggunaan alat:- Mode Izin - Pengaturan perilaku izin global yang mempengaruhi semua alat
- callback canUseTool - Penanganan izin runtime untuk kasus yang tidak dicakup oleh aturan lain
- Hooks - Kontrol yang detail atas setiap eksekusi alat dengan logika kustom
- Aturan izin (settings.json) - Aturan allow/deny deklaratif dengan parsing perintah bash terintegrasi
- Mode izin - Mengatur perilaku izin keseluruhan (perencanaan, otomatis menerima edit, melewati pemeriksaan)
canUseTool- Persetujuan dinamis untuk kasus yang tidak tercakup, meminta izin pengguna- Hooks - Kontrol programatis atas semua eksekusi alat
- Aturan izin - Kebijakan statis dengan parsing perintah bash yang cerdas
Diagram Alur Izin
Urutan Pemrosesan: PreToolUse Hook → Aturan Tolak → Aturan Izinkan → Aturan Tanya → Pemeriksaan Mode Izin → canUseTool Callback → PostToolUse HookMode Izin
Mode izin menyediakan kontrol global atas bagaimana Claude menggunakan alat. Anda dapat mengatur mode izin saat memanggilquery() atau mengubahnya secara dinamis selama sesi streaming.
Mode yang Tersedia
SDK mendukung empat mode izin, masing-masing dengan perilaku yang berbeda:| Mode | Deskripsi | Perilaku Alat |
|---|---|---|
default | Perilaku izin standar | Pemeriksaan izin normal berlaku |
plan | Mode perencanaan - tidak ada eksekusi | Claude hanya dapat menggunakan alat read-only; menyajikan rencana sebelum eksekusi (Saat ini tidak didukung dalam SDK) |
acceptEdits | Otomatis menerima edit file | Edit file dan operasi filesystem secara otomatis disetujui |
bypassPermissions | Melewati semua pemeriksaan izin | Semua alat berjalan tanpa prompt izin (gunakan dengan hati-hati) |
Mengatur Mode Izin
Anda dapat mengatur mode izin dengan dua cara:1. Konfigurasi Awal
Atur mode saat membuat query:2. Perubahan Mode Dinamis (Hanya Streaming)
Ubah mode selama sesi streaming:Perilaku Spesifik Mode
Mode Accept Edits (acceptEdits)
Dalam mode accept edits:
- Semua edit file secara otomatis disetujui
- Operasi filesystem (mkdir, touch, rm, dll.) secara otomatis disetujui
- Alat lain masih memerlukan izin normal
- Mempercepat pengembangan ketika Anda mempercayai edit Claude
- Berguna untuk prototyping cepat dan iterasi
- Edit file (alat Edit, Write)
- Perintah filesystem bash (mkdir, touch, rm, mv, cp)
- Pembuatan dan penghapusan file
Mode Bypass Permissions (bypassPermissions)
Dalam mode bypass permissions:
- SEMUA penggunaan alat secara otomatis disetujui
- Tidak ada prompt izin yang muncul
- Hooks masih dieksekusi (masih dapat memblokir operasi)
- Gunakan dengan sangat hati-hati - Claude memiliki akses sistem penuh
- Direkomendasikan hanya untuk lingkungan terkontrol
Prioritas Mode dalam Alur Izin
Mode izin dievaluasi pada titik tertentu dalam alur izin:- Hooks dieksekusi terlebih dahulu - Dapat mengizinkan, menolak, bertanya, atau melanjutkan
- Aturan tolak diperiksa - Memblokir alat terlepas dari mode
- Aturan izinkan diperiksa - Mengizinkan alat jika cocok
- Aturan tanya diperiksa - Meminta izin jika cocok
- Mode izin dievaluasi:
- Mode
bypassPermissions- Jika aktif, mengizinkan semua alat yang tersisa - Mode lain - Menunda ke callback
canUseTool
- Mode
- Callback
canUseTool- Menangani kasus yang tersisa
- Hooks selalu dapat mengontrol penggunaan alat, bahkan dalam mode
bypassPermissions - Aturan tolak eksplisit menimpa semua mode izin
- Aturan tanya dievaluasi sebelum mode izin
- Mode
bypassPermissionsmenimpa callbackcanUseTooluntuk alat yang tidak cocok
Praktik Terbaik
- Gunakan mode default untuk eksekusi terkontrol dengan pemeriksaan izin normal
- Gunakan mode acceptEdits saat bekerja pada file atau direktori yang terisolasi
- Hindari bypassPermissions dalam produksi atau pada sistem dengan data sensitif
- Gabungkan mode dengan hooks untuk kontrol yang detail
- Beralih mode secara dinamis berdasarkan kemajuan tugas dan kepercayaan
canUseTool
CallbackcanUseTool diteruskan sebagai opsi saat memanggil fungsi query. Ini menerima nama alat dan parameter input, dan harus mengembalikan keputusan - baik izinkan atau tolak.
canUseTool dipicu setiap kali Claude Code akan menampilkan prompt izin kepada pengguna, misalnya hooks dan aturan izin tidak mencakupnya dan tidak dalam mode acceptEdits.
Berikut adalah contoh lengkap yang menunjukkan cara mengimplementasikan persetujuan alat interaktif:
Sumber Daya Terkait
- Panduan Hooks - Pelajari cara mengimplementasikan hooks untuk kontrol yang detail atas eksekusi alat
- Pengaturan: Aturan Izin - Konfigurasi aturan allow/deny deklaratif dengan parsing perintah bash