Skip to content

Catalogue format

Use the authoritative directory, marker, schema, adapter-artifact, and validation contract when creating or checking a catalogue.

Two markers make a directory a valid agentbundle catalogue:

  • catalogue.toml at the catalogue root
  • literal root packs/ directory

Both are checked by source_defaults._has_catalogue_markers.

  • catalogue.toml — catalogue configuration. Must pass contracts/catalogue.schema.json.
  • packs/<name>/pack.toml per pack — must pass contracts/pack.schema.json.

.claude-plugin/marketplace.json is generated and required when the effective self-host adapter set includes claude-code. It is not catalogue identity; catalogues that project only a non-Claude adapter may omit it.

All schemas live in contracts/:

A pack may declare one or more pack-local OKF 0.2 knowledge bundles:

[pack.metadata.okf]
profile = "agentbundle-okf/v1"
[[pack.metadata.okf.bundles]]
id = "delivery-practices"
path = "okf/delivery-practices"
"router-skill" = "delivery-practices-reference"

The declaration and packs/<pack>/okf/<bundle>/ tree are canonical source, including the bundle-root index.md, which is hand-authored and must carry okf_version and license. compile-okf owns the generated index.md files beneath .apm/skills/<router>/references/okf/, the portable Skills beneath the same pack’s .apm/skills/, and .okf-generated.json. Maintainers edit source and regenerate; they do not edit managed output as source.

compile-okf and the OKF fields agentbundle show --format json reports are pre-release and repository-scoped. The authoring path is offline and reference-only: bundle content stays inert, generated routers gain no execution or network authority, and compilation is not part of install or agentbundle show. See Author and compile an OKF bundle for the complete write, check, recovery, and discovery workflow.

catalogue.toml carries schema = 1. This is the format version contract. Tooling that implements the agentbundle catalogue format checks this field. The contracts above define what schema = 1 means.

Terminal window
agentbundle catalogue verify --root .

Runs the full 19-step pipeline including schema validation, pack lint, post-build artifact checks, and self-host drift detection.

For CI pipeline patterns using verify, lint, and package — including publication ordering, exit codes, and JSON output shapes — see the Catalogue CI contract.