Description (DESCRIPTION)

A note on the canvas that explains the pipeline to other people. It is not connected to anything and has no effect when the pipeline runs.

Category: Utilities · Deployed: no — never sent to the agent · Tool-capable: no

Ports

None. It connects to nothing.

Properties

Field Required Meaning

Content (content)

No

The note’s text. You can use Markdown, for example bold or lists. It is shown directly on the canvas

You can resize the note on the canvas. Its size is saved with the pipeline.

Use cases

  • Explain the idea of a pipeline to the next person who opens it — or to yourself, later.

  • Explain a branch: for example what the Fail path of a Guardrails module is for.

  • Record decisions: why this model, why this limit.

  • Leave a to-do on a part that is not finished.

Notes

  • It is left out when the pipeline is sent to the agent. It costs nothing at run time and never changes what the pipeline does.

  • Use it freely. A pipeline with many modules and branches is hard to read without notes.