Skip to content

Contract schemas ​

The contracts are language-neutral JSON Schemas shared by the core runtime, plugins, recipes, and downstream automation.

SchemaStable surface
plugin.v1.schema.jsonPlugin self-description from manifest --json
catalog.v1.schema.jsonPublished plugin catalog
recipe.v1.schema.jsonExecutable workflow recipe
eval-recipe.v1.schema.jsonEvaluation protocol
terminal-bench-recipe.v1.schema.jsonPinned Terminal-Bench comparison recipe
terminal-bench-report.v1.schema.jsonMatched Terminal-Bench results and pairwise outcomes
run-manifest.v1.schema.jsonDurable execution state
frontier-handoff-request.v1.schema.jsonGeneric chat or agent request to a user-authenticated CLI
frontier-handoff-run.v1.schema.jsonDurable frontier handoff plan and status
frontier-handoff-result.v1.schema.jsonLocal response and provenance receipt
artifact-bundle.v1.schema.jsonFetched result inventory
plugin-bundle.v1.schema.jsonInstallable signed-plugin bundle
plugin-bundle-envelope.v1.schema.jsonSigned publisher statement for a plugin bundle
archive-benchmark.v1.schema.jsonArchive benchmark cases, judgments, and change scenarios
archive-benchmark-report.v1.schema.jsonArchive benchmark metrics and evaluation results
archive-investigation.v1.schema.jsonBounded investigation results, citation paths, unresolved claims, and optional metrics
film-brief.v1.schema.jsonUser-confirmed film requirements and greenlight readiness
film-department-result.v1.schema.jsonStructured proposal returned by a read-only Pi department
film-production-plan.v1.schema.jsonAccepted cast, location, sound, and shot plan
film-production-readiness.v1.schema.jsonModel readiness bound to the accepted plan, including runtime-managed roles
film-project.v1.schema.jsonDurable film phases, approvals, work, proof, and artifact ledger
film-dialogue-qc.v1.schema.jsonSource-bound dialogue synthesis and transcription evidence
film-sound-qc.v1.schema.jsonSource-bound generated sound-effect stream, duration, and audibility evidence
film-media-inspection.v1.schema.jsonPer-shot local generated-media inspection evidence
film-take-selection.v1.schema.jsonEvidence-backed selection across deterministic local shot candidates
film-captions.v1.schema.jsonSource-bound SRT and WebVTT dialogue captions
film-human-review.v1.schema.jsonExplicit decision bound to an exact cut and review evidence set
film-delivery.v1.schema.jsonChecksum-backed master, captions, marketing stills, review package, and provenance handoff
film-animatic-handoff.v1.schema.jsonVerified cast, locations, shot timing, deterministic seeds, and media for native Animatic import
workflow-graph.v1.schema.jsonPortable executable graph
graph-node-provider.v1.schema.jsonTyped provider node catalog
graph-node-invocation.v1.schema.jsonConfined graph-node request
graph-node-preflight.v1.schema.jsonStructured node readiness report
graph-node-event.v1.schema.jsonStreamed node progress, artifact, diagnostic, metric, and result events
graph-run.v1.schema.jsonPortable graph execution record
graph-template-catalog.v1.schema.jsonDiscoverable reusable graph templates
graph-template-package.v1.schema.jsonConfined user-published graph template
workflow-program.v1.schema.jsonReusable composition and static expansion source
workflow-module.v1.schema.jsonReusable imported graph module
workflow-editor-sidecar.v1.schema.jsonNon-executable canvas state

For information about installable code, publisher verification, and activation, see Signed plugin bundles.

Versioning ​

Contract identifiers carry an explicit version such as mere.run/plugin-catalog.v1. Additive implementation changes can remain within the version only when existing valid documents and consumers keep their meaning. Breaking shape or semantic changes require another contract version.

Change rule ​

If a plugin needs an additional contract field, update all affected surfaces together:

  • schema;
  • plugin implementation;
  • catalog or recipe examples;
  • docs;
  • validation and unit tests.

Provider-specific behavior belongs in plugin code and documentation, not in a shared schema unless multiple consumers genuinely need the field.

Validation ​

./scripts/check.sh validates contracts, catalog entries, recipes, examples, and installed plugin smoke surfaces. See Testing.

Official companion plugins for the local mere.run runtime.