Install and use plugins
Eindgebruikershandleiding voor het toevoegen, inschakelen en oplossen van problemen met plugins.
Building plugins
Tutorial voor je eerste Plugin met het kleinste werkende manifest.
Channel plugins
Bouw een messagingkanaal-Plugin.
Provider plugins
Bouw een modelprovider-Plugin.
SDK overview
Importmap en API-referentie voor registratie.
Publiek capabilitymodel
Capabilities zijn het publieke model voor native Plugins binnen OpenClaw. Elke native OpenClaw-Plugin registreert zich voor een of meer capabilitytypen:| Capability | Registratiemethode | Voorbeeldplugins |
|---|---|---|
| Tekstinferentie | api.registerProvider(...) | openai, anthropic |
| CLI-inferentiebackend | api.registerCliBackend(...) | openai, anthropic |
| Embeddings | api.registerEmbeddingProvider(...) | Vectorplugins van providers |
| Spraak | api.registerSpeechProvider(...) | elevenlabs, microsoft |
| Realtime transcriptie | api.registerRealtimeTranscriptionProvider(...) | openai |
| Realtime stem | api.registerRealtimeVoiceProvider(...) | openai |
| Mediabegrip | api.registerMediaUnderstandingProvider(...) | openai, google |
| Transcriptbron | api.registerTranscriptSourceProvider(...) | discord |
| Afbeeldingen genereren | api.registerImageGenerationProvider(...) | openai, google, fal, minimax |
| Muziek genereren | api.registerMusicGenerationProvider(...) | google, minimax |
| Video genereren | api.registerVideoGenerationProvider(...) | qwen |
| Web ophalen | api.registerWebFetchProvider(...) | firecrawl |
| Web zoeken | api.registerWebSearchProvider(...) | google |
| Kanaal / messaging | api.registerChannel(...) | msteams, matrix |
| Gateway-discovery | api.registerGatewayDiscoveryService(...) | bonjour |
Een Plugin die nul capabilities registreert maar hooks, tools, discoveryservices of achtergrondservices biedt, is een legacy hook-only Plugin. Dat patroon wordt nog steeds volledig ondersteund.
Standpunt over externe compatibiliteit
Het capabilitymodel is in core geland en wordt vandaag gebruikt door gebundelde/native Plugins, maar compatibiliteit voor externe Plugins heeft nog steeds een hogere lat nodig dan “het is geëxporteerd, dus het is bevroren.”| Pluginsituatie | Richtlijn |
|---|---|
| Bestaande externe Plugins | Houd hook-gebaseerde integraties werkend; dit is de compatibiliteitsbasis. |
| Nieuwe gebundelde/native Plugins | Geef de voorkeur aan expliciete capabilityregistratie boven vendorspecifieke reach-ins of nieuwe hook-only ontwerpen. |
| Externe Plugins die capabilityregistratie gebruiken | Toegestaan, maar behandel capabilityspecifieke helperoppervlakken als in ontwikkeling tenzij docs ze als stabiel markeren. |
Plugin-vormen
OpenClaw classificeert elke geladen Plugin in een vorm op basis van het daadwerkelijke registratiegedrag (niet alleen statische metadata):plain-capability
plain-capability
Registreert precies één capabilitytype (bijvoorbeeld een provider-only Plugin zoals
mistral).hybrid-capability
hybrid-capability
Registreert meerdere capabilitytypen (bijvoorbeeld
openai beheert tekstinferentie, spraak, mediabegrip en afbeeldingen genereren).hook-only
hook-only
Registreert alleen hooks (getypeerd of aangepast), geen capabilities, tools, commands of services.
non-capability
non-capability
Registreert tools, commands, services of routes, maar geen capabilities.
openclaw plugins inspect <id> om de vorm en capability-uitsplitsing van een Plugin te zien. Zie CLI-referentie voor details.
Legacy hooks
De hookbefore_agent_start blijft ondersteund als compatibiliteitspad voor hook-only Plugins. Legacy Plugins uit de praktijk zijn er nog steeds van afhankelijk.
Richting:
- houd het werkend
- documenteer het als legacy
- geef voor model-/provider-overridewerk de voorkeur aan
before_model_resolve - geef voor promptmutatiewerk de voorkeur aan
before_prompt_build - verwijder het alleen nadat echt gebruik is gedaald en fixturedekking migratieveiligheid bewijst
Compatibiliteitssignalen
Wanneer jeopenclaw doctor of openclaw plugins inspect <id> uitvoert, kun je een van deze labels zien:
| Signaal | Betekenis |
|---|---|
| config valid | Config wordt goed geparsed en Plugins worden opgelost |
| compatibility advisory | Plugin gebruikt een ondersteund maar ouder patroon (bijv. hook-only) |
| legacy warning | Plugin gebruikt before_agent_start, dat deprecated is |
| hard error | Config is ongeldig of Plugin kon niet worden geladen |
hook-only, noch before_agent_start breekt je Plugin vandaag: hook-only is adviserend, en before_agent_start triggert alleen een waarschuwing. Deze signalen verschijnen ook in openclaw status --all en openclaw plugins doctor.
Architectuuroverzicht
Het Plugin-systeem van OpenClaw heeft vier lagen:Manifest + discovery
OpenClaw vindt kandidaat-Plugins via geconfigureerde paden, workspaceroots, globale Plugin-roots en gebundelde Plugins. Discovery leest eerst native
openclaw.plugin.json-manifesten plus ondersteunde bundelmanifests.Enablement + validation
Core beslist of een gevonden Plugin is ingeschakeld, uitgeschakeld, geblokkeerd of geselecteerd voor een exclusieve slot zoals geheugen.
Runtime loading
Native OpenClaw-Plugins worden in-process geladen en registreren capabilities in een centraal register. Verpakte JavaScript laadt via native
require; lokale TypeScript-broncode van derden is de noodfallback via Jiti. Compatibele bundels worden genormaliseerd naar registerrecords zonder runtimecode te importeren.- parse-time metadata komt uit
registerCli(..., { descriptors: [...] }) - de echte Plugin-CLI-module kan lazy blijven en zich registreren bij de eerste aanroep
- manifest-/configvalidatie moet werken op basis van manifest-/schemametadata zonder Plugin-code uit te voeren
- native capability-discovery mag vertrouwde Plugin-entrycode laden om een niet-activerende registersnapshot te bouwen
- native runtimegedrag komt uit het pad
register(api)van de Plugin-module metapi.registrationMode === "full"
Snapshot van Plugin-metadata en opzoektabel
Bij Gateway-startup wordt éénPluginMetadataSnapshot gebouwd voor de huidige configsnapshot. De snapshot bevat alleen metadata: hij bewaart de geïnstalleerde Plugin-index, manifestregister, manifestdiagnoses, ownermaps, een Plugin-id-normalizer en manifestrecords. Hij bevat geen geladen Plugin-modules, provider-SDK’s, package-inhoud of runtimeexports.
Pluginbewuste configvalidatie, automatische inschakeling bij startup en Gateway-Plugin-bootstrap gebruiken die snapshot in plaats van manifest-/indexmetadata onafhankelijk opnieuw op te bouwen. PluginLookUpTable wordt afgeleid uit dezelfde snapshot en voegt het startup-Pluginplan toe voor de huidige runtimeconfig.
Na startup houdt Gateway de huidige metadatasnapshot als een vervangbaar runtimeproduct. Herhaalde runtime-providerdiscovery kan die snapshot lenen in plaats van voor elke provider-catalogpass de geïnstalleerde index en het manifestregister opnieuw te construeren. De snapshot wordt gewist of vervangen bij Gateway-shutdown, config-/Plugin-inventariswijzigingen en schrijfacties naar de geïnstalleerde index; callers vallen terug op het koude manifest-/indexpad wanneer er geen compatibele huidige snapshot bestaat. Compatibiliteitscontroles moeten Plugin-discoveryroots bevatten zoals plugins.load.paths en de standaard agentworkspace, omdat workspace-Plugins deel uitmaken van de metadatascope.
De snapshot en opzoektabel houden herhaalde startupbeslissingen op het snelle pad:
- kanaaleigenaarschap
- uitgestelde kanaalstartup
- startup-Plugin-id’s
- eigenaarschap van provider- en CLI-backend
- eigenaarschap van setupprovider, commandalias, modelcatalogusprovider en manifestcontract
- validatie van Plugin-configschema en kanaalconfigschema
- beslissingen voor automatische inschakeling bij startup
PluginLookUpTable te ontvangen. Dat pad reconstrueert het register nu on demand; geef de voorkeur aan het doorgeven van de huidige opzoektabel of een expliciet manifestregister door runtimeflows wanneer een caller er al een heeft.
Activeringsplanning
Activeringsplanning maakt deel uit van het control plane. Callers kunnen vragen welke Plugins relevant zijn voor een concreet command, provider, kanaal, route, agentharnas of capability voordat bredere runtimeregisters worden geladen. De planner houdt huidig manifestgedrag compatibel:activation.*-velden zijn expliciete planner-hintsproviders,channels,commandAliases,setup.providers,contracts.toolsen hooks blijven de manifest-eigendomsterugval- de ids-only planner-API blijft beschikbaar voor bestaande aanroepers
- de plan-API rapporteert redenlabels zodat diagnostiek expliciete hints kan onderscheiden van eigendomsterugval
Kanaalplugins en de gedeelde berichttool
Kanaalplugins hoeven geen aparte tool voor verzenden/bewerken/reageren te registreren voor normale chatacties. OpenClaw behoudt één gedeeldemessage-tool in de core, en kanaalplugins zijn eigenaar van de kanaalspecifieke ontdekking en uitvoering erachter.
De huidige grens is:
- core is eigenaar van de gedeelde
message-toolhost, prompt-bedrading, sessie-/threadboekhouding en uitvoeringsdispatch - kanaalplugins zijn eigenaar van scoped actiedetectie, capability-detectie en eventuele kanaalspecifieke schemafragmenten
- kanaalplugins zijn eigenaar van provider-specifieke sessiegespreksgrammatica, zoals hoe gesprek-id’s thread-id’s coderen of overnemen van bovenliggende gesprekken
- kanaalplugins voeren de uiteindelijke actie uit via hun actie-adapter
ChannelMessageActionAdapter.describeMessageTool(...). Met die uniforme ontdekkingaanroep kan een Plugin zijn zichtbare acties, capabilities en schemabijdragen samen teruggeven, zodat die onderdelen niet uit elkaar gaan lopen.
Wanneer een kanaalspecifieke message-toolparameter een mediabron bevat, zoals een lokaal pad of externe media-URL, moet de Plugin ook mediaSourceParams retourneren vanuit describeMessageTool(...). Core gebruikt die expliciete lijst om sandbox-padnormalisatie en outbound media-access hints toe te passen zonder plugin-eigen parameternamen te hardcoden. Geef daar de voorkeur aan actie-scoped maps, niet aan één kanaalbrede platte lijst, zodat een media-parameter die alleen voor profielen geldt niet wordt genormaliseerd bij niet-gerelateerde acties zoals send.
Core geeft runtime-scope door aan die ontdekkingsstap. Belangrijke velden zijn onder andere:
accountIdcurrentChannelIdcurrentThreadTscurrentMessageIdsessionKeysessionIdagentId- vertrouwde inkomende
requesterSenderId
message-tool te hardcoden.
Daarom blijven embedded-runner-routeringswijzigingen Plugin-werk: de runner is verantwoordelijk voor het doorsturen van de huidige chat-/sessie-identiteit naar de Plugin-ontdekkingsgrens, zodat de gedeelde message-tool het juiste kanaaleigen oppervlak voor de huidige beurt exposeert.
Voor kanaaleigen uitvoeringshelpers moeten gebundelde plugins de uitvoeringsruntime binnen hun eigen extensiemodules houden. Core is niet langer eigenaar van de Discord-, Slack-, Telegram- of WhatsApp-message-action-runtimes onder src/agents/tools. We publiceren geen aparte plugin-sdk/*-action-runtime-subpaden, en gebundelde plugins moeten hun eigen lokale runtimecode rechtstreeks importeren vanuit hun extensie-eigen modules.
Dezelfde grens geldt in het algemeen voor provider-genoemde SDK-naden: core moet geen kanaalspecifieke convenience-barrels importeren voor Slack, Discord, Signal, WhatsApp of vergelijkbare extensies. Als core gedrag nodig heeft, consumeer dan de eigen api.ts / runtime-api.ts-barrel van de gebundelde Plugin of promoveer de behoefte naar een smalle generieke capability in de gedeelde SDK.
Gebundelde plugins volgen dezelfde regel. De runtime-api.ts van een gebundelde Plugin mag niet zijn eigen branded openclaw/plugin-sdk/<plugin-id>-facade opnieuw exporteren. Die branded facades blijven compatibiliteitsshims voor externe plugins en oudere consumers, maar gebundelde plugins moeten lokale exports gebruiken plus smalle generieke SDK-subpaden zoals openclaw/plugin-sdk/channel-policy, openclaw/plugin-sdk/runtime-store of openclaw/plugin-sdk/webhook-ingress. Nieuwe code mag geen plugin-id-specifieke SDK-facades toevoegen, tenzij de compatibiliteitsgrens voor een bestaand extern ecosysteem dit vereist.
Specifiek voor polls zijn er twee uitvoeringspaden:
outbound.sendPollis de gedeelde baseline voor kanalen die passen bij het gangbare pollmodelactions.handleAction("poll")is het voorkeurspad voor kanaalspecifieke pollsemantiek of extra pollparameters
Capability-eigendomsmodel
OpenClaw behandelt een native Plugin als de eigendomsgrens voor een bedrijf of een feature, niet als een grabbelton met niet-gerelateerde integraties. Dat betekent:- een bedrijfsplugin moet doorgaans eigenaar zijn van alle OpenClaw-gerichte oppervlakken van dat bedrijf
- een feature-Plugin moet doorgaans eigenaar zijn van het volledige feature-oppervlak dat hij introduceert
- kanalen moeten gedeelde core-capabilities gebruiken in plaats van provider-gedrag ad hoc opnieuw te implementeren
Vendor met meerdere capabilities
Vendor met meerdere capabilities
openai is eigenaar van tekstinferentie, spraak, realtime spraak, mediabegrip en beeldgeneratie. google is eigenaar van tekstinferentie plus mediabegrip, beeldgeneratie en webzoekopdrachten. qwen is eigenaar van tekstinferentie plus mediabegrip en videogeneratie.Vendor met één capability
Vendor met één capability
elevenlabs en microsoft zijn eigenaar van spraak; firecrawl is eigenaar van web-fetch; minimax / mistral / moonshot / zai zijn eigenaar van backends voor mediabegrip.Feature-Plugin
Feature-Plugin
voice-call is eigenaar van call-transport, tools, CLI, routes en Twilio media-stream bridging, maar consumeert gedeelde capabilities voor spraak, realtime transcriptie en realtime spraak in plaats van vendorplugins rechtstreeks te importeren.- OpenAI leeft in één Plugin, zelfs als die tekstmodellen, spraak, beelden en toekomstige video omvat
- een andere vendor kan hetzelfde doen voor zijn eigen oppervlak
- kanalen maakt het niet uit welke vendorplugin eigenaar is van de provider; ze consumeren het gedeelde capability-contract dat door core wordt geëxposeerd
- Plugin = eigendomsgrens
- capability = core-contract dat meerdere plugins kunnen implementeren of consumeren
Dit houdt eigendom expliciet terwijl core-gedrag wordt vermeden dat afhankelijk is van één vendor of een eenmalig plugin-specifiek codepad.
Capability-lagen
Gebruik dit mentale model bij het bepalen waar code thuishoort:- Core-capabilitylaag
- Vendorpluginlaag
- Kanaal-/featurepluginlaag
Gedeelde orkestratie, beleid, fallback, regels voor config-merge, leveringssemantiek en getypeerde contracten.
- core is eigenaar van reply-time TTS-beleid, fallback-volgorde, voorkeuren en kanaallevering
openai,elevenlabsenmicrosoftzijn eigenaar van synthese-implementatiesvoice-callconsumeert de telephony TTS-runtimehelper
Voorbeeld van bedrijfsplugin met meerdere capabilities
Een bedrijfsplugin moet van buitenaf samenhangend aanvoelen. Als OpenClaw gedeelde contracten heeft voor modellen, spraak, realtime transcriptie, realtime spraak, mediabegrip, beeldgeneratie, videogeneratie, web-fetch en webzoekopdrachten, kan een vendor al zijn oppervlakken op één plek bezitten:- één Plugin is eigenaar van het vendoroppervlak
- core blijft eigenaar van de capability-contracten
- kanalen en featureplugins consumeren
api.runtime.*-helpers, geen vendorcode - contracttests kunnen bevestigen dat de Plugin de capabilities heeft geregistreerd waarvan hij claimt eigenaar te zijn
Capability-voorbeeld: videobegrip
OpenClaw behandelt beeld-/audio-/videobegrip al als één gedeelde capability. Daar geldt hetzelfde eigendomsmodel:Vendorplugins registreren
Vendorplugins registreren
describeImage, transcribeAudio en describeVideo waar van toepassing.api.registerVideoGenerationProvider(...)-implementaties erop.
Een concrete uitrolchecklist nodig? Zie Capability Cookbook.
Contracten en handhaving
Het plugin-API-oppervlak is bewust getypeerd en gecentraliseerd inOpenClawPluginApi. Dat contract definieert de ondersteunde registratiepunten en de runtimehelpers waarop een Plugin mag vertrouwen.
Waarom dit belangrijk is:
- plugin-auteurs krijgen één stabiele interne standaard
- core kan dubbele eigendom afwijzen, zoals twee plugins die dezelfde provider-id registreren
- opstarten kan bruikbare diagnostiek tonen voor verkeerd gevormde registratie
- contracttests kunnen eigendom van gebundelde plugins afdwingen en stille drift voorkomen
Handhaving van runtimeregistratie
Handhaving van runtimeregistratie
Het pluginregister valideert registraties terwijl plugins worden geladen. Voorbeelden: dubbele provider-id’s, dubbele spraakprovider-id’s en ongeldige registraties leveren plugindiagnostiek op in plaats van ongedefinieerd gedrag.
Contracttests
Contracttests
Gebundelde plugins worden tijdens testruns vastgelegd in contractregisters, zodat OpenClaw eigendom expliciet kan bevestigen. Vandaag wordt dit gebruikt voor modelproviders, spraakproviders, webzoekproviders en eigendom van gebundelde registraties.
Wat in een contract thuishoort
- Goede contracten
- Slechte contracten
- getypeerd
- klein
- mogelijkheden-specifiek
- eigendom van core
- herbruikbaar door meerdere plugins
- bruikbaar door kanalen/features zonder leverancierskennis
Uitvoeringsmodel
Native OpenClaw-plugins draaien in-process met de Gateway. Ze zijn niet gesandboxed. Een geladen native plugin heeft dezelfde vertrouwensgrens op procesniveau als core-code. Compatibele bundels zijn standaard veiliger, omdat OpenClaw ze momenteel behandelt als metadata-/contentpakketten. In huidige releases betekent dat vooral gebundelde Skills. Gebruik allowlists en expliciete installatie-/laadpaden voor niet-gebundelde plugins. Behandel workspace-plugins als code voor ontwikkeltijd, niet als productiestandaarden. Houd voor gebundelde workspace-pakketnamen de plugin-id verankerd in de npm-naam: standaard@openclaw/<id>, of een goedgekeurd getypeerd achtervoegsel zoals -provider, -plugin, -speech, -sandbox of -media-understanding wanneer het pakket bewust een smallere pluginrol blootlegt.
Vertrouwensnotitie:
plugins.allow vertrouwt plugin-id’s, niet de herkomst van de bron. Een workspace-plugin met dezelfde id als een gebundelde plugin overschaduwt bewust de gebundelde kopie wanneer die workspace-plugin is ingeschakeld/op de allowlist staat. Dit is normaal en nuttig voor lokale ontwikkeling, patchtests en hotfixes. Vertrouwen in gebundelde plugins wordt bepaald op basis van de bronmomentopname — het manifest en de code op schijf tijdens het laden — in plaats van installatiemetadata. Een beschadigde of vervangen installatierecord kan het vertrouwensoppervlak van een gebundelde plugin niet stilzwijgend uitbreiden buiten wat de daadwerkelijke bron claimt.Exportgrens
OpenClaw exporteert mogelijkheden, geen implementatiegemak. Houd mogelijkhedenregistratie openbaar. Snoei helperexports zonder contract:- helper-subpaden specifiek voor gebundelde plugins
- subpaden voor runtimebedrading die niet bedoeld zijn als openbare API
- leveranciersspecifieke gemakhelpers
- setup-/onboardinghelpers die implementatiedetails zijn
plugin-sdk/gateway-runtime, plugin-sdk/security-runtime en plugin-sdk/plugin-config-runtime.