Agent-Metadaten

Jedes Pipelogic-component liefert einen maschinenlesbaren Agent-Brief neben seiner component.yml und README.md aus. Der Brief teilt einem Agent oder einem Operator mit, zu welcher Aufgabe das component passt, welche Formen es akzeptiert, welche Überraschungen ein Aufrufer sonst treffen würde und welches Setup es vor der Ausführung braucht. README.md trägt die menschengerichtete Erzählung und component.yml den typisierten Katalog-Kontrakt; der Agent-Brief ist die strukturierte Spezifikation, die ein Modell konsumiert, wenn es entscheidet, ob es ein component für einen Graphen auswählt, wie es zu verdrahten ist und welche runtime-Eigenheiten zu erwarten sind.

Der Brief wird als AGENT.yml — das kanonische Format — verfasst oder als AGENT.json bereitgestellt, dasselbe Schema serialisiert für Tools, die maschinell erzeugte Payloads ausgeben. Ein component trägt eines oder das andere; sind beide vorhanden, wird das Hochladen abgelehnt. Das Manifest wird gegen ein festes Schema geparst, sodass Katalogfakten, die bereits in component.yml leben — Parameter-Keys, Port-Typen, Tags, Nachbarn, Alternativen — dort bleiben und nie im Brief dupliziert werden.

Ein Manifest deklariert eine schema_version, eine einsätzige summary, geformt als Eingabe → Transformation → Ausgabe, eine pick_when-Liste, klassifizierte behavior_notes und optionale required_setup- und outputs-Blöcke. Die pick_when-Liste formuliert jeden Eintrag als aufrufergerichtete Entscheidung (binäre Bildframes an einen Webhook ausliefern) statt als Mechanik des components, gepaart mit einem data_shape, das den typisierten Fluss beschreibt, und einem optionalen constraint, das die Vorbedingung beschreibt. behavior_notes klassifiziert jede Note als hard_constraint-, silent_fallback-, parameter_interaction-, edge_case-, state_lifetime- oder ordering-Regel, sodass Agents die richtigen für die Frage scannen können, die sie beantworten. Templates der Form {{type:Foo}}, {{component:bar}} und {{param:baz}} werden zur Renderzeit aufgelöst, um die Fläche über Umbenennungen hinweg konsistent zu halten.

Die vollständige Feldreferenz, die behavior_notes-Taxonomie, das Upload-Flag und die Regeln darüber, was NICHT zu schreiben ist, leben in der CLI:

ppl docs get component-api/agent-metadatappl docs get component-api/component-contractppl docs get file-api/file-typesppl docs get concepts/solutions

Verwandt

War diese Seite hilfreich?