ฟิลด์ระดับบนสุด
| ฟิลด์ | ชนิด | จำเป็น | ความหมาย |
|---|---|---|---|
id | string | ใช่ | ตัวระบุของปลั๊กอินในมาร์เก็ตเพลส ระหว่างพัฒนาให้ใช้ slug |
slug | string | ใช่ | ตัวระบุที่คงที่ [a-z0-9-] ยาวไม่เกิน 64 อักขระ ห้ามขึ้นต้นหรือลงท้ายด้วยขีดกลาง และห้ามมีขีดกลางซ้อนกัน ใช้ตั้งชื่อเครื่องมือ plugin__<slug> และตัวแปร <SLUG>_BIN |
name | string | ใช่ | ชื่อที่แสดง ให้ตั้งตามชื่อบริการที่เชื่อมต่อ |
version | string | ใช่ | เวอร์ชันแบบ Semantic เช่น 0.1.0 |
platforms | map | ใช่ | คีย์แพลตฟอร์มที่จับคู่กับไบนารี ดูที่ Platforms |
description | string | ไม่ | หนึ่งประโยคสำหรับผู้คนและพนักงาน |
author | string | ไม่ | ชื่อผู้เผยแพร่ |
category | string | ไม่ | ช่วยให้พนักงานค้นพบปลั๊กอิน |
triggers | รายการของสตริง | ไม่ | คำที่อธิบายว่าปลั๊กอินใช้ได้เมื่อใด ใช้ในคำแนะนำการค้นหา |
entrySkills | รายการของสตริง | ไม่ | ทักษะที่รวมมาด้วยซึ่งจะระบุชื่อเป็นอันดับแรกในคำอธิบายเครื่องมือของปลั๊กอิน |
dependencies | รายการของ {name, version, optional} | ไม่ | ปลั๊กอินอื่นที่ปลั๊กอินนี้เรียกใช้ version มีค่าเริ่มต้นเป็น "*" และ optional มีค่าเริ่มต้นเป็น false พาธ <SLUG>_BIN ของปลั๊กอินเหล่านั้นจะถูกตั้งค่าในทุกการเรียก |
auth | object | ไม่ | การลงชื่อเข้าใช้และบัญชี ดูที่ Auth |
capabilities | object | ไม่ | configSchema, hooks, commands, routes, providers. |
permissions | object | ไม่ | การกรองสภาพแวดล้อมและเพดานเวลาหมดเวลา |
events | list | ไม่ | ตัวเฝ้าดูที่ป้อนข้อมูลให้เวิร์กโฟลว์ของพนักงาน |
interfaceBindings | map | ไม่ | การดำเนินการแบบมีชนิดข้อมูลที่ปลั๊กอินมีให้ |
channel | object | ไม่ | สะพานเชื่อมแบบถาวรไปยังบริการรับส่งข้อความ |
setup | object | ไม่ | วิซาร์ดตั้งค่าแบบทีละขั้นตอน |
Nebo ตรวจสอบการติดตั้งจากมาร์เก็ตเพลส ได้แก่ กฎของ slug, เวอร์ชันแบบ Semantic, อย่างน้อยหนึ่งแพลตฟอร์ม, binaryName ที่ไม่มีตัวคั่นพาธหรือ .., คำสั่ง login เว้นแต่ auth.type เป็น env, ชื่ออีเวนต์และคำสั่งที่ไม่ว่าง และเทมเพลตการผูกที่แยกวิเคราะห์ได้ ปลั๊กอินในไดเรกทอรีปลั๊กอินของผู้ใช้จะข้ามการตรวจสอบนี้
แพลตฟอร์ม
คีย์ได้แก่ darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 และ windows-amd64 แต่ละรายการมีครบทั้งห้าฟิลด์ด้านล่าง เมื่อคุณเผยแพร่ มาร์เก็ตเพลสจะเขียนแฮช ขนาด ลายเซ็น และ URL ดาวน์โหลดจริงให้ ดังนั้นให้เว้นว่างไว้ในไฟล์ที่คุณอัปโหลด
"platforms": {
"darwin-arm64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"linux-amd64": { "binaryName": "notes-sync", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
"windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
} | ฟิลด์ | ความหมาย |
|---|---|
binaryName | ชื่อไฟล์ของโปรแกรมที่เรียกใช้ได้ บน Windows ให้เติม .exe |
sha256 | แฮชของไบนารี ตรวจสอบขณะติดตั้ง |
signature | ลายเซ็นของไบนารี ตรวจสอบขณะติดตั้งเมื่อมีคีย์สำหรับลงลายเซ็น |
size | ขนาดเป็นไบต์ |
downloadUrl | ตำแหน่งที่ Nebo ดาวน์โหลดแพ็กเกจ |
Auth
| ฟิลด์ | ความหมาย |
|---|---|
type | oauth_cli สำหรับการลงชื่อเข้าใช้ผ่านเบราว์เซอร์ที่ปลั๊กอินดำเนินการเอง, env สำหรับข้อมูลรับรองที่ป้อนเป็นค่า, neboai เพื่อรับโทเค็น NeboAI ของเจ้าของในทุกคีย์ auth.env ที่ลงท้ายด้วย _TOKEN |
env | แมปของชื่อตัวแปรกับค่าเริ่มต้น และเป็นชื่อข้อมูลรับรองเพียงชุดเดียวที่ Nebo ส่งให้ login |
commands.login | ลงชื่อเข้าใช้ จำเป็น เว้นแต่ type เป็น env ทำงานโดยตั้งค่าโฟลเดอร์บัญชีไว้แล้ว |
commands.status | แสดงผล JSON ที่บอกว่าบัญชีลงชื่อเข้าใช้อยู่หรือไม่ |
commands.refresh | ต่ออายุโทเค็นโดยไม่ต้องโต้ตอบ |
commands.logout | ออกจากระบบ เฉพาะเจ้าของเท่านั้นที่เรียกใช้ได้ |
profileDirEnv | ตัวแปรที่รับโฟลเดอร์ข้อมูลรับรองแยกสำหรับพนักงานและบัญชีแต่ละรายการ หากไม่มี ปลั๊กอินจะใช้บัญชีร่วมกันบัญชีเดียว |
label, description | ข้อความบนการ์ดเชื่อมต่อ |
help | {url, urlLabel, text} ที่แสดงขณะเชื่อมต่อ |
publicRedirect | ตั้งเป็น true เมื่อผู้ให้บริการปฏิเสธการเปลี่ยนเส้นทางไปยัง http://localhost การลงชื่อเข้าใช้จะผ่านการเปลี่ยนเส้นทางสาธารณะของ NeboAI แทน |
Nebo อ่านค่าแรกที่พบจาก authenticated, isAuthenticated, logged_in, loggedIn หรือ token_valid ในเอาต์พุตสถานะ หาก token_error ไม่ว่าง หรือมีค่า none ใน credential_source, auth_method, storage หรือ status หมายความว่าออกจากระบบแล้ว คำสั่งสถานะมีเวลา 45 วินาที
{"authenticated": true, "account": "finance@example.com"} configSchema
capabilities.configSchema อธิบายค่าที่เจ้าของตั้งให้ปลั๊กอิน แต่ละค่าจะไปถึงไบนารีเป็นตัวแปรสภาพแวดล้อมที่ตั้งชื่อตาม key สำหรับคีย์ข้อมูลรับรองที่อยู่ใน auth.env ด้วย สคีมาจะใช้ตั้งป้ายกำกับฟิลด์ในแบบฟอร์มเชื่อมต่อรายพนักงาน
| ฟิลด์ | ชนิด | ค่าเริ่มต้น | ความหมาย |
|---|---|---|---|
key | string | จำเป็น | ชื่อตัวแปรสภาพแวดล้อม |
label | string | จำเป็น | ป้ายกำกับฟิลด์ |
description | string | "" | ข้อความช่วยเหลือ |
fieldType | string | "string" | ชนิดอินพุต เช่น string, number, boolean, select หรือ password |
default | string | ไม่มี | ค่าที่กรอกไว้ล่วงหน้า |
required | boolean | false | ปลั๊กอินจะยังไม่พร้อมจนกว่าจะตั้งค่านี้ |
secret | boolean | false | ค่าจะถูกปิดบังเมื่ออ่านกลับมา |
options | รายการของสตริง | ไม่มี | ตัวเลือกสำหรับ select |
permissions
| ฟิลด์ | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
envAllow | [] | ตัวแปรที่สืบทอดมาซึ่งปลั๊กอินมองเห็นได้ หากว่างไว้จะอนุญาตทั้งหมด |
envDeny | [] | ตัวแปรที่สืบทอดมาซึ่งจะถูกนำออกเสมอ |
maxTimeoutSeconds | 300 | ขีดจำกัดสูงสุดของเวลาหมดเวลาสำหรับทุกการเรียก |
network | false | ประกาศการใช้เครือข่าย เป็นข้อมูลเท่านั้น ไม่มีการบังคับใช้ |
events
อีเวนต์คือตัวเฝ้าดูที่ทำงานต่อเนื่องเป็นเวลานาน Nebo จะเริ่มตัวเฝ้าดูเมื่อเวิร์กโฟลว์ของพนักงานเฝ้าดูอีเวนต์นั้น และเริ่มใหม่หากตัวเฝ้าดูหยุดทำงาน แต่ละบรรทัดที่ตัวเฝ้าดูเขียนออกทาง stdout คือหนึ่งอีเวนต์ ชื่ออีเวนต์จะถูกเติม slug นำหน้าขณะทำงาน ดังนั้น note.created จะกลายเป็น notes-sync.note.created
"events": [
{
"name": "note.created",
"description": "A note was created in the watched notebook.",
"command": "watch --notebook {{notebook}} --format ndjson"
}
] | ฟิลด์ | ความหมาย |
|---|---|
name | ชื่ออีเวนต์ โดยไม่มี slug จำเป็น |
command | อาร์กิวเมนต์ที่ใช้เริ่มตัวเฝ้าดู จำเป็น {{key}} จะถูกแทนที่ด้วยค่าอินพุตของพนักงาน |
description | สิ่งที่ทำให้เกิดอีเวนต์ |
multiplexed | เมื่อเป็น true ตัวเฝ้าดูตัวเดียวจะส่งอีเวนต์ได้หลายชนิด และแต่ละบรรทัดจะมีฟิลด์ "event" |
เวิร์กโฟลว์สมัครรับอีเวนต์ด้วยทริกเกอร์ watch ดูที่ ทริกเกอร์
interfaceBindings
การผูกจะจับคู่การดำเนินการของอินเทอร์เฟซเข้ากับคำสั่งหนึ่งของคุณ การผูกแต่ละรายการจะกลายเป็นเครื่องมือแบบมีชนิดข้อมูลสำหรับพนักงาน ตั้งชื่อตามการดำเนินการเป็นตัวพิมพ์เล็ก โดยเปลี่ยนจุดและขีดกลางเป็นขีดล่าง เช่น notes.search จะกลายเป็น notes_search การผูกคือวิธีที่ปลั๊กอินตอบสนองความสามารถที่พนักงานต้องการ ดูที่ ความสามารถ
"interfaceBindings": {
"notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
"invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
} | ตัวยึดตำแหน่ง | ขยายเป็น |
|---|---|
{field} | ค่าของฟิลด์เป็นคำเดียว ฟิลด์นี้จะไม่ถูกส่งเป็นแฟล็กซ้ำอีก |
{field[]:--flag} | คู่ --flag <item> หนึ่งคู่สำหรับแต่ละรายการในฟิลด์แบบรายการ |
{field?:--flag} | --flag <value> เมื่อมีฟิลด์นั้น และไม่มีอะไรเลยเมื่อไม่มีฟิลด์ |
{field:cents->dollars} | จำนวนเต็มหน่วยเซนต์ เขียนเป็นดอลลาร์ |
ฟิลด์อินพุตที่เทมเพลตไม่ได้ระบุชื่อจะถูกต่อท้ายเป็น --field value ตัวยึดตำแหน่งแบบรายการและแบบไม่บังคับต้องเป็นคำทั้งคำ การดำเนินการที่ต้องได้รับอนุมัติจะไม่สามารถเข้าถึงได้ด้วยการเรียกคำสั่งเดียวกันผ่าน plugin__<slug>
Hook คำสั่งสแลช และเส้นทาง
"capabilities": {
"hooks": [
{ "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
],
"commands": [
{ "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
],
"routes": [
{ "path": "/callback", "method": "GET", "command": "http callback" }
]
} hooks
ฮุกจะรันคำสั่งของคุณ ณ จุดหนึ่งในเทิร์นของพนักงาน Nebo จะเขียนเพย์โหลด JSON ไปที่ stdin เอาต์พุตของฮุกแบบ action จะถูกเพิกเฉย ฮุกแบบ filter จะคืนค่า {"payload": ..., "handled": false} โดย "handled": true จะหยุดฮุกที่ตามมา ข้อผิดพลาดและการหมดเวลาจะคงเพย์โหลดเดิมไว้และไม่ขัดขวางเทิร์น หากฮุกล้มเหลวสามครั้งติดกัน ฮุกจะถูกหยุดชั่วคราวห้านาที
| ฟิลด์ | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
hook | จำเป็น | หนึ่งใน tool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue |
hookType | "action" | action หรือ filter |
command | จำเป็น | อาร์กิวเมนต์สำหรับไบนารีของคุณ |
priority | 100 | ค่าน้อยกว่าทำงานก่อน |
timeoutMs | 500 | เวลาจำกัดเป็นมิลลิวินาที |
commands
เมื่อตั้ง "slash": true การพิมพ์ /name args ในแชตจะเรียก command args โดยตรงโดยไม่ผ่านพนักงาน เอาต์พุตคือคำตอบ เวลาจำกัดคือ 30 วินาที
routes
เส้นทางตอบคำขอ HTTP ที่ /api/v1/plugins/<slug>/api/<path> บนบอท โดยจับคู่ด้วย path และ method เนื้อหาคำขอจะส่งไปที่ stdin และ stdout ของคุณคือการตอบกลับ เวลาจำกัดคือ 30 วินาที
providers
ผู้ให้บริการจะเพิ่มแหล่งโมเดลแชต ให้ประกาศ id, displayName, providerType, modelsCommand และ chatCommand Nebo จะส่งคำขอแชตเป็น JSON ทาง stdin ไปยัง chatCommand และอ่านอีเวนต์แบบสตรีมเป็น JSON คั่นด้วยการขึ้นบรรทัดใหม่ทาง stdout ได้นานสูงสุด 300 วินาที ปัจจุบันใช้เฉพาะการสตรีมแชตเท่านั้น
channel
แชนเนลเชื่อมต่อบริการรับส่งข้อความ Nebo จะให้ command ทำงานอยู่ตลอด อ่านข้อความขาเข้าจาก stdout และเขียนคำตอบไปที่ stdin ทั้งสองทางเป็น JSON คั่นด้วยการขึ้นบรรทัดใหม่
| ฟิลด์ | ค่าเริ่มต้น | ความหมาย |
|---|---|---|
command | จำเป็น | อาร์กิวเมนต์ที่ใช้เริ่มสะพานเชื่อม |
name, description | "" | แสดงในการตั้งค่า |
restartDelaySecs | 5 | เวลารอก่อนเริ่มใหม่หลังจากขัดข้อง |
shared | false | สะพานเชื่อมเดียวสำหรับพนักงานทุกคน ข้อความจะถูกส่งตามชื่อพนักงาน และคำตอบจะมีตัวตนของพนักงานแต่ละคน |
needsLocalApi | false | ให้สะพานเชื่อมได้รับที่อยู่ API ภายในของบอท โทเค็น และ id ของพนักงาน ปิดไว้เว้นแต่คุณต้องการ |
setup
วิซาร์ดการตั้งค่าจะพาเจ้าของผ่านขั้นตอนที่ฟอร์มเดียวครอบคลุมไม่ได้ ค่าจากขั้นตอน form จะเติม {{key}} ในอาร์กิวเมนต์ generate ที่ตามมา ค่าจากขั้นตอน credentials จะถูกบันทึกเป็นตัวแปรสภาพแวดล้อมของปลั๊กอิน
"setup": {
"title": "Connect Example Chat",
"steps": [
{ "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
{ "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
{ "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
{ "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
]
} | ชนิดของขั้นตอน | ฟิลด์ |
|---|---|
form | title, description, fields |
generate | title, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel แสดงเอาต์พุตของคำสั่งให้คัดลอก |
external | title, description, url, urlLabel, instructions |
credentials | title, description, fields, verifyCommand ขั้นตอนจะเสร็จสมบูรณ์เมื่อ verifyCommand ทำงานสำเร็จ |
ฟิลด์มี key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) และ required