Menginstal dan menggunakan plugin
Panduan pengguna akhir untuk menambahkan, mengaktifkan, dan memecahkan masalah plugin.
Membangun plugin
Tutorial plugin pertama dengan manifes fungsional terkecil.
Plugin saluran
Bangun plugin saluran perpesanan.
Plugin penyedia
Bangun plugin penyedia model.
Ikhtisar SDK
Referensi peta impor dan API pendaftaran.
Model kapabilitas publik
Kapabilitas adalah model plugin native publik di dalam OpenClaw. Setiap plugin native OpenClaw mendaftar pada satu atau beberapa jenis kapabilitas:Plugin yang mendaftarkan nol kapabilitas tetapi menyediakan hook, alat, layanan penemuan, atau layanan latar belakang adalah plugin lama khusus hook. Pola tersebut masih didukung sepenuhnya.
Sikap terhadap kompatibilitas eksternal
Model kapabilitas telah diterapkan di inti dan digunakan oleh plugin bawaan/native saat ini, tetapi kompatibilitas plugin eksternal masih membutuhkan standar yang lebih ketat daripada “sudah diekspor, maka sudah dibekukan.”
Pendaftaran kapabilitas adalah arah yang dituju. Hook lama tetap menjadi jalur teraman tanpa kerusakan bagi plugin eksternal selama transisi. Tidak semua subjalur pembantu yang diekspor setara — utamakan kontrak sempit yang terdokumentasi daripada ekspor pembantu insidental.
Bentuk plugin
OpenClaw mengklasifikasikan setiap plugin yang dimuat ke dalam suatu bentuk berdasarkan perilaku pendaftaran aktualnya (bukan hanya metadata statis):kapabilitas-tunggal
kapabilitas-tunggal
Mendaftarkan tepat satu jenis kapabilitas (misalnya plugin khusus penyedia seperti
arcee atau chutes).kapabilitas-hibrida
kapabilitas-hibrida
Mendaftarkan beberapa jenis kapabilitas (misalnya
openai memiliki inferensi teks, ucapan, pemahaman media, dan pembuatan gambar).khusus-hook
khusus-hook
Hanya mendaftarkan hook (bertipe atau kustom), tanpa kapabilitas, alat, perintah, atau layanan.
non-kapabilitas
non-kapabilitas
Mendaftarkan alat, perintah, layanan, atau rute, tetapi tanpa kapabilitas.
openclaw plugins inspect <id> untuk melihat bentuk dan perincian kapabilitas suatu plugin. Lihat referensi CLI untuk detailnya.
Sinyal kompatibilitas
openclaw doctor, openclaw plugins inspect <id>, openclaw status --all, dan openclaw plugins doctor menampilkan pemberitahuan kompatibilitas berikut:
Tidak satu pun sinyal anjuran/peringatan tersebut merusak plugin Anda saat ini. Sinyal ini juga muncul di
openclaw status --all dan openclaw plugins doctor.
Ikhtisar arsitektur
Sistem plugin OpenClaw memiliki empat lapisan:1
Manifes + penemuan
OpenClaw menemukan kandidat plugin dari jalur yang dikonfigurasi, root ruang kerja, root plugin global, dan plugin bawaan. Penemuan terlebih dahulu membaca manifes native
openclaw.plugin.json beserta manifes bundel yang didukung.2
Pengaktifan + validasi
Inti menentukan apakah plugin yang ditemukan diaktifkan, dinonaktifkan, diblokir, atau dipilih untuk slot eksklusif seperti memori.
3
Pemuatan runtime
Plugin native OpenClaw dimuat dalam proses dan mendaftarkan kapabilitas ke registri pusat. JavaScript terpaket dimuat melalui
require native; TypeScript sumber lokal pihak ketiga adalah fallback Jiti darurat. Bundel yang kompatibel dinormalisasi menjadi catatan registri tanpa mengimpor kode runtime.4
Konsumsi permukaan
Bagian OpenClaw lainnya membaca registri untuk mengekspos alat, saluran, penyiapan penyedia, hook, rute HTTP, perintah CLI, dan layanan.
- metadata waktu penguraian berasal dari
registerCli(..., { descriptors: [...] }) - modul CLI plugin yang sebenarnya dapat tetap dimuat secara malas dan mendaftar saat pemanggilan pertama
- validasi manifes/konfigurasi harus berfungsi dari metadata manifes/skema tanpa mengeksekusi kode plugin
- penemuan kapabilitas native dapat memuat kode entri plugin tepercaya untuk membangun snapshot registri yang tidak mengaktifkan
- perilaku runtime native berasal dari jalur
register(api)modul plugin denganapi.registrationMode === "full"
Snapshot metadata plugin dan tabel pencarian
Saat dimulai, Gateway membangun satuPluginMetadataSnapshot untuk snapshot konfigurasi saat ini. Snapshot tersebut hanya berisi metadata: snapshot menyimpan indeks plugin yang terinstal, registri manifes, diagnostik manifes, peta pemilik, penormal id plugin, dan catatan manifes. Snapshot tersebut tidak menyimpan modul plugin yang dimuat, SDK penyedia, isi paket, atau ekspor runtime.
Validasi konfigurasi yang memahami plugin, pengaktifan otomatis saat mulai, dan bootstrap plugin Gateway menggunakan snapshot tersebut, alih-alih membangun ulang metadata manifes/indeks secara terpisah. PluginLookUpTable diturunkan dari snapshot yang sama dan menambahkan rencana plugin awal untuk konfigurasi runtime saat ini.
Setelah dimulai, Gateway mempertahankan snapshot metadata saat ini sebagai produk runtime yang dapat diganti. Penemuan penyedia runtime berulang dapat meminjam snapshot tersebut alih-alih merekonstruksi indeks yang terinstal dan registri manifes untuk setiap lintasan katalog penyedia. Snapshot dihapus atau diganti saat Gateway dimatikan, ketika konfigurasi/inventaris plugin berubah, dan ketika indeks yang terinstal ditulis; pemanggil kembali ke jalur manifes/indeks dingin jika tidak ada snapshot saat ini yang kompatibel. Pemeriksaan kompatibilitas harus mencakup root penemuan plugin seperti plugins.load.paths dan ruang kerja agen default, karena plugin ruang kerja merupakan bagian dari cakupan metadata.
Snapshot dan tabel pencarian mempertahankan keputusan awal berulang pada jalur cepat:
- kepemilikan saluran
- permulaan saluran yang ditangguhkan
- id plugin awal
- kepemilikan penyedia dan backend CLI
- kepemilikan penyedia penyiapan, alias perintah, penyedia katalog model, dan kontrak manifes
- validasi skema konfigurasi plugin dan skema konfigurasi saluran
- keputusan pengaktifan otomatis saat mulai
PluginLookUpTable Gateway. Jalur tersebut kini merekonstruksi registri sesuai permintaan; utamakan penerusan tabel pencarian saat ini atau registri manifes eksplisit melalui alur runtime jika pemanggil sudah memilikinya.
Perencanaan aktivasi
Perencanaan aktivasi merupakan bagian dari bidang kontrol. Pemanggil dapat menanyakan plugin mana yang relevan untuk perintah, penyedia, saluran, rute, harness agen, atau kapabilitas tertentu sebelum memuat registri runtime yang lebih luas. Perencana mempertahankan kompatibilitas perilaku manifes saat ini:- bidang
activation.*adalah petunjuk perencana eksplisit providers,channels,commandAliases,setup.providers,contracts.tools, dan hook tetap menjadi fallback kepemilikan manifes- API perencana khusus id tetap tersedia bagi pemanggil yang ada
- API rencana melaporkan label alasan agar diagnostik dapat membedakan petunjuk eksplisit dari fallback kepemilikan
Plugin saluran dan alat pesan bersama
Plugin saluran tidak perlu mendaftarkan alat kirim/edit/reaksi terpisah untuk tindakan obrolan biasa. OpenClaw mempertahankan satu alatmessage bersama di inti, sedangkan plugin saluran memiliki penemuan dan eksekusi khusus saluran di baliknya.
Batas saat ini adalah:
- inti memiliki host alat
messagebersama, pengawatan prompt, pencatatan sesi/utas, dan pengiriman eksekusi - plugin saluran memiliki penemuan tindakan terbatas, penemuan kapabilitas, dan setiap fragmen skema khusus saluran
- plugin saluran memiliki tata bahasa percakapan sesi khusus penyedia, seperti cara id percakapan mengodekan id utas atau diwariskan dari percakapan induk
- plugin saluran mengeksekusi tindakan akhir melalui adaptor tindakannya
ChannelMessageActionAdapter.describeMessageTool(...). Panggilan penemuan terpadu tersebut memungkinkan plugin mengembalikan tindakan, kapabilitas, dan kontribusi skema yang terlihat secara bersamaan agar bagian-bagian tersebut tidak menyimpang satu sama lain.
Nama tindakan pesan menggunakan kosakata tertutup yang sengaja dimiliki inti agar setiap transportasi dapat merender setiap tindakan. Plugin menambahkan nama tindakan melalui PR inti; pendaftaran saat runtime sengaja tidak didukung.
Saat parameter alat pesan khusus saluran membawa sumber media seperti jalur lokal atau URL media jarak jauh, plugin juga harus mengembalikan mediaSourceParams dari describeMessageTool(...). Inti menggunakan daftar eksplisit tersebut untuk menerapkan normalisasi jalur sandbox dan petunjuk akses media keluar tanpa mengodekan nama parameter milik plugin secara permanen. Utamakan peta yang dicakup per tindakan di sana, bukan satu daftar datar untuk seluruh saluran, agar parameter media khusus profil tidak dinormalisasi pada tindakan yang tidak terkait seperti send.
Inti meneruskan cakupan runtime ke langkah penemuan tersebut. Bidang penting meliputi:
accountIdcurrentChannelIdcurrentThreadTscurrentMessageIdsessionKeysessionIdagentIdrequesterSenderIdmasuk tepercaya
message inti.
Inilah alasan perubahan perutean runner tertanam tetap merupakan pekerjaan plugin: runner bertanggung jawab meneruskan identitas obrolan/sesi saat ini ke batas penemuan plugin agar alat message bersama menampilkan permukaan milik saluran yang tepat untuk giliran saat ini.
Untuk pembantu eksekusi milik saluran, plugin terbundel harus menyimpan runtime eksekusi di dalam modul pluginnya sendiri. Inti tidak lagi memiliki runtime tindakan pesan Discord, Slack, Telegram, atau WhatsApp di bawah src/agents/tools. Kami tidak memublikasikan subjalur plugin-sdk/*-action-runtime terpisah, dan plugin terbundel harus mengimpor kode runtime lokalnya sendiri secara langsung dari modul milik plugin tersebut.
Batas yang sama berlaku bagi seam SDK bernama penyedia secara umum: inti tidak boleh mengimpor barrel praktis khusus saluran untuk Discord, Signal, Slack, WhatsApp, atau plugin serupa. Jika inti memerlukan suatu perilaku, gunakan barrel api.ts / runtime-api.ts milik plugin terbundel itu sendiri atau promosikan kebutuhan tersebut menjadi kapabilitas generik sempit dalam SDK bersama.
Plugin terbundel mengikuti aturan yang sama. runtime-api.ts milik plugin terbundel tidak boleh mengekspor ulang fasad openclaw/plugin-sdk/<plugin-id> bermereknya sendiri. Fasad bermerek tersebut tetap menjadi shim kompatibilitas bagi plugin eksternal dan konsumen lama, tetapi plugin terbundel harus menggunakan ekspor lokal ditambah subjalur SDK generik sempit seperti openclaw/plugin-sdk/channel-policy, openclaw/plugin-sdk/runtime-store, atau openclaw/plugin-sdk/webhook-ingress. Kode baru tidak boleh menambahkan fasad SDK khusus id plugin kecuali batas kompatibilitas untuk ekosistem eksternal yang sudah ada memerlukannya.
Khusus untuk jajak pendapat, terdapat dua jalur eksekusi:
outbound.sendPolladalah dasar bersama bagi saluran yang sesuai dengan model jajak pendapat umumactions.handleAction("poll")adalah jalur yang diutamakan untuk semantik jajak pendapat khusus saluran atau parameter jajak pendapat tambahan
Model kepemilikan kapabilitas
OpenClaw memperlakukan plugin native sebagai batas kepemilikan bagi sebuah perusahaan atau fitur, bukan sebagai kumpulan integrasi yang tidak saling terkait. Artinya:- plugin perusahaan biasanya harus memiliki seluruh permukaan perusahaan tersebut yang menghadap OpenClaw
- plugin fitur biasanya harus memiliki seluruh permukaan fitur yang diperkenalkannya
- saluran harus menggunakan kapabilitas inti bersama alih-alih mengimplementasikan ulang perilaku penyedia secara ad hoc
Multi-kapabilitas vendor
Multi-kapabilitas vendor
google memiliki inferensi teks, backend CLI, embedding, ujaran, suara realtime, pemahaman media, pembuatan gambar/musik/video, dan pencarian web. openai memiliki inferensi teks, embedding, ujaran, transkripsi realtime, suara realtime, pemahaman media, serta pembuatan gambar/video. minimax memiliki inferensi teks ditambah pemahaman media, ujaran, pembuatan gambar/musik/video, dan pencarian web.Kapabilitas tunggal vendor
Kapabilitas tunggal vendor
arcee dan chutes hanya memiliki inferensi teks; microsoft hanya memiliki ujaran. Plugin vendor dapat tetap sesempit ini hingga perlu mencakup lebih banyak permukaan vendor tersebut.Plugin fitur
Plugin fitur
voice-call memiliki transportasi panggilan, alat, CLI, rute, dan penghubungan stream media Twilio, tetapi menggunakan kapabilitas ujaran, transkripsi realtime, dan suara realtime bersama alih-alih mengimpor plugin vendor secara langsung.- permukaan vendor yang menghadap OpenClaw berada dalam satu plugin meskipun mencakup model teks, ujaran, gambar, dan video
- vendor lain dapat melakukan hal yang sama untuk area permukaannya sendiri
- saluran tidak memedulikan plugin vendor mana yang memiliki penyedia; saluran menggunakan kontrak kapabilitas bersama yang diekspos oleh inti
- plugin = batas kepemilikan
- kapabilitas = kontrak inti yang dapat diimplementasikan atau digunakan oleh beberapa plugin
1
Tentukan kapabilitas
Tentukan kapabilitas yang belum tersedia di inti.
2
Ekspos melalui SDK
Ekspos kapabilitas tersebut melalui API/runtime plugin dengan cara bertipe.
3
Hubungkan konsumen
Hubungkan saluran/fitur dengan kapabilitas tersebut.
4
Implementasi vendor
Biarkan plugin vendor mendaftarkan implementasi.
Pelapisan kapabilitas
Gunakan model mental ini saat menentukan tempat kode seharusnya berada:- Lapisan kapabilitas inti
- Lapisan plugin vendor
- Lapisan plugin saluran/fitur
Orkestrasi bersama, kebijakan, fallback, aturan penggabungan konfigurasi, semantik pengiriman, dan kontrak bertipe.
- inti memiliki kebijakan TTS saat balasan, urutan fallback, preferensi, dan pengiriman saluran
elevenlabs,google,microsoft, danopenaimemiliki implementasi sintesisvoice-callmenggunakan pembantu runtime TTS telefoni
Contoh plugin perusahaan multi-kapabilitas
Plugin perusahaan harus terasa kohesif dari luar. Jika OpenClaw memiliki kontrak bersama untuk model, ujaran, transkripsi realtime, suara realtime, pemahaman media, pembuatan gambar, pembuatan video, pengambilan web, dan pencarian web, sebuah vendor dapat memiliki seluruh permukaannya di satu tempat:- satu plugin memiliki permukaan vendor
- inti tetap memiliki kontrak kapabilitas
- penerjemahan permintaan penyedia dan pembantu HTTP tetap berada di plugin vendor
- saluran dan plugin fitur menggunakan pembantu
api.runtime.*, bukan kode vendor - pengujian kontrak dapat memastikan bahwa plugin mendaftarkan kapabilitas yang diklaim dimilikinya
Contoh kapabilitas: pemahaman video
OpenClaw sudah memperlakukan pemahaman gambar/audio/video sebagai satu kapabilitas bersama. Model kepemilikan yang sama berlaku di sana:1
Inti menentukan kontrak
Inti menentukan kontrak pemahaman media.
2
Plugin vendor mendaftar
Plugin vendor mendaftarkan
describeImage, transcribeAudio, dan describeVideo sebagaimana berlaku.3
Konsumen menggunakan perilaku bersama
Saluran dan plugin fitur menggunakan perilaku inti bersama alih-alih terhubung langsung ke kode vendor.
api.registerVideoGenerationProvider(...) terhadap kontrak tersebut.
Memerlukan daftar periksa peluncuran yang konkret? Lihat Buku Panduan Kapabilitas.
Kontrak dan penegakan
Permukaan API plugin sengaja dibuat bertipe dan dipusatkan diOpenClawPluginApi. Kontrak tersebut menentukan titik pendaftaran yang didukung dan pembantu runtime yang dapat diandalkan oleh plugin.
Mengapa hal ini penting:
- penulis plugin mendapatkan satu standar internal yang stabil
- core dapat menolak kepemilikan duplikat, seperti dua plugin yang mendaftarkan id penyedia yang sama
- proses awal dapat menampilkan diagnostik yang dapat ditindaklanjuti untuk pendaftaran yang tidak valid
- pengujian kontrak dapat menegakkan kepemilikan plugin bawaan dan mencegah penyimpangan tanpa peringatan
Penegakan pendaftaran runtime
Penegakan pendaftaran runtime
Registri plugin memvalidasi pendaftaran saat plugin dimuat. Contohnya: id penyedia duplikat, id penyedia suara duplikat, dan pendaftaran yang tidak valid menghasilkan diagnostik plugin alih-alih perilaku yang tidak terdefinisi.
Pengujian kontrak
Pengujian kontrak
Plugin bawaan dicatat dalam registri kontrak selama pengujian sehingga OpenClaw dapat memverifikasi kepemilikan secara eksplisit. Saat ini, mekanisme ini digunakan untuk penyedia model, penyedia suara, penyedia pencarian web, dan kepemilikan pendaftaran bawaan.
Apa yang termasuk dalam kontrak
- Kontrak yang baik
- Kontrak yang buruk
- bertipe
- kecil
- khusus untuk kapabilitas
- dimiliki oleh core
- dapat digunakan kembali oleh beberapa plugin
- dapat digunakan oleh kanal/fitur tanpa pengetahuan khusus tentang vendor
Model eksekusi
Plugin OpenClaw native berjalan dalam proses bersama Gateway. Plugin tersebut tidak berada dalam sandbox. Plugin native yang dimuat memiliki batas kepercayaan tingkat proses yang sama dengan kode core. Bundel yang kompatibel secara default lebih aman karena OpenClaw saat ini memperlakukannya sebagai paket metadata/konten. Dalam rilis saat ini, hal tersebut terutama berarti Skills yang dibundel. Gunakan daftar izin dan jalur instalasi/pemuatan eksplisit untuk plugin yang tidak dibundel. Perlakukan plugin ruang kerja sebagai kode untuk masa pengembangan, bukan sebagai nilai default produksi. Untuk nama paket ruang kerja bawaan, pertahankan id plugin agar tetap berakar pada nama npm:@openclaw/<id> secara default, atau akhiran bertipe yang disetujui seperti -provider, -plugin, -speech, -sandbox, atau -media-understanding ketika paket tersebut sengaja mengekspos peran plugin yang lebih sempit.
Catatan kepercayaan:
plugins.allow memercayai id plugin, bukan asal-usul sumber. Plugin ruang kerja dengan id yang sama seperti plugin bawaan secara sengaja menggantikan salinan bawaan ketika plugin ruang kerja tersebut diaktifkan/dimasukkan ke daftar izin. Hal ini normal dan berguna untuk pengembangan lokal, pengujian patch, dan hotfix. Kepercayaan terhadap plugin bawaan ditentukan dari snapshot sumber — manifes dan kode pada disk saat pemuatan — bukan dari metadata instalasi. Catatan instalasi yang rusak atau diganti tidak dapat secara diam-diam memperluas permukaan kepercayaan plugin bawaan melampaui apa yang diklaim oleh sumber sebenarnya.Batas ekspor
OpenClaw mengekspor kapabilitas, bukan kemudahan implementasi. Pertahankan pendaftaran kapabilitas sebagai API publik. Pangkas ekspor pembantu yang bukan bagian kontrak:- subjalur pembantu khusus plugin bawaan
- subjalur mekanisme runtime yang tidak dimaksudkan sebagai API publik
- pembantu kemudahan khusus vendor
- pembantu penyiapan/orientasi yang merupakan detail implementasi
plugin-sdk/gateway-runtime, plugin-sdk/security-runtime, dan kapabilitas API plugin yang diinjeksi.