Tools / registry_snapshot
registry_snapshot
Read mappings together with active traits and objects in one snapshot.
Generated from @oods/foundry 0.10.1
One of the 20 tools your assistant sees by default.
Use it when needing a combined registry view and canonical ETag; use catalog_list instead to choose components, structured_data_fetch for an individual dataset, or object_registry to inspect/register a definition. Returns mappings, traits, objects, generatedAt, ETag and registry loader issues. Defaults to a summary; detail full adds schemas. includeInternal exposes hidden objects; otherwise hiddenInternal counts omitted entries. Team definitions and shadowing are reported from live sources. This read-only call writes no snapshot file. Historical mapping fields remain stored data and do not imply current capabilities. Reference: TOOL-REFERENCE.md#registry_snapshot; full schema: oods://schemas/registry_snapshot.input.json.
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
includeInternal | boolean | no | Also list OODS Foundry's internal (non-business) objects, after the business objects. Without it they are left out and registry.hiddenInternal counts them. |
detail | "summary" | "full" | no | summary (default), or full definitions, best with names. |
names | string[] | no | Exact trait and object names; misses go in notFound. |
Outputs
| Name | Type | Required | Description |
|---|---|---|---|
registry | object | no | Live object and trait names, source and any unused/shadowed definitions. |
maps | object[] | yes | |
traits | object | yes | |
objects | object | yes | |
etag | string | yes | |
detail | "summary" | "full" | no | The detail level of traits and objects in this snapshot. |
notFound | string[] | no | Requested names that match no trait or object. |
generatedAt | string | yes |
A real call
Recorded by this site's system run, step registry-snapshot, with the published OODS Foundry
0.10.1.
Its input:
{
"detail": "full"
}Its result, first lines:
{
"maps": [],
"traits": {
"Addressable": {
"name": "Addressable",
"version": "1.0.0",
"description": "Canonical multi-role address trait with validation metadata, geocoding, and international formatting hooks.\nProvides a single, reusable capability for billing, shipping, warehouse, and office addresses.",
"category": "core",
"tags": [
"address",
"location",
"validation",
"delivery"
],
"contexts": [
"detail",
"form",
"list"
],
"viewExtensions": [
{
"component": "AddressSummaryBadge",
"context": "list",
"position": "after",
"priority": null,
"props": {
"field": "default_address_role"
}
},
{
"component": "AddressCollectionPanel",
"context": "detail",
"position": "main",
"priority": 60,
"props": {
"field": "addresses",
"roleField": "address_roles",
"defaultRoleField": "default_address_role",
"roleParameter": "roles"
}
},
{
"component": "AddressEditor",
"context": "form",
"position": "top",
"priority": null,
"props": {
"field": "addresses",
"roleParameter": "roles",
"allowDynamicParameter": "allowDynamicRoles",
"defaultRoleField": "default_address_role"
}
}
],
"parameters": [
{
"name": "roles",
"type": "string[]",
"required": true,
"description": "Ordered list of supported address roles (billing, shipping, warehouse, etc.).",