Generated from
nodes/_schema/node.schema.json, the same file the node
linter validates against.Example
node.yaml
Fields
nodeType
required
How the node runs.
promise settles once; callback streams and settles later. The last call’s transport decides it.`PromiseNode` · `CallbackNode`
required
What the node is for. Picks the executor and the shape the platform expects.
string
required
The node’s id, unique in its package. Used everywhere it is referenced.
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
Platform features this node needs. Publishing refuses where a universe cannot satisfy them.
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.