Formát súboru
SKILL.md je text v kódovaní UTF-8. Začína riadkom s tromi spojovníkmi, potom nasleduje úvodná časť YAML a uzatvárací riadok s tromi spojovníkmi. Všetko za ním je telo: pokyny v Markdowne, ktoré zamestnanec dostane pri načítaní zručnosti. Nebo nájde súbor podľa názvu bez ohľadu na veľkosť písmen.
---
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 ... Polia úvodnej časti
Povinné sú iba name a description. Pole s nesprávnym typom znehodnotí celý súbor, takže sa zručnosť nenačíta. Kľúče, ktoré tu nie sú uvedené, sa ignorujú.
| Pole | Typ | Predvolené | Význam |
|---|---|---|---|
name | string | povinné | Identifikátor. [a-z0-9-], bez spojovníka na začiatku či na konci a bez zdvojeného spojovníka, najviac 64 bajtov. Musí sa zhodovať s názvom priečinka. |
description | string | povinné | Čo zručnosť robí a kedy ju použiť. Najviac 1 024 bajtov. Zobrazuje sa v zozname zručností zamestnanca a hodnotí ho find_skills. |
version | string | "1.0.0" | Sémantická verzia. Kontrolujú ju rozsahy requires iných zručností. Dajte ju do úvodzoviek. |
triggers | zoznam reťazcov | [] | Slová a frázy, ktoré opisujú, kedy sa zručnosť uplatní. V zozname zručností sa zobrazia najviac tri; vo find_skills sa počítajú všetky. Samy zručnosť nikdy nenačítajú. |
platform | zoznam reťazcov | všetky | macos, linux, windows. Zručnosť sa načíta iba tam, kde sa niektorý zhoduje. |
capabilities | zoznam reťazcov | [] | network a storage rozširujú izolované prostredie skriptu. Pozrite Izolované prostredie skriptov. |
metadata | map | {} | Obsahuje secrets a allowed_domains. Pozrite nižšie. |
requires | zoznam {name, version} | [] | Ďalšie zručnosti, na ktorých táto zručnosť stavia. name je krátky názov zručnosti; version je rozsah semver, predvolene "*". |
plugins | zoznam {name, version, optional} | [] | Doplnky, ktoré táto zručnosť používa. version má predvolenú hodnotu "*", optional hodnotu false. |
dependencies | zoznam reťazcov | [] | Krátke názvy zručností, ktoré musia byť prítomné. |
priority | integer | 0 | Určuje poradie zručností v zoznamoch na správu. Neovplyvňuje, ktorú zručnosť si zamestnanec vyberie. |
author | string | "" | Ukladá sa na zobrazenie. |
license | string | "" | Ukladá sa na zobrazenie. |
compatibility | string | "" | Voľná poznámka, najviac 500 bajtov. |
tags | zoznam reťazcov | [] | Ukladá sa na zobrazenie. |
allowed-tools | string | "" | Reťazec oddelený medzerami. Ukladá sa; nevynucuje sa. |
Keď zručnosť uvedená v requires alebo dependencies chýba alebo je mimo rozsahu, prípadne povinný doplnok nie je nainštalovaný, zručnosť sa aj tak načíta a označí sa ako obmedzená. Vlastník vidí, čo chýba.
Tajné údaje
Prihlasovacie údaje, ktoré skripty zručnosti potrebujú, deklarujte v metadata.secrets. Hodnoty zadá vlastník a Nebo ich pre túto zručnosť uloží zašifrované.
metadata:
secrets:
- key: EXAMPLE_API_KEY
label: Example API key
hint: Create one at https://example.com/settings/keys
required: true | Kľúč | Význam |
|---|---|
key | Názov premennej prostredia, ktorú skript dostane. Povinné. |
label | Názov zobrazený vlastníkovi. |
hint | Kde hodnotu získať. |
required | Pri true odmietne execute spúšťať skripty zručnosti, kým sa hodnota nenastaví. Predvolene false. |
Zamestnanec nastaví hodnotu pomocou configure_skill. Na tajný údaj sa v tele môžete odvolať ako ${secret.KEY}, skripty by však mali namiesto toho čítať premennú prostredia.
Premenné šablón
Nebo tieto premenné v tele nahradí, keď zamestnanec zručnosť načíta. V iných súboroch sa nenahrádzajú; skripty namiesto toho čítajú premenné prostredia.
| Premenná | Hodnota |
|---|---|
${NEBO_SKILL_DIR} | Absolútna cesta k priečinku zručnosti. |
${NEBO_DATA_DIR} | Zapisovateľný priečinok pre túto zručnosť: <data>/appdata/skills/<name>. Vytvorí sa pri prvom použití. |
${NEBO_USER_NAME} | Meno vlastníka. |
${NEBO_OS} | Operačný systém. |
${NEBO_ARCH} | Architektúra procesora. |
${plugin.SLUG_BIN} | Cesta k binárnemu súboru deklarovaného doplnku. Slug sa píše veľkými písmenami, so spojovníkmi nahradenými podčiarkovníkmi: z example-ledger sa stane ${plugin.EXAMPLE_LEDGER_BIN}. |
${secret.KEY} | Hodnota deklarovaného tajného údaja. |
$ARGUMENTS | args odovzdané nástroju use_skill. Keď telo neobsahuje $ARGUMENTS, argumenty sa pripoja za neho. |
Nástroje zručností
Zamestnanci pracujú so zručnosťami pomocou týchto nástrojov. use_skill je vždy k dispozícii; ostatné sa načítajú, keď ich zamestnanec potrebuje.
| Nástroj | Parametre | Čo robí |
|---|---|---|
use_skill | name, args | Načíta zručnosť. Vráti rozvinuté telo, cestu k priečinku a prvých 20 názvov súborov. Vypnutú zručnosť znova zapne. |
find_skills | query | Vráti najviac 10 zručností zoradených podľa zhody názvu, spúšťačov a popisu. |
read_skill_file | name, path | Prečíta súbor v priečinku zručnosti. Bez path vypíše súbory a ich veľkosti. |
save_skill | name, content | Zapíše kompletný SKILL.md do priečinka používateľských zručností. Zručnosti z obchodu sa nedajú prepísať. |
delete_skill | name | Odstráni používateľskú zručnosť. |
install_skill | code | Nainštaluje zručnosť z obchodu podľa jej inštalačného kódu SKIL-. |
configure_skill | name, key, value | Nastaví tajný údaj. Bez key zobrazí, čo zručnosť potrebuje. |
rate_skill | name, rating, review | Ohodnotí zručnosť z obchodu známkou od 1 do 5. |
read_skill_reviews | name | Prečíta recenzie zručnosti z obchodu. |
execute | skill, script, args, timeout | Spustí skript z priečinka zručnosti. Pozrite Izolované prostredie skriptov. |
Izolované prostredie skriptov
Nástroj execute spustí jeden skript z priečinka zručnosti. Prostredie behu určí podľa súboru.
| Skript | Prostredie behu |
|---|---|
.py | Python cez pribalený uv od Nebo, ak je k dispozícii, inak python3. |
.ts, .js | Pribalený Bun od Nebo, ak je k dispozícii, inak node. |
bin/<file> alebo binary | Spúšťa sa priamo. |
.sh | Nepodporované. |
Každý beh začína s prázdnym prostredím a s týmito premennými:
| Premenná | Hodnota |
|---|---|
SKILL_ARGS | Objekt args ako JSON. |
Každý key tajného údaja | Dešifrovaná hodnota tajného údaja. |
<PLUGIN>_BIN | Cesta k binárnemu súboru každého deklarovaného doplnku. Priečinky doplnkov sa pridajú aj do 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", []))})) Skript beží v dočasnej kópii priečinka zručnosti s predvoleným časovým limitom 30 sekúnd. V macOS a Linuxe beží v izolovanom prostredí operačného systému:
- Nemôže čítať úložiská prihlasovacích údajov, údaje prehliadača a kľúčenky ani vlastné nastavenia a databázu Nebo.
- Zapisovať môže iba do svojho pracovného priečinka a do
/tmp/nebo. Schopnosťstoragepridáva dátový priečinok Nebo. - Nemá prístup k sieti. Schopnosť
networkpovoľuje registre balíkov a domény uvedené vmetadata.allowed_domains.
Súbory a obmedzenia
| Položka | Pravidlo |
|---|---|
| Zdroje | Každý súbor okrem SKILL.md, manifest.json, signatures.json a súborov začínajúcich bodkou. |
| Spustiteľné súbory | Súbory v scripts/ alebo bin/ a súbor s názvom binary v koreňovom priečinku. |
| Cesty | Relatívne k priečinku zručnosti. Cesty s .. alebo cesty, ktoré vedú mimo priečinka, sa odmietnu. |
| Vypnutá zručnosť | Priečinok so súborom SKILL.md.disabled namiesto SKILL.md. |
| Zoznam zručností | Každý záznam sa skráti na 250 znakov. Keď celý zoznam presiahne 8 000 znakov, najprv sa skrátia zdieľané zručnosti; vlastné zručnosti zamestnanca si ponechajú celé záznamy. |
Obmedzenia pre súbory, ktoré zverejňujete v obchode, sú na stránke Zverejňovanie.