catalog-payload-report

command
v0.2.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

README

Catalog Payload Report

This maintainer tool measures both the internal normalized Unity tool catalog and the actual serialized MCP tool definitions. It reports Compact and profile tools/list definition bytes separately from tool, action, and legacy full-vs- selected-action describe sizes. Token counts remain clearly labelled rough JSON estimates rather than provider billing claims.

Generate a report

Export the live catalog from a disposable blank Unity project that contains the candidate Connector and no project-specific [HeraTool] classes:

go run . --project $env:HERA_UNITY_PROJECT list --catalog `
  --schema_version hera.tool-catalog/1 > catalog.json

go run ./tools/catalog-payload-report `
  --catalog catalog.json `
  --output docs/metrics/catalog-payload-baseline.json

Compare with the reviewed baseline

go run ./tools/catalog-payload-report `
  --catalog catalog.json `
  --compare docs/metrics/catalog-payload-baseline.json `
  --fail-on-change

--fail-on-change marks review required when the canonical catalog hash changed or any measured surface grew. --fail-on-growth ignores a same-size contract change and marks review required only for positive tool, action, description, normalized profile, Compact MCP, or profile MCP payload deltas. A directly built binary exits with code 3; go run returns its own non-zero status and prints exit status 3.

A failure does not mean growth is forbidden. It means the change must include:

  • the user-visible failure or missing workflow being solved;
  • why an existing tool action or flag could not carry it;
  • strict input/output and safety contracts;
  • regression and live Unity evidence; and
  • an intentionally regenerated baseline reviewed in the same change.

tools/verify-unity-package/run-package-tests.ps1 runs this comparison before the package EditMode suite. Use a disposable blank project so project custom tools do not contaminate the built-in Connector baseline.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL