Skip to content
UPG is in early alpha. The specification is still evolving and may change between versions.
Tools/Spec Introspection/list_catalog

list_catalog

List a static spec catalog by `kind` (one faceted tool replacing the 25 `list_*` spec-introspection tools). Reads `@unified-product-graph/core`; identical for every client on a given spec version. Kind-specific filters pass straight through: e.g. `playbooks` accepts `region` / `canonical_only` / `framework_id`; `entity_types` accepts `domain` / `maturity` / `deprecated` / `limit` / `cursor`; `benchmarks` requires `benchmark_kind` (`count` | `relationship` | `ratio` | `domain_activation`) plus optional `stage` / `domain`. Use `get_catalog_entry` to fetch one record by id.

Spec Introspectionatomic (read-only)

Arguments

kindstringrequired

Which static spec catalog to list.

entity_typesedge_typescross_edge_typesregionsdomainsdomain_ringsframeworksframework_categoriesframework_structure_patternslenseslifecyclesplaybooksscalesanti_patternstree_patternstemplatesapproachestype_labelsstatus_valuesproduct_stagesbenchmarksedge_migrationsscalar_to_edge_migrationssplit_migrationstype_migrations
regionstringoptional

Filter (playbooks): exact UPGRegionId.

canonical_onlybooleanoptional

Filter (playbooks): canonical playbook per region only.

framework_idstringoptional

Filter (playbooks / approaches): exact framework id.

domainstringoptional

Filter (entity_types / benchmarks): exact atomic-domain id.

maturitystringoptional

Filter (entity_types): draft | proposed | stable | deprecated | removed.

deprecatedbooleanoptional

Filter (entity_types): keep only / exclude deprecated types.

stagestringoptional

Filter (benchmarks): UPGProductStage.

benchmark_kindstringoptional

Required for kind=benchmarks: which benchmark catalog (remapped to the retired tool's `kind`).

countrelationshipratiodomain_activation
limitnumberoptional

Pagination (entity_types / type_labels / frameworks / anti_patterns): page size.

cursorstringoptional

Pagination: opaque cursor from a prior `next_cursor`.

Returns

JSON: the delegated list_<kind> payload verbatim (shape varies by kind).

See Also