NeboAI
NeboAI
Kom i gang

SKILL.md-referanse

Denne siden viser hver del av en ferdighet som Nebo leser: frontmatter-feltene, variablene den utvider, verktøyene ansatte bruker for å jobbe med ferdigheter, og miljøet skriptene kjører i.

Filformat

SKILL.md er UTF-8-tekst. Den begynner med en linje med tre bindestreker, deretter YAML-frontmatter, og så en avsluttende linje med tre bindestreker. Alt etter det er innholdet: Markdown-instruksjoner den ansatte får når den laster ferdigheten. Nebo finner filen etter navn uten å skille mellom store og små bokstaver.

---
name: expense-review
description: Check submitted expenses against the company policy and flag anything that needs a receipt or an approval. Use when someone asks to review expenses or a reimbursement request.
version: "1.2.0"
author: Example Co
license: MIT
tags: [finance, expenses]
triggers: [reimbursement, expense report]
platform: [macos, linux, windows]
capabilities: [network]
metadata:
  allowed_domains: [api.example.com]
  secrets:
    - key: EXAMPLE_API_KEY
      label: Example API key
      hint: Create one at https://example.com/settings/keys
      required: true
requires:
  - name: receipt-capture
    version: ">=1.0.0"
plugins:
  - name: example-ledger
    version: ">=2.0.0"
    optional: true
---

# Expense review

Follow the policy in references/policy.md ...

Frontmatter-felt

Bare name og description er obligatoriske. Et felt med feil type gjør hele filen ugyldig, så ferdigheten lastes ikke. Nøkler som ikke står her, ignoreres.

FeltTypeStandardBetydning
namestringobligatoriskIdentifikator. [a-z0-9-], ingen bindestrek først, sist eller dobbelt, maks 64 byte. Skal samsvare med mappenavnet.
descriptionstringobligatoriskHva ferdigheten gjør og når den skal brukes. Maks 1 024 byte. Vises i den ansattes ferdighetsliste og vurderes av find_skills.
versionstring"1.0.0"Semantisk versjon. Kontrolleres mot andre ferdigheters requires-intervaller. Sett den i anførselstegn.
triggersliste med strenger[]Ord og uttrykk som beskriver når ferdigheten er aktuell. Opptil tre vises i ferdighetslisten; alle teller i find_skills. De laster aldri en ferdighet av seg selv.
platformliste med strengerallemacos, linux, windows. Ferdigheten lastes bare der en av dem samsvarer.
capabilitiesliste med strenger[]network og storage utvider skriptsandkassen. Se Skriptsandkasse.
metadatamap{}Inneholder secrets og allowed_domains. Se nedenfor.
requiresliste med {name, version}[]Andre ferdigheter denne ferdigheten bygger på. name er det korte ferdighetsnavnet; version er et semver-intervall, standard "*".
pluginsliste med {name, version, optional}[]Tillegg denne ferdigheten bruker. version er som standard "*", optional er false.
dependenciesliste med strenger[]Korte navn på ferdigheter som må finnes.
priorityinteger0Bestemmer rekkefølgen på ferdigheter i administrasjonslister. Det påvirker ikke hvilken ferdighet en ansatt velger.
authorstring""Lagres for visning.
licensestring""Lagres for visning.
compatibilitystring""Fritekstmerknad, maks 500 byte.
tagsliste med strenger[]Lagres for visning.
allowed-toolsstring""En streng skilt med mellomrom. Lagres; håndheves ikke.

Når en ferdighet som er nevnt i requires eller dependencies, mangler eller er utenfor intervallet, eller et påkrevd tillegg ikke er installert, lastes ferdigheten likevel og merkes som redusert. Eieren ser hva som mangler.

Hemmeligheter

Oppgi påloggingsopplysningene en ferdighets skript trenger, under metadata.secrets. Eieren gir verdiene, og Nebo lagrer dem kryptert for den ferdigheten.

metadata:
  secrets:
    - key: EXAMPLE_API_KEY
      label: Example API key
      hint: Create one at https://example.com/settings/keys
      required: true
NøkkelBetydning
keyNavnet på miljøvariabelen skriptet mottar. Obligatorisk.
labelNavnet som vises for eieren.
hintHvor verdien kan hentes.
requiredNår true, nekter execute å kjøre ferdighetens skript før verdien er angitt. Standard false.

En ansatt angir en verdi med configure_skill. Du kan referere til en hemmelighet i brødteksten som ${secret.KEY}, men skript bør heller lese miljøvariabelen.

Malvariabler

Nebo erstatter disse variablene i innholdet når en ansatt laster ferdigheten. De erstattes ikke i andre filer; skript leser miljøvariabler i stedet.

VariabelVerdi
${NEBO_SKILL_DIR}Absolutt sti til ferdighetens mappe.
${NEBO_DATA_DIR}En skrivbar mappe for denne ferdigheten: <data>/appdata/skills/<name>. Opprettes ved første bruk.
${NEBO_USER_NAME}Eierens navn.
${NEBO_OS}Operativsystemet.
${NEBO_ARCH}Prosessorarkitekturen.
${plugin.SLUG_BIN}Stien til binærfilen for et oppgitt tillegg. Sluggen skrives med store bokstaver og med bindestreker som understreker: example-ledger blir ${plugin.EXAMPLE_LEDGER_BIN}.
${secret.KEY}Verdien til en oppgitt hemmelighet.
$ARGUMENTSargs som sendes til use_skill. Når innholdet ikke har $ARGUMENTS, legges argumentene til etter det.

Ferdighetsverktøy

Ansatte jobber med ferdigheter gjennom disse verktøyene. use_skill er alltid tilgjengelig; de andre lastes når en ansatt trenger dem.

VerktøyParametereHva det gjør
use_skillname, argsLaster en ferdighet. Returnerer det utvidede innholdet, mappestien og de første 20 filnavnene. Aktiverer en deaktivert ferdighet på nytt.
find_skillsqueryReturnerer opptil 10 ferdigheter rangert etter treff i navn, utløser og beskrivelse.
read_skill_filename, pathLeser en fil i ferdighetens mappe. Uten path vises filene og størrelsene deres.
save_skillname, contentSkriver en komplett SKILL.md til brukermappen for ferdigheter. Ferdigheter fra markedsplassen kan ikke overskrives.
delete_skillnameSletter en brukerferdighet.
install_skillcodeInstallerer en ferdighet fra markedsplassen med SKIL--installasjonskoden.
configure_skillname, key, valueAngir en hemmelighet. Uten key vises hva ferdigheten trenger.
rate_skillname, rating, reviewVurderer en ferdighet på markedsplassen fra 1 til 5.
read_skill_reviewsnameLeser anmeldelsene av en ferdighet på markedsplassen.
executeskill, script, args, timeoutKjører et skript fra en ferdighets mappe. Se Skriptsandkasse.

Skriptsandkasse

Verktøyet execute kjører ett skript fra en ferdighets mappe. Det velger kjøretidsmiljø ut fra filen.

SkriptKjøretidsmiljø
.pyPython, gjennom Nebos medfølgende uv når den finnes, ellers python3.
.ts, .jsNebos medfølgende Bun når den finnes, ellers node.
bin/<file> eller binaryKjøres direkte.
.shStøttes ikke.

Hver kjøring starter med et tomt miljø og disse variablene:

VariabelVerdi
SKILL_ARGSargs-objektet som JSON.
Hver hemmelighets keyDen dekrypterte verdien til hemmeligheten.
<PLUGIN>_BINStien til binærfilen for hvert oppgitt tillegg. Tilleggsmapper legges også til i PATH.
import json, os

args = json.loads(os.environ.get("SKILL_ARGS", "{}"))
api_key = os.environ["EXAMPLE_API_KEY"]
print(json.dumps({"checked": len(args.get("items", []))}))

Skriptet kjører i en midlertidig kopi av ferdighetsmappen, med et standard tidsavbrudd på 30 sekunder. På macOS og Linux kjører det i en sandkasse i operativsystemet:

  • Det kan ikke lese lagre for påloggingsopplysninger, nettleser- og nøkkelringdata eller Nebos egne innstillinger og database.
  • Det kan bare skrive til arbeidsmappen sin og /tmp/nebo. Funksjonen storage legger til Nebos datamappe.
  • Det har ingen nettverkstilgang. Funksjonen network tillater pakkeregistre og domenene som står i metadata.allowed_domains.

Filer og grenser

ElementRegel
RessurserAlle filer unntatt SKILL.md, manifest.json, signatures.json og punktumfiler.
Kjørbare filerFiler under scripts/ eller bin/, og en fil i roten med navnet binary.
StierRelativt til ferdighetsmappen. Stier med .. eller som går ut av mappen, avvises.
Deaktivert ferdighetEn mappe med SKILL.md.disabled i stedet for SKILL.md.
FerdighetslisteHver oppføring kuttes ved 250 tegn. Når hele listen overstiger 8 000 tegn, forkortes delte ferdigheter først; en ansatts egne ferdigheter beholder fullstendige oppføringer.

Grensene for filer du publiserer på markedsplassen, står på siden Publisering.