NeboAI
NeboAI
はじめる

SKILL.mdリファレンス

このページでは、Neboが読み込むスキルのすべての部分を列挙します。フロントマターのフィールド、展開される変数、社員がスキルを扱うためのツール、スクリプトが動く環境です。

ファイル形式

SKILL.mdはUTF-8のテキストです。3つのハイフンの行で始まり、YAMLフロントマター、閉じる3つのハイフンの行と続きます。それ以降はすべて本文で、スキルを読み込んだ社員が受け取るMarkdownの指示です。Neboは大文字小文字を区別せずに、名前でファイルを見つけます。

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

フロントマターのフィールド

必須なのはnameとdescriptionだけです。型が間違っているフィールドがあるとファイル全体が失敗し、スキルは読み込まれません。ここに記載のないキーは無視されます。

フィールド種類デフォルト意味
namestring必須識別子。[a-z0-9-]、先頭・末尾のハイフンや連続したハイフンは不可、最大64バイト。フォルダ名と一致させてください。
descriptionstring必須スキルが何をし、いつ使うか。最大1,024バイト。社員のスキル一覧に表示され、find_skillsで評価されます。
versionstring"1.0.0"セマンティックバージョン。他のスキルのrequiresの範囲と照合されます。引用符で囲んでください。
triggers文字列のリスト[]スキルが当てはまる場面を表す言葉やフレーズ。スキルの一覧には最大3つが表示され、find_skillsではすべてが考慮されます。これだけでスキルが読み込まれることはありません。
platform文字列のリストすべてmacos、linux、windows。一致する場所でのみスキルが読み込まれます。
capabilities文字列のリスト[]networkとstorageは、スクリプトのサンドボックスを広げます。「スクリプトのサンドボックス」を参照してください。
metadatamap{}secretsとallowed_domainsを持ちます。下記を参照してください。
requires{name, version}のリスト[]このスキルが土台にする他のスキル。nameはスキルの短い名前、versionはセマンティックバージョンの範囲で、デフォルトは"*"です。
plugins{name, version, optional}のリスト[]このスキルが使うプラグイン。versionのデフォルトは"*"、optionalのデフォルトはfalseです。
dependencies文字列のリスト[]存在している必要があるスキルの短い名前。
priorityinteger0管理用の一覧でスキルの並び順を決めます。社員がどのスキルを選ぶかには影響しません。
authorstring""表示用に保存されます。
licensestring""表示用に保存されます。
compatibilitystring""自由記述のメモ。最大500バイト。
tags文字列のリスト[]表示用に保存されます。
allowed-toolsstring""スペース区切りの文字列。保存されますが、強制はされません。

requiresまたはdependenciesで指定したスキルが見つからないか範囲外の場合、または必須のプラグインがインストールされていない場合でも、スキルは読み込まれ、機能低下として表示されます。オーナーには何が足りないかが表示されます。

シークレット

スキルのスクリプトに必要な認証情報は、metadata.secretsの下で宣言します。値はオーナーが用意し、Neboがそのスキル用に暗号化して保存します。

metadata:
  secrets:
    - key: EXAMPLE_API_KEY
      label: Example API key
      hint: Create one at https://example.com/settings/keys
      required: true
キー意味
keyスクリプトが受け取る環境変数の名前。必須。
labelオーナーに表示される名前。
hint値の入手先。
requiredtrueの場合、値が設定されるまでexecuteはスキルのスクリプトの実行を拒否します。デフォルトはfalse。

社員は configure_skill で値を設定します。本文ではシークレットを ${secret.KEY} として参照できますが、スクリプトでは代わりに環境変数を読み取るようにしてください。

テンプレート変数

社員がスキルを読み込むと、Neboは本文内のこれらの変数を置き換えます。他のファイル内では置き換えられません。スクリプトは代わりに環境変数を読み取ります。

変数値
${NEBO_SKILL_DIR}スキルのフォルダの絶対パス。
${NEBO_DATA_DIR}このスキル用の書き込み可能なフォルダ: <data>/appdata/skills/<name>。最初の使用時に作成されます。
${NEBO_USER_NAME}オーナーの名前。
${NEBO_OS}オペレーティングシステム。
${NEBO_ARCH}プロセッサのアーキテクチャ。
${plugin.SLUG_BIN}宣言したプラグインのバイナリのパス。スラッグは大文字にし、ハイフンはアンダースコアにします。example-ledgerは${plugin.EXAMPLE_LEDGER_BIN}になります。
${secret.KEY}宣言したシークレットの値。
$ARGUMENTSuse_skillに渡されたargs。本文に$ARGUMENTSがない場合、引数は本文の後に追加されます。

スキル用ツール

社員はこれらのツールでスキルを扱います。use_skillは常に利用でき、それ以外は社員が必要とするときに読み込まれます。

ツールパラメーター内容
use_skillname, argsスキルを読み込みます。展開された本文、フォルダのパス、最初の20個のファイル名を返します。無効にしたスキルを再び有効にします。
find_skillsquery名前、トリガー、説明の一致度で順位付けした最大10個のスキルを返します。
read_skill_filename, pathスキルのフォルダ内のファイルを読みます。pathがない場合は、ファイルとそのサイズを一覧表示します。
save_skillname, content完全なSKILL.mdをユーザーskillsフォルダに書き込みます。マーケットプレイスのスキルは上書きできません。
delete_skillnameユーザースキルを削除します。
install_skillcodeSKIL-インストールコードからマーケットプレイスのスキルをインストールします。
configure_skillname, key, valueシークレットを設定します。keyがない場合は、スキルに必要なものを表示します。
rate_skillname, rating, reviewマーケットプレイスのスキルを1〜5で評価します。
read_skill_reviewsnameマーケットプレイスのスキルのレビューを読みます。
executeskill, script, args, timeoutスキルのフォルダにあるスクリプトを実行します。「スクリプトのサンドボックス」を参照してください。

スクリプトのサンドボックス

executeツールは、スキルのフォルダにあるスクリプトを1つ実行します。ランタイムはファイルから判断します。

スクリプトランタイム
.pyPython。Nebo同梱のuvがあればそれを経由し、なければpython3。
.ts, .jsNebo同梱のBunがあればそれを、なければnode。
bin/<file>またはbinary直接実行。
.sh非対応。

各実行は、空の環境と次の変数で始まります:

変数値
SKILL_ARGSJSONとしてのargsオブジェクト。
各シークレットのkey復号されたシークレットの値。
<PLUGIN>_BIN宣言した各プラグインのバイナリのパス。プラグインのフォルダは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", []))}))

スクリプトはスキルフォルダの一時的なコピーの中で、デフォルトのタイムアウト30秒で実行されます。macOSとLinuxでは、OSのサンドボックス内で実行されます:

  • 認証情報ストア、ブラウザやキーチェーンのデータ、Nebo自身の設定やデータベースは読み取れません。
  • 書き込めるのは、作業フォルダと/tmp/neboだけです。storage機能を宣言すると、Neboのデータフォルダが加わります。
  • ネットワークにはアクセスできません。network機能を宣言すると、パッケージレジストリとmetadata.allowed_domainsに記載したドメインへのアクセスが許可されます。

ファイルと上限

項目ルール
リソースSKILL.md、manifest.json、signatures.json、ドットファイル以外のすべてのファイル。
実行ファイルscripts/またはbin/の下のファイルと、ルートにあるbinaryという名前のファイル。
パススキルフォルダからの相対パス。..を含むパスや、フォルダの外に出るパスは拒否されます。
無効にしたスキルSKILL.mdの代わりにSKILL.md.disabledを持つフォルダ。
スキルの一覧各項目は250文字で切り詰められます。一覧全体が8,000文字を超える場合は、共有スキルから先に短縮され、社員専用のスキルは項目全体が保たれます。

マーケットプレイスに公開するファイルの上限は、公開のページに記載しています。