NeboAI
NeboAI
Začať

Referencia plugin.json

plugin.json je manifest, ktorý Nebo číta pri inštalácii a spúšťaní doplnku. Kľúče sú v tvare camelCase. Táto stránka uvádza každé pole, ktoré Nebo dnes číta, a čo robí.

Polia najvyššej úrovne

PoleTypPovinnéVýznam
idstringánoIdentifikátor doplnku v obchode. Počas vývoja použite slug.
slugstringánoStály identifikátor. [a-z0-9-], najviac 64 znakov, bez spojovníka na začiatku či na konci a bez zdvojeného spojovníka. Určuje názov nástroja plugin__<slug> a premennej <SLUG>_BIN.
namestringánoZobrazovaný názov. Uveďte službu, ku ktorej sa pripája.
versionstringánoSémantická verzia, napríklad 0.1.0.
platformsmapánoKľúč platformy priradený k binárnemu súboru. Pozrite Platformy.
descriptionstringnieJedna veta pre ľudí aj zamestnancov.
authorstringnieNázov vydavateľa.
categorystringniePomáha zamestnancom doplnok nájsť.
triggerszoznam reťazcovnieSlová, ktoré opisujú, kedy sa doplnok uplatní. Používajú sa v tipoch pri vyhľadávaní.
entrySkillszoznam reťazcovniePribalené zručnosti, ktoré sa v popise nástroja doplnku uvedú ako prvé.
dependencieszoznam {name, version, optional}nieĎalšie doplnky, ktoré tento doplnok spúšťa. version má predvolenú hodnotu "*"; optional hodnotu false. Ich cesty <SLUG>_BIN sa nastavia pri každom volaní.
authobjectniePrihlásenie a účty. Pozrite Overovanie.
capabilitiesobjectnieconfigSchema, hooks, commands, routes, providers.
permissionsobjectnieFiltrovanie prostredia a horná hranica časového limitu.
eventslistnieSledovače, ktoré napájajú pracovné postupy zamestnancov.
interfaceBindingsmapnieTypové operácie, ktoré doplnok poskytuje.
channelobjectnieTrvalý most k službe na posielanie správ.
setupobjectniePodrobný sprievodca nastavením.

Nebo overuje inštalácie z obchodu: pravidlá pre slug, sémantickú verziu, aspoň jednu platformu, binaryName bez oddeľovačov cesty a bez .., príkaz login, ak auth.type nie je env, neprázdne názvy udalostí a príkazy a šablóny väzieb, ktoré sa dajú spracovať. Doplnky v adresári používateľských doplnkov overovanie preskakujú.

Platformy

Kľúče sú darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 a windows-amd64. Každá položka má všetkých päť polí uvedených nižšie. Pri zverejnení obchod zapíše skutočný hash, veľkosť, podpis a URL na stiahnutie, preto ich v nahrávanom súbore nechajte prázdne.

"platforms": {
  "darwin-arm64":  { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "linux-amd64":   { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
}
PoleVýznam
binaryNameNázov spustiteľného súboru. Vo Windows pridajte .exe.
sha256Hash binárneho súboru. Overuje sa pri inštalácii.
signaturePodpis binárneho súboru. Overuje sa pri inštalácii, keď je k dispozícii podpisový kľúč.
sizeVeľkosť v bajtoch.
downloadUrlOdkiaľ Nebo stiahne balík.

Overovanie

PoleVýznam
typeoauth_cli pre prihlásenie v prehliadači, ktoré riadi doplnok; env pre prihlasovacie údaje zadané ako hodnoty; neboai na prijatie tokenu NeboAI vlastníka v každom kľúči auth.env, ktorý končí na _TOKEN.
envMapa názvov premenných na predvolené hodnoty. Zároveň jediné názvy prihlasovacích údajov, ktoré Nebo odovzdá príkazu login.
commands.loginPrihlási. Povinné, ak type nie je env. Spúšťa sa s nastaveným priečinkom účtu.
commands.statusVypíše JSON, ktorý hovorí, či je účet prihlásený.
commands.refreshObnoví token bez interakcie.
commands.logoutOdhlási. Spustiť ho môže iba vlastník.
profileDirEnvPremenná, ktorá dostane samostatný priečinok s prihlasovacími údajmi pre každého zamestnanca a účet. Bez nej má doplnok jeden spoločný účet.
label, descriptionText na karte pripojenia.
help{url, urlLabel, text} zobrazené počas pripájania.
publicRedirectNastavte true, keď poskytovateľ odmieta presmerovania na http://localhost; prihlásenie potom prebehne cez verejné presmerovanie NeboAI.

Nebo vo výstupe stavu prečíta prvé z polí authenticated, isAuthenticated, logged_in, loggedIn alebo token_valid. Neprázdne token_error alebo hodnota none v credential_source, auth_method, storage či status znamená, že účet je odhlásený. Príkaz stavu má 45 sekúnd.

{"authenticated": true, "account": "finance@example.com"}

configSchema

capabilities.configSchema opisuje hodnoty, ktoré vlastník pre doplnok nastaví. Každá hodnota sa k binárnemu súboru dostane ako premenná prostredia s názvom podľa key. Pri kľúčoch prihlasovacích údajov uvedených aj v auth.env schéma pomenúva polia formulára pripojenia pre jednotlivých zamestnancov.

PoleTypPredvolenéVýznam
keystringpovinnéNázov premennej prostredia.
labelstringpovinnéOznačenie poľa.
descriptionstring""Text pomocníka.
fieldTypestring"string"Typ vstupu, napríklad string, number, boolean, select alebo password.
defaultstringžiadnePredvyplnená hodnota.
requiredbooleanfalseDoplnok nie je pripravený, kým sa hodnota nenastaví.
secretbooleanfalseHodnota je pri spätnom načítaní skrytá.
optionszoznam reťazcovžiadneMožnosti pre select.

permissions

PolePredvolenéVýznam
envAllow[]Zdedené premenné, ktoré doplnok smie vidieť. Prázdne povoľuje všetky.
envDeny[]Zdedené premenné, ktoré sa vždy odstránia.
maxTimeoutSeconds300Horná hranica časového limitu každého volania.
networkfalseDeklaruje používanie siete. Iba informatívne; nevynucuje sa.

events

Udalosť je dlhodobo bežiaci sledovač. Nebo ho spustí, keď ho sleduje pracovný postup zamestnanca, a reštartuje ho, ak skončí. Každý riadok, ktorý sledovač zapíše na stdout, je jedna udalosť. Názov udalosti dostane pri behu predponu so slugom, takže z note.created sa stane notes-sync.note.created.

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
PoleVýznam
nameNázov udalosti bez slugu. Povinné.
commandArgumenty, ktoré spúšťajú sledovač. Povinné. {{key}} sa nahradí vstupnými hodnotami zamestnanca.
descriptionČo udalosť vyvoláva.
multiplexedPri true jeden sledovač vysiela viac typov udalostí a každý riadok obsahuje pole "event".

Pracovné postupy sa na udalosti prihlasujú spúšťačom watch. Pozrite Spúšťače.

interfaceBindings

Väzba priraďuje operáciu rozhrania jednému z vašich príkazov. Z každej väzby sa stane typový nástroj pre zamestnancov, pomenovaný podľa operácie malými písmenami, s bodkami a spojovníkmi nahradenými podčiarkovníkmi: z notes.search sa stane notes_search. Väzbami doplnok spĺňa schopnosti, ktoré zamestnanec vyžaduje; pozrite Schopnosti.

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
Zástupný symbolRozvinie sa na
{field}Hodnota poľa ako jedno slovo. Pole sa zároveň neodovzdá ako prepínač.
{field[]:--flag}Jedna dvojica --flag <item> pre každú položku v poli so zoznamom.
{field?:--flag}--flag <value>, keď je pole prítomné; nič, keď chýba.
{field:cents->dollars}Celočíselná suma v centoch zapísaná v dolároch.

Vstupné polia, ktoré šablóna neuvádza, sa pripoja ako --field value. Zástupné symboly zoznamov a voliteľných polí musia byť celé slová. K operácii, ktorá vyžaduje schválenie, sa nedá dostať volaním toho istého príkazu cez plugin__<slug>.

Háčiky, lomkové príkazy a trasy

"capabilities": {
  "hooks": [
    { "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
  ],
  "commands": [
    { "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
  ],
  "routes": [
    { "path": "/callback", "method": "GET", "command": "http callback" }
  ]
}

hooks

Hook spustí váš príkaz v určitom bode ťahu zamestnanca. Nebo zapíše JSON payload na stdin. Výstup hooku typu action sa ignoruje. Hook typu filter vráti {"payload": ..., "handled": false}; "handled": true zastaví ďalšie hooky. Chyby a vypršania časového limitu zachovajú predchádzajúci payload a nikdy neblokujú ťah. Po troch zlyhaniach za sebou sa hook na päť minút pozastaví.

PolePredvolenéVýznam
hookpovinnéJedno z tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue.
hookType"action"action alebo filter.
commandpovinnéArgumenty pre váš binárny súbor.
priority100Nižšie sa spustí skôr.
timeoutMs500Časový limit v milisekundách.

commands

S "slash": true sa po napísaní /name args do chatu priamo spustí command args, bez zamestnanca. Výstup je odpoveďou. Časový limit je 30 sekúnd.

routes

Trasa odpovedá na požiadavky HTTP na adrese /api/v1/plugins/<slug>/api/<path> na botovi, podľa zhody path a method. Telo požiadavky ide na stdin a váš stdout je odpoveďou. Časový limit je 30 sekúnd.

providers

Poskytovateľ pridáva zdroj chatových modelov. Deklarujte id, displayName, providerType, modelsCommand a chatCommand. Nebo pošle požiadavku na chat ako JSON na stdin príkazu chatCommand a streamované udalosti číta zo stdout ako JSON oddelený novými riadkami, najviac 300 sekúnd. Dnes sa používa iba streamovanie chatu.

channel

Kanál premosťuje službu na posielanie správ. Nebo udržiava command spustený, prichádzajúce správy číta z jeho stdout a odpovede zapisuje na jeho stdin, v oboch prípadoch ako JSON oddelený novými riadkami.

PolePredvolenéVýznam
commandpovinnéArgumenty, ktoré spúšťajú most.
name, description""Zobrazí sa v nastaveniach.
restartDelaySecs5Čakanie pred reštartom po páde.
sharedfalseJeden most pre všetkých zamestnancov; správy sa smerujú podľa mena zamestnanca a odpovede nesú identitu každého zamestnanca.
needsLocalApifalseOdovzdá mostu adresu lokálneho API bota, token a id zamestnanca. Vypnuté, pokiaľ to nepotrebujete.

setup

Sprievodca nastavením prevedie vlastníka krokmi, ktoré jeden formulár nepokryje. Hodnoty z krokov form vypĺňajú {{key}} v neskorších argumentoch generate. Hodnoty z krokov credentials sa ukladajú ako premenné prostredia doplnku.

"setup": {
  "title": "Connect Example Chat",
  "steps": [
    { "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
    { "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
    { "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
    { "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
  ]
}
Druh krokuPolia
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel. Zobrazí výstup príkazu na skopírovanie.
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand. Krok sa dokončí, keď verifyCommand uspeje.

Polia majú key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) a required.