Bu, OpenClaw Plugin sistemi için derin mimari başvurusudur. Pratik kılavuzlar için aşağıdaki odaklı sayfalardan biriyle başlayın.Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
Plugin'leri kurma ve kullanma
Plugin ekleme, etkinleştirme ve sorun giderme için son kullanıcı kılavuzu.
Plugin oluşturma
En küçük çalışan manifest ile ilk Plugin öğreticisi.
Kanal Plugin'leri
Bir mesajlaşma kanalı Plugin’i oluşturun.
Sağlayıcı Plugin'leri
Bir model sağlayıcı Plugin’i oluşturun.
SDK genel bakışı
İçe aktarma haritası ve kayıt API başvurusu.
Genel yetenek modeli
Yetenekler, OpenClaw içindeki herkese açık yerel Plugin modelidir. Her yerel OpenClaw Plugin’i bir veya daha fazla yetenek türüne göre kaydolur:| Yetenek | Kayıt yöntemi | Örnek Plugin’ler |
|---|---|---|
| Metin çıkarımı | api.registerProvider(...) | openai, anthropic |
| CLI çıkarım arka ucu | api.registerCliBackend(...) | openai, anthropic |
| Konuşma | api.registerSpeechProvider(...) | elevenlabs, microsoft |
| Gerçek zamanlı transkripsiyon | api.registerRealtimeTranscriptionProvider(...) | openai |
| Gerçek zamanlı ses | api.registerRealtimeVoiceProvider(...) | openai |
| Medya anlama | api.registerMediaUnderstandingProvider(...) | openai, google |
| Görüntü üretimi | api.registerImageGenerationProvider(...) | openai, google, fal, minimax |
| Müzik üretimi | api.registerMusicGenerationProvider(...) | google, minimax |
| Video üretimi | api.registerVideoGenerationProvider(...) | qwen |
| Web getirme | api.registerWebFetchProvider(...) | firecrawl |
| Web arama | api.registerWebSearchProvider(...) | google |
| Kanal / mesajlaşma | api.registerChannel(...) | msteams, matrix |
| Gateway keşfi | api.registerGatewayDiscoveryService(...) | bonjour |
Sıfır yetenek kaydeden ancak hook’lar, araçlar, keşif servisleri veya arka plan servisleri sağlayan bir Plugin, eski yalnızca hook Plugin’idir. Bu kalıp hâlâ tam olarak desteklenir.
Harici uyumluluk yaklaşımı
Yetenek modeli çekirdeğe yerleşmiştir ve bugün paketlenmiş/yerel Plugin’ler tarafından kullanılır, ancak harici Plugin uyumluluğu hâlâ “dışa aktarılmışsa donmuştur” ifadesinden daha sıkı bir çıta gerektirir.| Plugin durumu | Rehberlik |
|---|---|
| Mevcut harici Plugin’ler | Hook tabanlı entegrasyonları çalışır tutun; uyumluluk tabanı budur. |
| Yeni paketlenmiş/yerel Plugin’ler | Satıcıya özel iç erişimler veya yeni yalnızca hook tasarımları yerine açık yetenek kaydını tercih edin. |
| Yetenek kaydını benimseyen harici Plugin’ler | İzin verilir, ancak belgeler kararlı olarak işaretlemedikçe yeteneğe özel yardımcı yüzeyleri gelişen yüzeyler olarak ele alın. |
Plugin biçimleri
OpenClaw, yüklenen her Plugin’i gerçek kayıt davranışına göre bir biçime sınıflandırır (yalnızca statik meta verilere göre değil):plain-capability
plain-capability
Tam olarak bir yetenek türü kaydeder (örneğin
mistral gibi yalnızca sağlayıcı olan bir Plugin).hybrid-capability
hybrid-capability
Birden çok yetenek türü kaydeder (örneğin
openai; metin çıkarımı, konuşma, medya anlama ve görüntü üretiminin sahibidir).hook-only
hook-only
Yalnızca hook’lar kaydeder (tipli veya özel); yetenek, araç, komut ya da servis kaydetmez.
non-capability
non-capability
Araçlar, komutlar, servisler veya rotalar kaydeder ancak yetenek kaydetmez.
openclaw plugins inspect <id> kullanın. Ayrıntılar için CLI başvurusu bölümüne bakın.
Eski hook’lar
before_agent_start hook’u, yalnızca hook Plugin’leri için uyumluluk yolu olarak desteklenmeye devam eder. Eski gerçek dünya Plugin’leri hâlâ buna bağlıdır.
Yön:
- çalışır tutun
- eski olarak belgeleyin
- model/sağlayıcı geçersiz kılma işi için
before_model_resolvetercih edin - istem değiştirme işi için
before_prompt_buildtercih edin - yalnızca gerçek kullanım düştükten ve fixture kapsamı geçiş güvenliğini kanıtladıktan sonra kaldırın
Uyumluluk sinyalleri
openclaw doctor veya openclaw plugins inspect <id> çalıştırdığınızda şu etiketlerden birini görebilirsiniz:
| Sinyal | Anlamı |
|---|---|
| config geçerli | Config düzgün ayrıştırılır ve Plugin’ler çözümlenir |
| uyumluluk önerisi | Plugin desteklenen ama daha eski bir kalıp kullanıyor (örn. hook-only) |
| eski uyarısı | Plugin kullanımdan kaldırılmış olan before_agent_start kullanıyor |
| sert hata | Config geçersiz veya Plugin yüklenemedi |
hook-only ne de before_agent_start Plugin’inizi bozar: hook-only öneri niteliğindedir ve before_agent_start yalnızca bir uyarı tetikler. Bu sinyaller openclaw status --all ve openclaw plugins doctor içinde de görünür.
Mimari genel bakışı
OpenClaw’ın Plugin sistemi dört katmana sahiptir:Manifest + keşif
OpenClaw, yapılandırılmış yollardan, çalışma alanı köklerinden, genel Plugin köklerinden ve paketlenmiş Plugin’lerden aday Plugin’leri bulur. Keşif önce yerel
openclaw.plugin.json manifestlerini ve desteklenen bundle manifestlerini okur.Etkinleştirme + doğrulama
Çekirdek, keşfedilen bir Plugin’in etkin mi, devre dışı mı, engellenmiş mi yoksa bellek gibi özel bir yuva için seçilmiş mi olduğuna karar verir.
Çalışma zamanı yükleme
Yerel OpenClaw Plugin’leri süreç içinde yüklenir ve yetenekleri merkezi bir kayıt defterine kaydeder. Paketlenmiş JavaScript yerel
require üzerinden yüklenir; üçüncü taraf yerel kaynak TypeScript acil durum Jiti geri dönüşüdür. Uyumlu bundle’lar çalışma zamanı kodu içe aktarılmadan kayıt kayıtlarına normalleştirilir.- ayrıştırma zamanı meta verisi
registerCli(..., { descriptors: [...] })üzerinden gelir - gerçek Plugin CLI modülü tembel kalabilir ve ilk çağrıda kaydolabilir
- manifest/config doğrulaması, Plugin kodu çalıştırılmadan manifest/şema meta verilerinden çalışmalıdır
- yerel yetenek keşfi, etkinleştirmeyen bir kayıt defteri snapshot’ı oluşturmak için güvenilir Plugin giriş kodunu yükleyebilir
- yerel çalışma zamanı davranışı, Plugin modülünün
api.registrationMode === "full"ileregister(api)yolundan gelir
Plugin meta veri snapshot’ı ve arama tablosu
Gateway başlangıcı, geçerli config snapshot’ı için birPluginMetadataSnapshot oluşturur. Snapshot yalnızca meta veridir: kurulu Plugin dizinini, manifest kayıt defterini, manifest tanılamalarını, sahip haritalarını, bir Plugin id normalleştiricisini ve manifest kayıtlarını saklar. Yüklenmiş Plugin modüllerini, sağlayıcı SDK’larını, paket içeriklerini veya çalışma zamanı dışa aktarımlarını tutmaz.
Plugin farkındalıklı config doğrulaması, başlangıçta otomatik etkinleştirme ve Gateway Plugin bootstrap’i, manifest/dizin meta verilerini bağımsız olarak yeniden oluşturmak yerine bu snapshot’ı tüketir. PluginLookUpTable aynı snapshot’tan türetilir ve geçerli çalışma zamanı config’i için başlangıç Plugin planını ekler.
Başlangıçtan sonra Gateway, geçerli meta veri snapshot’ını değiştirilebilir bir çalışma zamanı ürünü olarak tutar. Tekrarlanan çalışma zamanı sağlayıcı keşfi, her sağlayıcı kataloğu geçişi için kurulu dizini ve manifest kayıt defterini yeniden oluşturmak yerine bu snapshot’ı ödünç alabilir. Snapshot, Gateway kapatıldığında, config/Plugin envanteri değiştiğinde ve kurulu dizin yazımlarında temizlenir veya değiştirilir; uyumlu geçerli snapshot olmadığında çağıranlar soğuk manifest/dizin yoluna geri döner. Uyumluluk denetimleri plugins.load.paths ve varsayılan ajan çalışma alanı gibi Plugin keşif köklerini içermelidir, çünkü çalışma alanı Plugin’leri meta veri kapsamının parçasıdır.
Snapshot ve arama tablosu, tekrarlanan başlangıç kararlarını hızlı yolda tutar:
- kanal sahipliği
- ertelenmiş kanal başlangıcı
- başlangıç Plugin id’leri
- sağlayıcı ve CLI arka uç sahipliği
- kurulum sağlayıcısı, komut takma adı, model kataloğu sağlayıcısı ve manifest sözleşmesi sahipliği
- Plugin config şeması ve kanal config şeması doğrulaması
- başlangıçta otomatik etkinleştirme kararları
PluginLookUpTable almak yerine kalıcı kurulu Plugin dizininden manifest kayıt defterlerini doğrudan yeniden oluşturur. Bu yol artık kayıt defterini ihtiyaç anında yeniden oluşturur; bir çağıranın zaten sahip olduğu durumlarda geçerli arama tablosunu veya açık bir manifest kayıt defterini çalışma zamanı akışlarından geçirmeyi tercih edin.
Etkinleştirme planlaması
Etkinleştirme planlaması kontrol düzleminin parçasıdır. Çağıranlar, daha geniş çalışma zamanı kayıt defterlerini yüklemeden önce somut bir komut, sağlayıcı, kanal, rota, ajan donanımı veya yetenekle hangi Plugin’lerin ilgili olduğunu sorabilir. Planlayıcı, geçerli manifest davranışını uyumlu tutar:activation.*alanları açık planlayıcı ipuçlarıdırproviders,channels,commandAliases,setup.providers,contracts.toolsve hook’lar manifest sahipliği geri dönüşü olarak kalır- yalnızca id’ler planlayıcı API’si mevcut çağıranlar için kullanılabilir kalır
- plan API’si neden etiketlerini bildirir; böylece tanılamalar açık ipuçlarını sahiplik geri dönüşünden ayırt edebilir
Kanal Plugin’leri ve paylaşılan mesaj aracı
Kanal Plugin’lerinin normal sohbet eylemleri için ayrı bir gönderme/düzenleme/tepki aracı kaydetmesi gerekmez. OpenClaw çekirdekte tek bir paylaşılanmessage aracı tutar ve kanal Plugin’leri bunun arkasındaki kanala özgü keşif ve yürütmenin sahibi olur.
Geçerli sınır şudur:
- çekirdek, paylaşılan
messagearacı ana makinesinin, prompt kablolamasının, oturum/iş parçacığı defter tutmanın ve yürütme dağıtımının sahibidir - kanal Plugin’leri kapsamlı eylem keşfinin, yetenek keşfinin ve kanala özgü şema parçalarının sahibidir
- kanal Plugin’leri, konuşma kimliklerinin iş parçacığı kimliklerini nasıl kodladığı veya üst konuşmalardan nasıl devraldığı gibi sağlayıcıya özgü oturum konuşma gramerinin sahibidir
- kanal Plugin’leri son eylemi kendi eylem adaptörleri üzerinden yürütür
ChannelMessageActionAdapter.describeMessageTool(...) şeklindedir. Bu birleşik keşif çağrısı, bir Plugin’in görünür eylemlerini, yeteneklerini ve şema katkılarını birlikte döndürmesini sağlar; böylece bu parçalar birbirinden sapmaz.
Kanala özgü bir mesaj aracı parametresi yerel yol veya uzak medya URL’si gibi bir medya kaynağı taşıdığında, Plugin ayrıca describeMessageTool(...) içinden mediaSourceParams döndürmelidir. Çekirdek, Plugin’e ait parametre adlarını sabit kodlamadan sandbox yol normalleştirmesi ve giden medya erişimi ipuçlarını uygulamak için bu açık listeyi kullanır. Burada kanal genelinde tek bir düz liste yerine eylem kapsamlı eşlemeleri tercih edin; böylece yalnızca profile özgü bir medya parametresi, send gibi ilgisiz eylemlerde normalleştirilmez.
Çekirdek, bu keşif adımına çalışma zamanı kapsamını geçirir. Önemli alanlar şunları içerir:
accountIdcurrentChannelIdcurrentThreadTscurrentMessageIdsessionKeysessionIdagentId- güvenilen gelen
requesterSenderId
message aracında kanala özgü dalları sabit kodlamadan etkin hesaba, geçerli odaya/iş parçacığına/mesaja veya güvenilen istekte bulunan kimliğine göre mesaj eylemlerini gizleyebilir ya da gösterebilir.
Bu nedenle embedded-runner yönlendirme değişiklikleri hâlâ Plugin işidir: runner, paylaşılan message aracının geçerli tur için doğru kanal sahipliğindeki yüzeyi göstermesi amacıyla geçerli sohbet/oturum kimliğini Plugin keşif sınırına iletmekten sorumludur.
Kanal sahipliğindeki yürütme yardımcıları için paketlenmiş Plugin’ler, yürütme çalışma zamanını kendi extension modüllerinin içinde tutmalıdır. Çekirdek artık src/agents/tools altında Discord, Slack, Telegram veya WhatsApp mesaj eylemi çalışma zamanlarının sahibi değildir. Ayrı plugin-sdk/*-action-runtime alt yolları yayımlamayız ve paketlenmiş Plugin’ler kendi yerel çalışma zamanı kodlarını doğrudan extension sahipliğindeki modüllerinden içe aktarmalıdır.
Aynı sınır, genel olarak sağlayıcı adlandırmalı SDK arayüzleri için de geçerlidir: çekirdek Slack, Discord, Signal, WhatsApp veya benzer extension’lar için kanala özgü kolaylık barrel’larını içe aktarmamalıdır. Çekirdeğin bir davranışa ihtiyacı varsa ya paketlenmiş Plugin’in kendi api.ts / runtime-api.ts barrel’ını tüketmeli ya da ihtiyacı paylaşılan SDK içinde dar bir genel yeteneğe yükseltmelidir.
Paketlenmiş Plugin’ler de aynı kuralı izler. Paketlenmiş bir Plugin’in runtime-api.ts dosyası, kendi markalı openclaw/plugin-sdk/<plugin-id> cephesini yeniden dışa aktarmamalıdır. Bu markalı cepheler harici Plugin’ler ve eski tüketiciler için uyumluluk shim’leri olarak kalır, ancak paketlenmiş Plugin’ler yerel dışa aktarımları ve openclaw/plugin-sdk/channel-policy, openclaw/plugin-sdk/runtime-store veya openclaw/plugin-sdk/webhook-ingress gibi dar genel SDK alt yollarını kullanmalıdır. Yeni kod, mevcut bir harici ekosistem için uyumluluk sınırı gerektirmedikçe Plugin kimliğine özgü SDK cepheleri eklememelidir.
Özellikle anketler için iki yürütme yolu vardır:
outbound.sendPoll, ortak anket modeline uyan kanallar için paylaşılan temeldiractions.handleAction("poll"), kanala özgü anket semantiği veya ek anket parametreleri için tercih edilen yoldur
Yetenek sahipliği modeli
OpenClaw, native bir Plugin’i ilgisiz entegrasyonlardan oluşan bir torba olarak değil, bir şirket veya bir özellik için sahiplik sınırı olarak ele alır. Bu şu anlama gelir:- bir şirket Plugin’i genellikle o şirketin OpenClaw’a dönük tüm yüzeylerinin sahibi olmalıdır
- bir özellik Plugin’i genellikle tanıttığı tam özellik yüzeyinin sahibi olmalıdır
- kanallar, sağlayıcı davranışını özel olarak yeniden uygulamak yerine paylaşılan çekirdek yetenekleri tüketmelidir
Vendor multi-capability
Vendor multi-capability
openai metin çıkarımı, konuşma, gerçek zamanlı ses, medya anlama ve görüntü oluşturmanın sahibidir. google metin çıkarımının yanı sıra medya anlama, görüntü oluşturma ve web aramasının sahibidir. qwen metin çıkarımının yanı sıra medya anlama ve video oluşturmanın sahibidir.Vendor single-capability
Vendor single-capability
elevenlabs ve microsoft konuşmanın sahibidir; firecrawl web getirme işleminin sahibidir; minimax / mistral / moonshot / zai medya anlama backend’lerinin sahibidir.Feature plugin
Feature plugin
voice-call çağrı taşımasının, araçların, CLI’ın, rotaların ve Twilio medya akışı köprülemesinin sahibidir; ancak vendor Plugin’lerini doğrudan içe aktarmak yerine paylaşılan konuşma, gerçek zamanlı transkripsiyon ve gerçek zamanlı ses yeteneklerini tüketir.- OpenAI metin modellerini, konuşmayı, görüntüleri ve gelecekteki videoyu kapsasa bile tek bir Plugin içinde yaşar
- başka bir vendor kendi yüzey alanı için aynı şeyi yapabilir
- kanallar sağlayıcının hangi vendor Plugin’ine ait olduğunu önemsemez; çekirdek tarafından sunulan paylaşılan yetenek sözleşmesini tüketir
- plugin = sahiplik sınırı
- capability = birden çok Plugin’in uygulayabileceği veya tüketebileceği çekirdek sözleşme
Bu, tek bir vendor’a veya tek seferlik Plugin’e özgü bir kod yoluna bağlı çekirdek davranışından kaçınırken sahipliği açık tutar.
Yetenek katmanları
Kodun nereye ait olduğuna karar verirken bu zihinsel modeli kullanın:- Core capability layer
- Vendor plugin layer
- Channel/feature plugin layer
Paylaşılan orkestrasyon, politika, fallback, yapılandırma birleştirme kuralları, teslim semantiği ve tipli sözleşmeler.
- çekirdek yanıt zamanı TTS politikasının, fallback sırasının, tercihlerin ve kanal tesliminin sahibidir
openai,elevenlabsvemicrosoftsentez uygulamalarının sahibidirvoice-call, telefoni TTS çalışma zamanı yardımcısını tüketir
Çok yetenekli şirket Plugin örneği
Bir şirket Plugin’i dışarıdan bakıldığında bütünlüklü hissettirmelidir. OpenClaw modeller, konuşma, gerçek zamanlı transkripsiyon, gerçek zamanlı ses, medya anlama, görüntü oluşturma, video oluşturma, web getirme ve web araması için paylaşılan sözleşmelere sahipse, bir vendor tüm yüzeylerini tek bir yerde sahiplenebilir:- vendor yüzeyinin sahibi tek bir Plugin’dir
- çekirdek hâlâ yetenek sözleşmelerinin sahibidir
- kanallar ve özellik Plugin’leri vendor kodunu değil,
api.runtime.*yardımcılarını tüketir - sözleşme testleri, Plugin’in sahip olduğunu iddia ettiği yetenekleri kaydettiğini doğrulayabilir
Yetenek örneği: video anlama
OpenClaw zaten görüntü/ses/video anlamayı tek bir paylaşılan yetenek olarak ele alır. Aynı sahiplik modeli burada da geçerlidir:Vendor plugins register
Vendor Plugin’leri uygun olduğunda
describeImage, transcribeAudio ve describeVideo kaydeder.api.registerVideoGenerationProvider(...) uygulamalarını kaydeder.
Somut bir dağıtım kontrol listesi mi gerekiyor? Yetenek Cookbook bölümüne bakın.
Sözleşmeler ve yaptırım
Plugin API yüzeyi kasıtlı olarak tipli veOpenClawPluginApi içinde merkezîdir. Bu sözleşme, desteklenen kayıt noktalarını ve bir Plugin’in güvenebileceği çalışma zamanı yardımcılarını tanımlar.
Bunun neden önemli olduğu:
- Plugin yazarları tek bir kararlı iç standart elde eder
- çekirdek, iki Plugin’in aynı sağlayıcı kimliğini kaydetmesi gibi yinelenen sahipliği reddedebilir
- başlatma, hatalı biçimlendirilmiş kayıt için eyleme geçirilebilir tanılamalar gösterebilir
- sözleşme testleri paketlenmiş Plugin sahipliğini zorunlu kılabilir ve sessiz sapmayı önleyebilir
Çalışma zamanı kayıt zorlaması
Çalışma zamanı kayıt zorlaması
Plugin kayıt defteri, pluginler yüklenirken kayıtları doğrular. Örnekler: yinelenen sağlayıcı kimlikleri, yinelenen konuşma sağlayıcısı kimlikleri ve hatalı biçimlendirilmiş kayıtlar, tanımsız davranış yerine plugin tanıları üretir.
Sözleşme testleri
Sözleşme testleri
Paketlenmiş pluginler, test çalışmaları sırasında sözleşme kayıt defterlerinde yakalanır; böylece OpenClaw sahipliği açıkça doğrulayabilir. Bugün bu; model sağlayıcıları, konuşma sağlayıcıları, web arama sağlayıcıları ve paketlenmiş kayıt sahipliği için kullanılır.
Bir sözleşmede neler bulunmalı
- İyi sözleşmeler
- Kötü sözleşmeler
- tiplendirilmiş
- küçük
- yeteneğe özgü
- çekirdek tarafından sahiplenilen
- birden çok plugin tarafından yeniden kullanılabilir
- satıcı bilgisi olmadan kanallar/özellikler tarafından tüketilebilir
Yürütme modeli
Yerel OpenClaw pluginleri Gateway ile işlem içinde çalışır. Sandbox içinde değildirler. Yüklenmiş bir yerel plugin, çekirdek kodla aynı işlem düzeyi güven sınırına sahiptir. Uyumlu paketler varsayılan olarak daha güvenlidir, çünkü OpenClaw şu anda bunları metadata/içerik paketleri olarak ele alır. Geçerli sürümlerde bu çoğunlukla paketlenmiş Skills anlamına gelir. Paketlenmemiş pluginler için izin listeleri ve açık kurulum/yükleme yolları kullanın. Çalışma alanı pluginlerini üretim varsayılanları olarak değil, geliştirme zamanı kodu olarak değerlendirin. Paketlenmiş çalışma alanı paket adları için plugin kimliğini npm adına sabitleyin: varsayılan olarak@openclaw/<id> ya da paket özellikle daha dar bir plugin rolü sunuyorsa -provider, -plugin, -speech, -sandbox veya -media-understanding gibi onaylı tiplendirilmiş bir sonek kullanın.
Güven notu:
plugins.allow, kaynak kökenine değil plugin kimliklerine güvenir. Paketlenmiş bir plugin ile aynı kimliğe sahip bir çalışma alanı plugini, bu çalışma alanı plugini etkinleştirildiğinde/izin listesine alındığında paketlenmiş kopyayı bilinçli olarak gölgeler. Bu, yerel geliştirme, yama testi ve hotfix’ler için normal ve kullanışlıdır. Paketlenmiş-plugin güveni, kurulum metadatasından değil, kaynak anlık görüntüsünden — yükleme anında diskte bulunan manifest ve koddan — çözümlenir. Bozulmuş veya değiştirilmiş bir kurulum kaydı, paketlenmiş bir pluginin güven yüzeyini gerçek kaynağın beyan ettiğinin ötesine sessizce genişletemez.Dışa aktarım sınırı
OpenClaw, uygulama kolaylığı değil yetenekleri dışa aktarır. Yetenek kaydını herkese açık tutun. Sözleşme dışı yardımcı dışa aktarımları budayın:- paketlenmiş-plugine özgü yardımcı alt yollar
- herkese açık API olarak amaçlanmayan çalışma zamanı tesisatı alt yolları
- satıcıya özgü kolaylık yardımcıları
- uygulama ayrıntısı olan kurulum/onboarding yardımcıları
plugin-sdk/gateway-runtime, plugin-sdk/security-runtime ve plugin-sdk/plugin-config-runtime gibi genel SDK sözleşmelerine yükseltin.