Installare e usare i plugin
Guida per utenti finali all’aggiunta, all’abilitazione e alla risoluzione dei problemi dei plugin.
Creare plugin
Tutorial per il primo plugin con il manifest funzionante più piccolo.
Plugin di canale
Crea un plugin per canale di messaggistica.
Plugin di provider
Crea un plugin per provider di modelli.
Panoramica dell'SDK
Riferimento per la mappa degli import e l’API di registrazione.
Modello pubblico delle capacità
Le capacità sono il modello pubblico di plugin nativi dentro OpenClaw. Ogni plugin OpenClaw nativo si registra per uno o più tipi di capacità:| Capacità | Metodo di registrazione | Plugin di esempio |
|---|---|---|
| Inferenza testuale | api.registerProvider(...) | openai, anthropic |
| Backend di inferenza CLI | api.registerCliBackend(...) | openai, anthropic |
| Embeddings | api.registerEmbeddingProvider(...) | Plugin vettoriali di proprietà del provider |
| Voce | api.registerSpeechProvider(...) | elevenlabs, microsoft |
| Trascrizione in tempo reale | api.registerRealtimeTranscriptionProvider(...) | openai |
| Voce in tempo reale | api.registerRealtimeVoiceProvider(...) | openai |
| Comprensione dei media | api.registerMediaUnderstandingProvider(...) | openai, google |
| Origine delle trascrizioni | api.registerTranscriptSourceProvider(...) | discord |
| Generazione di immagini | api.registerImageGenerationProvider(...) | openai, google, fal, minimax |
| Generazione musicale | api.registerMusicGenerationProvider(...) | google, minimax |
| Generazione video | api.registerVideoGenerationProvider(...) | qwen |
| Recupero web | api.registerWebFetchProvider(...) | firecrawl |
| Ricerca web | api.registerWebSearchProvider(...) | google |
| Canale / messaggistica | api.registerChannel(...) | msteams, matrix |
| Rilevamento del Gateway | api.registerGatewayDiscoveryService(...) | bonjour |
Un plugin che registra zero capacità ma fornisce hook, strumenti, servizi di rilevamento o servizi in background è un plugin legacy solo hook. Questo schema è ancora pienamente supportato.
Posizione sulla compatibilità esterna
Il modello delle capacità è stato integrato nel core ed è usato oggi dai plugin inclusi/nativi, ma la compatibilità dei plugin esterni richiede ancora una soglia più rigorosa di “è esportato, quindi è congelato”.| Situazione del plugin | Indicazioni |
|---|---|
| Plugin esterni esistenti | Mantieni funzionanti le integrazioni basate su hook; questa è la base di compatibilità. |
| Nuovi plugin inclusi/nativi | Preferisci la registrazione esplicita delle capacità rispetto ad accessi specifici per vendor o a nuovi design solo hook. |
| Plugin esterni che adottano la registrazione delle capacità | Consentito, ma considera le superfici helper specifiche per capacità come in evoluzione, salvo quando la documentazione le segna come stabili. |
Forme dei plugin
OpenClaw classifica ogni plugin caricato in una forma basata sul suo comportamento effettivo di registrazione (non solo sui metadati statici):plain-capability
plain-capability
Registra esattamente un tipo di capacità (per esempio un plugin solo provider come
mistral).hybrid-capability
hybrid-capability
Registra più tipi di capacità (per esempio
openai possiede inferenza testuale, voce, comprensione dei media e generazione di immagini).hook-only
hook-only
Registra solo hook (tipizzati o personalizzati), nessuna capacità, strumento, comando o servizio.
non-capability
non-capability
Registra strumenti, comandi, servizi o route, ma nessuna capacità.
openclaw plugins inspect <id> per vedere la forma di un plugin e il dettaglio delle sue capacità. Vedi il riferimento CLI per i dettagli.
Hook legacy
L’hookbefore_agent_start resta supportato come percorso di compatibilità per i plugin solo hook. Plugin legacy reali dipendono ancora da esso.
Direzione:
- mantenerlo funzionante
- documentarlo come legacy
- preferire
before_model_resolveper il lavoro di override di modello/provider - preferire
before_prompt_buildper il lavoro di mutazione del prompt - rimuoverlo solo dopo il calo dell’uso reale e quando la copertura delle fixture dimostra la sicurezza della migrazione
Segnali di compatibilità
Quando eseguiopenclaw doctor o openclaw plugins inspect <id>, potresti vedere una di queste etichette:
| Segnale | Significato |
|---|---|
| config valid | La configurazione viene analizzata correttamente e i plugin si risolvono |
| compatibility advisory | Il plugin usa uno schema supportato ma più vecchio (ad es. hook-only) |
| legacy warning | Il plugin usa before_agent_start, che è deprecato |
| hard error | La configurazione non è valida o il plugin non è stato caricato |
hook-only né before_agent_start interromperanno oggi il tuo plugin: hook-only è consultivo e before_agent_start attiva solo un avviso. Questi segnali compaiono anche in openclaw status --all e openclaw plugins doctor.
Panoramica dell’architettura
Il sistema di plugin di OpenClaw ha quattro livelli:Manifest + rilevamento
OpenClaw trova plugin candidati da percorsi configurati, radici del workspace, radici globali dei plugin e plugin inclusi. Il rilevamento legge prima i manifest nativi
openclaw.plugin.json più i manifest dei bundle supportati.Abilitazione + validazione
Il core decide se un plugin rilevato è abilitato, disabilitato, bloccato o selezionato per uno slot esclusivo come la memoria.
Caricamento a runtime
I plugin OpenClaw nativi vengono caricati nello stesso processo e registrano capacità in un registro centrale. Il JavaScript pacchettizzato viene caricato tramite
require nativo; il TypeScript di sorgenti locali di terze parti è il fallback di emergenza Jiti. I bundle compatibili vengono normalizzati in record di registro senza importare codice runtime.- i metadati al momento del parsing vengono da
registerCli(..., { descriptors: [...] }) - il modulo CLI reale del plugin può restare lazy e registrarsi alla prima invocazione
- la validazione di manifest/configurazione deve funzionare da metadati di manifest/schema senza eseguire codice del plugin
- il rilevamento delle capacità native può caricare codice di entry del plugin attendibile per costruire uno snapshot del registro non attivante
- il comportamento runtime nativo viene dal percorso
register(api)del modulo del plugin conapi.registrationMode === "full"
Snapshot dei metadati del plugin e tabella di lookup
L’avvio del Gateway costruisce unPluginMetadataSnapshot per lo snapshot di configurazione corrente. Lo snapshot contiene solo metadati: archivia l’indice dei plugin installati, il registro dei manifest, la diagnostica dei manifest, le mappe dei proprietari, un normalizzatore degli id dei plugin e i record dei manifest. Non contiene moduli di plugin caricati, SDK dei provider, contenuti dei pacchetti o esportazioni runtime.
La validazione della configurazione consapevole dei plugin, l’abilitazione automatica all’avvio e il bootstrap dei plugin del Gateway consumano quello snapshot invece di ricostruire indipendentemente i metadati di manifest/indice. PluginLookUpTable deriva dallo stesso snapshot e aggiunge il piano dei plugin di avvio per la configurazione runtime corrente.
Dopo l’avvio, Gateway mantiene lo snapshot dei metadati corrente come prodotto runtime sostituibile. Il rilevamento ripetuto dei provider a runtime può prendere in prestito quello snapshot invece di ricostruire l’indice installato e il registro dei manifest per ogni passaggio del catalogo dei provider. Lo snapshot viene svuotato o sostituito allo spegnimento del Gateway, alle modifiche della configurazione/inventario plugin e alle scritture dell’indice installato; i chiamanti ripiegano sul percorso freddo di manifest/indice quando non esiste uno snapshot corrente compatibile. I controlli di compatibilità devono includere le radici di rilevamento dei plugin come plugins.load.paths e il workspace predefinito dell’agente, perché i plugin del workspace fanno parte dell’ambito dei metadati.
Lo snapshot e la tabella di lookup mantengono le decisioni ripetute di avvio sul percorso veloce:
- proprietà dei canali
- avvio differito dei canali
- id dei plugin di avvio
- proprietà di provider e backend CLI
- proprietà di provider di configurazione, alias di comando, provider del catalogo modelli e contratto di manifest
- validazione dello schema di configurazione del plugin e dello schema di configurazione del canale
- decisioni di abilitazione automatica all’avvio
PluginLookUpTable del Gateway. Quel percorso ora ricostruisce il registro su richiesta; preferisci passare la tabella di lookup corrente o un registro dei manifest esplicito attraverso i flussi runtime quando un chiamante ne ha già uno.
Pianificazione dell’attivazione
La pianificazione dell’attivazione fa parte del control plane. I chiamanti possono chiedere quali plugin sono rilevanti per un comando, provider, canale, route, harness agente o capacità concreti prima di caricare registri runtime più ampi. Il planner mantiene compatibile il comportamento corrente dei manifest:- i campi
activation.*sono suggerimenti espliciti per il planner providers,channels,commandAliases,setup.providers,contracts.toolse gli hook restano il fallback di titolarità del manifesto- l’API del planner solo-id resta disponibile per i chiamanti esistenti
- l’API del piano riporta etichette di motivo, così la diagnostica può distinguere i suggerimenti espliciti dal fallback di titolarità
Plugin di canale e lo strumento di messaggio condiviso
I plugin di canale non devono registrare uno strumento separato per inviare/modificare/reagire per le normali azioni di chat. OpenClaw mantiene un unico strumentomessage condiviso nel core, e i plugin di canale possiedono la scoperta e l’esecuzione specifiche del canale dietro di esso.
Il confine attuale è:
- il core possiede l’host dello strumento
messagecondiviso, il cablaggio del prompt, la contabilità di sessioni/thread e il dispatch dell’esecuzione - i plugin di canale possiedono la scoperta delle azioni con ambito, la scoperta delle capacità e tutti i frammenti di schema specifici del canale
- i plugin di canale possiedono la grammatica di conversazione della sessione specifica del provider, per esempio il modo in cui gli id di conversazione codificano gli id dei thread o ereditano dalle conversazioni padre
- i plugin di canale eseguono l’azione finale tramite il proprio adattatore di azione
ChannelMessageActionAdapter.describeMessageTool(...). Quella chiamata di scoperta unificata consente a un plugin di restituire insieme le sue azioni visibili, le capacità e i contributi di schema, così questi elementi non divergono.
Quando un parametro dello strumento di messaggio specifico del canale trasporta una sorgente multimediale, come un percorso locale o un URL multimediale remoto, il plugin dovrebbe restituire anche mediaSourceParams da describeMessageTool(...). Il core usa quell’elenco esplicito per applicare la normalizzazione dei percorsi sandbox e i suggerimenti di accesso ai media in uscita senza codificare rigidamente i nomi dei parametri posseduti dal plugin. Lì preferisci mappe con ambito di azione, non un unico elenco piatto per tutto il canale, così un parametro multimediale solo profilo non viene normalizzato su azioni non correlate come send.
Il core passa l’ambito di runtime in quel passaggio di scoperta. I campi importanti includono:
accountIdcurrentChannelIdcurrentThreadTscurrentMessageIdsessionKeysessionIdagentIdrequesterSenderIdin ingresso attendibile
message del core.
Ecco perché le modifiche di routing dell’embedded-runner restano comunque lavoro del plugin: il runner è responsabile di inoltrare l’identità corrente di chat/sessione nel confine di scoperta del plugin, così lo strumento message condiviso espone la superficie giusta posseduta dal canale per il turno corrente.
Per gli helper di esecuzione posseduti dal canale, i plugin in bundle dovrebbero mantenere il runtime di esecuzione dentro i propri moduli di estensione. Il core non possiede più i runtime delle azioni di messaggio Discord, Slack, Telegram o WhatsApp sotto src/agents/tools. Non pubblichiamo sottopercorsi separati plugin-sdk/*-action-runtime, e i plugin in bundle dovrebbero importare il proprio codice runtime locale direttamente dai moduli posseduti dalla loro estensione.
Lo stesso confine si applica in generale alle giunture SDK denominate per provider: il core non dovrebbe importare barrel di utilità specifici del canale per Slack, Discord, Signal, WhatsApp o estensioni simili. Se al core serve un comportamento, deve consumare il barrel api.ts / runtime-api.ts del plugin in bundle stesso oppure promuovere la necessità a una capacità generica ristretta nell’SDK condiviso.
I plugin in bundle seguono la stessa regola. Il runtime-api.ts di un plugin in bundle non dovrebbe riesportare la propria facade brandizzata openclaw/plugin-sdk/<plugin-id>. Quelle facade brandizzate restano shim di compatibilità per plugin esterni e consumatori più vecchi, ma i plugin in bundle dovrebbero usare esportazioni locali più sottopercorsi SDK generici e ristretti come openclaw/plugin-sdk/channel-policy, openclaw/plugin-sdk/runtime-store o openclaw/plugin-sdk/webhook-ingress. Il nuovo codice non dovrebbe aggiungere facade SDK specifiche per id di plugin a meno che il confine di compatibilità per un ecosistema esterno esistente lo richieda.
Per i sondaggi nello specifico, ci sono due percorsi di esecuzione:
outbound.sendPollè la baseline condivisa per i canali che rientrano nel modello comune di sondaggioactions.handleAction("poll")è il percorso preferito per semantiche di sondaggio specifiche del canale o parametri extra del sondaggio
Modello di titolarità delle capacità
OpenClaw tratta un plugin nativo come il confine di titolarità per una azienda o una funzionalità, non come un contenitore eterogeneo di integrazioni non correlate. Questo significa:- un plugin aziendale dovrebbe di solito possedere tutte le superfici rivolte a OpenClaw di quell’azienda
- un plugin di funzionalità dovrebbe di solito possedere l’intera superficie della funzionalità che introduce
- i canali dovrebbero consumare capacità core condivise invece di reimplementare comportamento del provider ad hoc
Vendor multi-capability
Vendor multi-capability
openai possiede inferenza testuale, voce, voce realtime, comprensione dei media e generazione di immagini. google possiede inferenza testuale più comprensione dei media, generazione di immagini e ricerca web. qwen possiede inferenza testuale più comprensione dei media e generazione video.Vendor single-capability
Vendor single-capability
elevenlabs e microsoft possiedono la voce; firecrawl possiede il web-fetch; minimax / mistral / moonshot / zai possiedono backend di comprensione dei media.Feature plugin
Feature plugin
voice-call possiede trasporto delle chiamate, strumenti, CLI, route e bridging dei media stream Twilio, ma consuma capacità condivise di voce, trascrizione realtime e voce realtime invece di importare direttamente plugin vendor.- OpenAI vive in un solo plugin anche se copre modelli testuali, voce, immagini e video futuri
- un altro vendor può fare lo stesso per la propria area di superficie
- ai canali non importa quale plugin vendor possiede il provider; consumano il contratto di capacità condiviso esposto dal core
- plugin = confine di titolarità
- capacità = contratto core che più plugin possono implementare o consumare
Questo mantiene esplicita la titolarità evitando al tempo stesso comportamento del core che dipende da un singolo vendor o da un percorso di codice specifico di un plugin una tantum.
Stratificazione delle capacità
Usa questo modello mentale quando decidi dove appartiene il codice:- Core capability layer
- Vendor plugin layer
- Channel/feature plugin layer
Orchestrazione condivisa, policy, fallback, regole di merge della configurazione, semantiche di consegna e contratti tipizzati.
- il core possiede la policy TTS al momento della risposta, l’ordine di fallback, le preferenze e la consegna al canale
openai,elevenlabsemicrosoftpossiedono le implementazioni di sintesivoice-callconsuma l’helper runtime TTS per telefonia
Esempio di plugin aziendale multi-capacità
Un plugin aziendale dovrebbe risultare coeso dall’esterno. Se OpenClaw ha contratti condivisi per modelli, voce, trascrizione realtime, voce realtime, comprensione dei media, generazione di immagini, generazione video, fetch web e ricerca web, un vendor può possedere tutte le sue superfici in un solo posto:- un plugin possiede la superficie del vendor
- il core possiede comunque i contratti delle capacità
- i canali e i plugin di funzionalità consumano helper
api.runtime.*, non codice vendor - i test di contratto possono verificare che il plugin abbia registrato le capacità che dichiara di possedere
Esempio di capacità: comprensione video
OpenClaw tratta già la comprensione di immagini/audio/video come un’unica capacità condivisa. Lo stesso modello di titolarità si applica lì:Vendor plugins register
I plugin vendor registrano
describeImage, transcribeAudio e describeVideo quando applicabile.api.registerVideoGenerationProvider(...) su di esso.
Serve una checklist concreta di rollout? Vedi Ricettario delle capacità.
Contratti e applicazione
La superficie dell’API del plugin è intenzionalmente tipizzata e centralizzata inOpenClawPluginApi. Quel contratto definisce i punti di registrazione supportati e gli helper runtime su cui un plugin può fare affidamento.
Perché è importante:
- gli autori di plugin ottengono uno standard interno stabile
- il core può rifiutare titolarità duplicate, come due plugin che registrano lo stesso id provider
- l’avvio può mostrare diagnostica azionabile per registrazioni malformate
- i test di contratto possono applicare la titolarità dei plugin in bundle e prevenire derive silenziose
Applicazione della registrazione runtime
Applicazione della registrazione runtime
Il registro dei Plugin convalida le registrazioni durante il caricamento dei Plugin. Esempi: ID provider duplicati, ID provider vocali duplicati e registrazioni non valide producono diagnostica dei Plugin invece di comportamento indefinito.
Test di contratto
Test di contratto
I Plugin inclusi vengono acquisiti nei registri di contratto durante le esecuzioni dei test, così OpenClaw può dichiarare esplicitamente la proprietà. Oggi questo viene usato per provider di modelli, provider vocali, provider di ricerca web e proprietà delle registrazioni incluse.
Cosa appartiene a un contratto
- Contratti validi
- Contratti non validi
- tipizzati
- piccoli
- specifici della capacità
- di proprietà del core
- riutilizzabili da più Plugin
- consumabili da canali/funzionalità senza conoscenza del fornitore
Modello di esecuzione
I Plugin nativi di OpenClaw vengono eseguiti in-process con il Gateway. Non sono in sandbox. Un Plugin nativo caricato ha lo stesso confine di fiducia a livello di processo del codice core. I bundle compatibili sono più sicuri per impostazione predefinita perché OpenClaw attualmente li tratta come pacchetti di metadati/contenuti. Nelle versioni attuali, questo significa principalmente Skills inclusi. Usa allowlist e percorsi espliciti di installazione/caricamento per i Plugin non inclusi. Tratta i Plugin dell’area di lavoro come codice per il tempo di sviluppo, non come impostazioni predefinite di produzione. Per i nomi dei pacchetti dell’area di lavoro inclusi, mantieni l’ID del Plugin ancorato al nome npm:@openclaw/<id> per impostazione predefinita, oppure un suffisso tipizzato approvato come -provider, -plugin, -speech, -sandbox o -media-understanding quando il pacchetto espone intenzionalmente un ruolo di Plugin più ristretto.
Nota di fiducia:
plugins.allow considera attendibili gli ID dei Plugin, non la provenienza della sorgente. Un Plugin dell’area di lavoro con lo stesso ID di un Plugin incluso oscura intenzionalmente la copia inclusa quando quel Plugin dell’area di lavoro è abilitato/in allowlist. Questo è normale e utile per lo sviluppo locale, i test di patch e gli hotfix. La fiducia nei Plugin inclusi viene risolta dallo snapshot sorgente — il manifesto e il codice su disco al momento del caricamento — anziché dai metadati di installazione. Un record di installazione corrotto o sostituito non può ampliare silenziosamente la superficie di fiducia di un Plugin incluso oltre quanto dichiarato dalla sorgente effettiva.Confine di esportazione
OpenClaw esporta capacità, non comodità implementative. Mantieni pubblica la registrazione delle capacità. Riduci le esportazioni di helper non contrattuali:- sottopercorsi helper specifici dei Plugin inclusi
- sottopercorsi di plumbing runtime non destinati a essere API pubblica
- helper di comodità specifici del fornitore
- helper di configurazione/onboarding che sono dettagli implementativi
plugin-sdk/gateway-runtime, plugin-sdk/security-runtime e plugin-sdk/plugin-config-runtime.