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.
| Felt | Type | Standard | Betydning |
|---|---|---|---|
name | string | obligatorisk | Identifikator. [a-z0-9-], ingen bindestrek først, sist eller dobbelt, maks 64 byte. Skal samsvare med mappenavnet. |
description | string | obligatorisk | Hva ferdigheten gjør og når den skal brukes. Maks 1 024 byte. Vises i den ansattes ferdighetsliste og vurderes av find_skills. |
version | string | "1.0.0" | Semantisk versjon. Kontrolleres mot andre ferdigheters requires-intervaller. Sett den i anførselstegn. |
triggers | liste 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. |
platform | liste med strenger | alle | macos, linux, windows. Ferdigheten lastes bare der en av dem samsvarer. |
capabilities | liste med strenger | [] | network og storage utvider skriptsandkassen. Se Skriptsandkasse. |
metadata | map | {} | Inneholder secrets og allowed_domains. Se nedenfor. |
requires | liste med {name, version} | [] | Andre ferdigheter denne ferdigheten bygger på. name er det korte ferdighetsnavnet; version er et semver-intervall, standard "*". |
plugins | liste med {name, version, optional} | [] | Tillegg denne ferdigheten bruker. version er som standard "*", optional er false. |
dependencies | liste med strenger | [] | Korte navn på ferdigheter som må finnes. |
priority | integer | 0 | Bestemmer rekkefølgen på ferdigheter i administrasjonslister. Det påvirker ikke hvilken ferdighet en ansatt velger. |
author | string | "" | Lagres for visning. |
license | string | "" | Lagres for visning. |
compatibility | string | "" | Fritekstmerknad, maks 500 byte. |
tags | liste med strenger | [] | Lagres for visning. |
allowed-tools | string | "" | 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økkel | Betydning |
|---|---|
key | Navnet på miljøvariabelen skriptet mottar. Obligatorisk. |
label | Navnet som vises for eieren. |
hint | Hvor verdien kan hentes. |
required | Nå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.
| Variabel | Verdi |
|---|---|
${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. |
$ARGUMENTS | args 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øy | Parametere | Hva det gjør |
|---|---|---|
use_skill | name, args | Laster en ferdighet. Returnerer det utvidede innholdet, mappestien og de første 20 filnavnene. Aktiverer en deaktivert ferdighet på nytt. |
find_skills | query | Returnerer opptil 10 ferdigheter rangert etter treff i navn, utløser og beskrivelse. |
read_skill_file | name, path | Leser en fil i ferdighetens mappe. Uten path vises filene og størrelsene deres. |
save_skill | name, content | Skriver en komplett SKILL.md til brukermappen for ferdigheter. Ferdigheter fra markedsplassen kan ikke overskrives. |
delete_skill | name | Sletter en brukerferdighet. |
install_skill | code | Installerer en ferdighet fra markedsplassen med SKIL--installasjonskoden. |
configure_skill | name, key, value | Angir en hemmelighet. Uten key vises hva ferdigheten trenger. |
rate_skill | name, rating, review | Vurderer en ferdighet på markedsplassen fra 1 til 5. |
read_skill_reviews | name | Leser anmeldelsene av en ferdighet på markedsplassen. |
execute | skill, script, args, timeout | Kjø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.
| Skript | Kjøretidsmiljø |
|---|---|
.py | Python, gjennom Nebos medfølgende uv når den finnes, ellers python3. |
.ts, .js | Nebos medfølgende Bun når den finnes, ellers node. |
bin/<file> eller binary | Kjøres direkte. |
.sh | Støttes ikke. |
Hver kjøring starter med et tomt miljø og disse variablene:
| Variabel | Verdi |
|---|---|
SKILL_ARGS | args-objektet som JSON. |
Hver hemmelighets key | Den dekrypterte verdien til hemmeligheten. |
<PLUGIN>_BIN | Stien 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. Funksjonenstoragelegger til Nebos datamappe. - Det har ingen nettverkstilgang. Funksjonen
networktillater pakkeregistre og domenene som står imetadata.allowed_domains.
Filer og grenser
| Element | Regel |
|---|---|
| Ressurser | Alle filer unntatt SKILL.md, manifest.json, signatures.json og punktumfiler. |
| Kjørbare filer | Filer under scripts/ eller bin/, og en fil i roten med navnet binary. |
| Stier | Relativt til ferdighetsmappen. Stier med .. eller som går ut av mappen, avvises. |
| Deaktivert ferdighet | En mappe med SKILL.md.disabled i stedet for SKILL.md. |
| Ferdighetsliste | Hver 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.