Per-harness setup position and health

For every harness in the checkout, run bootstrap’s setup check without performing anything or touching the network, and write one folio-harness-state/v1 file: each step in its state, the first step not done (its position) with what to do next, and health badges that are the harness’s own (setup steps; the layer’s committed health report, unknown without one). A recommendation is said, never acted on.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

initialization-steps

Walk every initialization step the declarations name (the layer’s own and each one it needs), check each before doing anything, do what can be done, ask for what only a person can do, and report every step as done, not done, could not determine, or stated.

Source: bootstrap/skills/initialization-steps.md.

The skill declares no I/O contract (schemas/skills/initialization-steps/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
inoutRepoPathWhere <harness>.json and index.json go. The deploy passes ./_site/assets/harnesses. Absent: print the states and write nothing.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
injsonFlagPrint the states as JSON and write nothing.boolean · A boolean switch — projects to a bare flag, with no value word
outstatesRepoPathOne <harness>.json per harness and an index.json listing them with their positions.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
outreportTextOne line per harness: its position, the next step, and its badges.string · A short single-line human string. Not admissible as a command-line argument.
outresultHarnessStatesWith –json, or with no –out, every harness’s state as one HarnessStates record, in name order. Programs read this; people read report.array · Every harness’s initialization position, next step and health badges, in name order.

Processes and tasks

Steps this Tool can carry out, because each names a skill it satisfies:

processsteplanevia skill
Complete initializationCheck the JSON Schemas and JSON-LD are at their IRIsBootstrapping Agentinitialization-steps
Complete initializationList the steps the declarations nameBootstrapping Agentinitialization-steps
Complete initializationCheck itBootstrapping Agentinitialization-steps
Complete initializationDo it, then check againBootstrapping Agentinitialization-steps
Complete initializationFollow it, and say that you didBootstrapping Agentinitialization-steps
Complete initializationRecord the step in its stateBootstrapping Agentinitialization-steps
Initialize a harnessMake sure every step is doneBootstrapping Agentinitialization-steps

How it is deployed and reached

  • Command line. From the repository root: bun run cat harness:state. cat harness:state runs bun run cat-harness-tools/scripts/harness-state.ts (declared in cat-harness-tools/package.json).
  • GitHub Actions. 2 workflow line(s) run its command:
workflowline
.github/workflows/docs-site.yml988bun run cat harness:state --out ./_site/assets/harnesses
.github/workflows/feature-staging.yml1764bun run cat harness:state --out ./_site/assets/harnesses

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimebun
networkno
when to choose it
whenA page or an agent needs to know, per harness, how far its setup got and what to do next, or whether the harness itself is healthy, as against its repository.
limitsOffline and dry-run: a step that needs the network (documents at their IRIs, Pages live) is could-not-determine, never done. In an index that mounts a layer in part, every step looking for a file in it is could-not-determine. Built at deploy and never committed, so it describes the tree the deploy published.
costAbout 6 seconds for 11 harnesses. Nothing to install, no network.

What it is made of

Linked data

The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/cat-harness/tools/harness-state.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "https://litlfred.github.io/folio-assistant/cat-harness/cat-harness.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/cat-harness/tools/harness-state.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/cat-harness/cat-harness.jsonld",
  "name": "harness-state",
  "title": "Per-harness setup position and health",
  "description": "For every harness in the checkout, run bootstrap's setup check without performing anything or touching the network, and write one `folio-harness-state/v1` file: each step in its state, the first step not done (its position) with what to do next, and health badges that are the harness's own (setup steps; the layer's committed health report, unknown without one). A recommendation is said, never acted on.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat harness:state"
  },
  "io": {
    "inputs": [
      {
        "name": "out",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "Where `<harness>.json` and `index.json` go. The deploy passes `./_site/assets/harnesses`. Absent: print the states and write nothing.",
        "required": false,
        "arg": {
          "flag": "--out"
        }
      },
      {
        "name": "json",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Print the states as JSON and write nothing.",
        "required": false,
        "arg": {
          "flag": "--json"
        }
      }
    ],
    "outputs": [
      {
        "name": "states",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "One `<harness>.json` per harness and an `index.json` listing them with their positions."
      },
      {
        "name": "report",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "One line per harness: its position, the next step, and its badges."
      },
      {
        "name": "result",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/HarnessStates",
        "description": "With --json, or with no --out, every harness's state as one `HarnessStates` record, in name order. Programs read this; people read `report`."
      }
    ]
  },
  "satisfies": [
    "initialization-steps"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  },
  "selection": {
    "when": "A page or an agent needs to know, per harness, how far its setup got and what to do next, or whether the harness itself is healthy, as against its repository.",
    "limits": "Offline and dry-run: a step that needs the network (documents at their IRIs, Pages live) is could-not-determine, never done. In an index that mounts a layer in part, every step looking for a file in it is could-not-determine. Built at deploy and never committed, so it describes the tree the deploy published.",
    "cost": "About 6 seconds for 11 harnesses. Nothing to install, no network."
  }
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev