NeboAI
NeboAI
Começar

Referência do agent.json

O agent.json guarda tudo sobre um funcionário que não é texto corrido: as capacidades que ele exige, as perguntas que faz ao proprietário, como a memória dele é mantida, quais operações sempre precisam de aprovação e os fluxos de trabalho que ele roda. Todos os campos são opcionais.

Exemplo

{
  "requires": {
    "interfaces": ["ledger", "mail"],
    "plugins": [],
    "tools": []
  },
  "skills": ["@example/skills/receipt-capture"],
  "inputs": [
    {
      "key": "invoice_mailbox",
      "label": "Mailbox that receives vendor invoices",
      "type": "text",
      "id": "finance.ap.invoice_mailbox",
      "scope": "company",
      "required": true,
      "missing": "Ask the owner which mailbox to watch before processing invoices."
    }
  ],
  "memory": {
    "mode": "separate",
    "topics": [
      { "slug": "vendor", "description": "A supplier: terms, usual amounts, contacts, open disputes" }
    ]
  },
  "subscribes": ["finance.ap.*"],
  "ceiling": { "ledger.bill.create": "approval" },
  "workflows": {
    "invoice-intake": {
      "trigger": { "type": "watch", "plugin": "mail", "event": "email.new" },
      "activities": [
        { "id": "record", "intent": "If the message in _watch_payload is a vendor invoice, record it as a bill." }
      ]
    }
  }
}

Campos

CampoTipoSignificado
requires.interfaceslista de stringsCapacidades de que a função precisa, como mail ou ledger. Concedidas na contratação; cada operação sujeita a aprovação continua sendo um item de aprovação. Veja Capacidades e aprovações.
requires.pluginslista de stringsPlugins instalados com o funcionário. Use apenas quando a função realmente depender de um plugin; prefira uma capacidade.
requires.toolslista de stringsFerramentas carregadas na sessão do funcionário desde o primeiro turno. Isso nunca dispensa a aprovação.
skillslista de stringsSkills da loja para instalar e usar: @org/skills/name, opcionalmente com @version, ou um código SKIL-. Skills na própria pasta skills/ do pacote não precisam de entrada.
inputslistPerguntas que o proprietário responde na contratação. Veja Entradas.
memoryobjectComo as conversas e a memória são mantidas. Veja Persona e memória.
subscribeslista de stringsÁreas de informações da empresa que o funcionário relê quando mudam, como finance.ar.*.
ceilingmapOperação para "approval". Essa operação sempre pede autorização ao proprietário para este funcionário. Nenhum outro valor é aceito.
workflowsmapNome do fluxo de trabalho para o fluxo de trabalho. Veja Fluxos de trabalho.
toolslistFerramentas HTTP servidas pelo sidecar de um app. Veja Ferramentas de sidecar.
scopesmapGrupos nomeados de tools, skills e plugins. Os plugins de um escopo são descritos ao funcionário quando esse escopo está ativo.

Entradas

Uma entrada é uma pergunta que o dono responde ao contratar. As respostas aparecem para o funcionário em "Configured Inputs" e preenchem os marcadores {{key}} nos gatilhos de monitoramento e de pasta.

{
  "key": "close_day",
  "label": "Business day to finish the close",
  "type": "select",
  "options": [
    { "value": "3", "label": "Third business day" },
    { "value": "5", "label": "Fifth business day" }
  ],
  "default": "5",
  "scope": "company",
  "id": "finance.close.day"
}
CampoPadrãoSignificado
keyobrigatórioNome usado nos placeholders. name é aceito como alternativa.
labela partir de keyA pergunta mostrada ao proprietário.
typetexttext, textarea, number, select, checkbox ou radio.
requiredfalseMarca a pergunta como obrigatória para o proprietário.
defaultnenhumResposta pré-preenchida. Não é permitida em perguntas de valor monetário.
placeholder, descriptionnenhumTexto de ajuda.
optionsnenhumPara select e radio: objetos {value, label} ou strings simples.
idnenhumUm nome estável, com pontos, para a informação, como finance.ap.invoice_mailbox, para que outros funcionários possam compartilhá-la.
scopecompanycompany: uma informação compartilhada da empresa. seat: apenas esta contratação.
missingnenhumO que o funcionário faz enquanto a pergunta não é respondida.
moneyfalseMarca um valor monetário. Uma pergunta de valor monetário não pode ter padrão.

Ferramentas de sidecar

Um app com sidecar expõe endpoints HTTP ao seu funcionário como ferramentas. O Nebo registra cada entrada como app__<app>__<name> e envia as chamadas ao sidecar em method e path. Veja Sidecar do app.

"tools": [
  {
    "name": "list_entries",
    "description": "List journal entries for a date range.",
    "method": "GET",
    "path": "/entries",
    "input_schema": { "type": "object", "properties": { "from": { "type": "string" } } }
  }
]

Fluxos de trabalho

Cada chave em workflows nomeia um fluxo de trabalho; o nome é o identificador dele. O formato completo está em Fluxos de trabalho, Gatilhos e Atividades.