NeboAI
NeboAI
Kom i gang

SKILL.md-reference

Denne side viser alle de dele af en færdighed, som Nebo læser: frontmatter-felterne, de variabler, den udvider, de værktøjer, medarbejdere bruger til at arbejde med færdigheder, og det miljø, scripts kører i.

Filformat

SKILL.md er UTF-8-tekst. Den starter med en linje med tre bindestreger, derefter YAML-frontmatter og så en afsluttende linje med tre bindestreger. Alt derefter er brødteksten: Markdown-instruktioner, som medarbejderen modtager, når den indlæser færdigheden. Nebo finder filen ud fra navnet uden hensyn til store og små bogstaver.

---
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-felter

Kun name og description er påkrævet. Et felt med forkert type får hele filen til at fejle, så færdigheden indlæses ikke. Nøgler, der ikke står her, ignoreres.

FeltTypeStandardBetydning
namestringpåkrævetIdentifikator. [a-z0-9-], ingen bindestreg først, sidst eller dobbelt, højst 64 bytes. Skal svare til mappenavnet.
descriptionstringpåkrævetHvad færdigheden gør, og hvornår den skal bruges. Højst 1.024 bytes. Vises i medarbejderens færdighedsliste og vurderes af find_skills.
versionstring"1.0.0"Semantisk version. Tjekkes af andre færdigheders requires-intervaller. Sæt den i anførselstegn.
triggersliste af strenge[]Ord og vendinger, der beskriver, hvornår færdigheden er relevant. Op til tre vises i færdighedslisten; alle tæller med i find_skills. De indlæser aldrig en færdighed af sig selv.
platformliste af strengeallemacos, linux, windows. Færdigheden indlæses kun dér, hvor en af dem matcher.
capabilitiesliste af strenge[]network og storage udvider scriptsandkassen. Se Scriptsandkasse.
metadatamap{}Indeholder secrets og allowed_domains. Se nedenfor.
requiresliste af {name, version}[]Andre færdigheder, som denne færdighed bygger på. name er det korte færdighedsnavn; version er et semver-interval, standard "*".
pluginsliste af {name, version, optional}[]Plugins, som denne færdighed bruger. version er som standard "*", optional som standard false.
dependenciesliste af strenge[]Korte navne på færdigheder, der skal være til stede.
priorityinteger0Bestemmer rækkefølgen af færdigheder i administrationslister. Det påvirker ikke, hvilken færdighed en medarbejder vælger.
authorstring""Gemmes til visning.
licensestring""Gemmes til visning.
compatibilitystring""Fritekstnote, højst 500 bytes.
tagsliste af strenge[]Gemmes til visning.
allowed-toolsstring""En mellemrumsadskilt streng. Gemmes; håndhæves ikke.

Når en færdighed, der er nævnt i requires eller dependencies, mangler eller ligger uden for intervallet, eller et påkrævet plugin ikke er installeret, indlæses færdigheden stadig og markeres som nedsat. Ejeren ser, hvad der mangler.

Hemmeligheder

Erklær de loginoplysninger, en færdigheds scripts har brug for, under metadata.secrets. Ejeren angiver værdierne, og Nebo gemmer dem krypteret for den færdighed.

metadata:
  secrets:
    - key: EXAMPLE_API_KEY
      label: Example API key
      hint: Create one at https://example.com/settings/keys
      required: true
NøgleBetydning
keyNavnet på den miljøvariabel, scriptet modtager. Påkrævet.
labelNavn, der vises for ejeren.
hintHvor værdien kan hentes.
requiredNår den er true, nægter execute at køre færdighedens scripts, indtil værdien er angivet. Standard false.

En medarbejder angiver en værdi med configure_skill. Du kan henvise til en hemmelighed i brødteksten som ${secret.KEY}, men scripts bør i stedet læse miljøvariablen.

Skabelonvariabler

Nebo erstatter disse variabler i brødteksten, når en medarbejder indlæser færdigheden. De erstattes ikke i andre filer; scripts læser i stedet miljøvariabler.

VariabelVærdi
${NEBO_SKILL_DIR}Absolut sti til færdighedens mappe.
${NEBO_DATA_DIR}En skrivbar mappe til denne færdighed: <data>/appdata/skills/<name>. Oprettes ved første brug.
${NEBO_USER_NAME}Ejerens navn.
${NEBO_OS}Operativsystemet.
${NEBO_ARCH}Processorarkitekturen.
${plugin.SLUG_BIN}Stien til et erklæret plugins binærfil. Sluggen skrives med store bogstaver og med bindestreger som understregninger: example-ledger bliver til ${plugin.EXAMPLE_LEDGER_BIN}.
${secret.KEY}Værdien af en erklæret hemmelighed.
$ARGUMENTSDe args, der sendes til use_skill. Når brødteksten ikke har nogen $ARGUMENTS, tilføjes argumenterne efter den.

Færdighedsværktøjer

Medarbejdere arbejder med færdigheder gennem disse værktøjer. use_skill er altid tilgængeligt; de andre indlæses, når en medarbejder har brug for dem.

VærktøjParametreHvad det gør
use_skillname, argsIndlæser en færdighed. Returnerer den udvidede brødtekst, mappestien og de første 20 filnavne. Genaktiverer en deaktiveret færdighed.
find_skillsqueryReturnerer op til 10 færdigheder rangeret efter match på navn, udløser og beskrivelse.
read_skill_filename, pathLæser en fil i færdighedens mappe. Uden path vises filerne og deres størrelser.
save_skillname, contentSkriver en komplet SKILL.md til brugermappen til færdigheder. Færdigheder fra markedspladsen kan ikke overskrives.
delete_skillnameSletter en brugerfærdighed.
install_skillcodeInstallerer en færdighed fra markedspladsen ud fra dens SKIL--installationskode.
configure_skillname, key, valueAngiver en hemmelighed. Uden key vises, hvad færdigheden har brug for.
rate_skillname, rating, reviewBedømmer en færdighed på markedspladsen fra 1 til 5.
read_skill_reviewsnameLæser anmeldelser af en færdighed på markedspladsen.
executeskill, script, args, timeoutKører et script fra en færdigheds mappe. Se Scriptsandkasse.

Scriptsandkasse

Værktøjet execute kører ét script fra en færdigheds mappe. Det vælger kørselsmiljøet ud fra filen.

ScriptKørselsmiljø
.pyPython via Nebos medfølgende uv, når den findes, ellers python3.
.ts, .jsNebos medfølgende Bun, når den findes, ellers node.
bin/<file> eller binaryKøres direkte.
.shUnderstøttes ikke.

Hver kørsel starter med et tomt miljø og disse variabler:

VariabelVærdi
SKILL_ARGSargs-objektet som JSON.
Hver hemmeligheds keyDen dekrypterede hemmelige værdi.
<PLUGIN>_BINStien til hvert erklæret plugins binærfil. Pluginmapper føjes også til 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", []))}))

Scriptet kører i en midlertidig kopi af færdighedsmappen med en standardtimeout på 30 sekunder. På macOS og Linux kører det i en sandkasse på operativsystemniveau:

  • Det kan ikke læse lagre med loginoplysninger, browser- og nøgleringsdata eller Nebos egne indstillinger og database.
  • Det kan kun skrive til sin arbejdsmappe og /tmp/nebo. Kapabiliteten storage tilføjer Nebos datamappe.
  • Det har ingen netværksadgang. Kapabiliteten network tillader pakkeregistre og domænerne angivet i metadata.allowed_domains.

Filer og grænser

ElementRegel
RessourcerAlle filer undtagen SKILL.md, manifest.json, signatures.json og punktumfiler.
Eksekverbare filerFiler under scripts/ eller bin/ og en rodfil med navnet binary.
StierRelativt til færdighedsmappen. Stier med .., eller som fører ud af mappen, afvises.
Deaktiveret færdighedEn mappe med SKILL.md.disabled i stedet for SKILL.md.
FærdighedslisteHver post afkortes ved 250 tegn. Når hele listen overstiger 8.000 tegn, forkortes fælles færdigheder først; en medarbejders egne færdigheder beholder deres fulde poster.

Grænser for filer, du udgiver på markedspladsen, står på siden Udgivelse.