Generated from
schemas/nodes/node.schema.json, the same file the node
linter validates against.Example
node.yaml
Fields
nodeType
required
The node’s identity. A saved workflow stores it, so renaming it orphans every workflow that placed the node.
`PromiseNode` · `CallbackNode`
required
How the node runs.
PromiseNode settles once; CallbackNode emits as it goes and settles later. The last call’s transport decides it, and lint checks the declaration.string
required
The display name, shown on the node. Independent of
type and of the folder name.string
required
One line saying what the node does, shown in the node library.
nodeCategory
required
The job’s domain, used in the library and in discovery ranking. Name the work, never the implementation.
whenToUse
required
The text an Agent’s search is ranked against, so this is what decides whether the node is ever chosen. Write the words a person would actually say, outcome first, and disqualify by property rather than by naming a sibling. Getting it wrong fails silently: the node still works, it is just never picked. Full rules: Node discoverability.
string
The node’s accent colour on the canvas.
string
The service’s logo, shown on the node and in the marketplace.
`service` · `mini` · `memory` · `uiComponent` · `printComponent` · `harness`
A starter configuration, prefilled when someone drops the node onto a canvas.
string[]
Every host this node may reach. No entry, no network.
`public` · `internal`
Whether the node appears in the library, or is reachable only by another node.
object
Engine behaviour this node opts into:
cacheable for a pure read, emitsExternally for an effect that cannot be undone.interface.schema.json
Points at
interface.yaml, or declares the wiring surface inline.config.schema.json
Points at
config.yaml, or declares the settings form inline.api.schema.json
Points at the
api/ folder, or declares the calls inline.test.schema.json
Points at
test.yaml, or declares the fixture inline.object
required
Who may set this node off. The node author’s floor, which a workflow builder can tighten and never loosen.
Next steps
Building a node
The guides behind these fields.
Troubleshooting
When a node does not do what you wrote.