Content manifest validation

Validate the block manifests under a path against their schemas.

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.

content-validate

Source: cat-harness/skills/authoring/content-lifecycle/content-validate.md.

Also satisfied by: content-graph-build.

input [1..1]output [1..1]pages [0..*]results [0..*]pages [0..*]stagingLinks [0..1]stagingLinks [0..1]content-validate«skill»content-validateinput : ContentValidateInput [1..1]output : ContentValidateOutput [1..1]ContentValidateInput«json-schema»ContentValidateInputtargetPath : string [1..1]validationRules : string[] [0..*]schemaRefs : string[] [0..*]stagingLinks : stagingLinks [0..1]stagingLinks.pages«json-schema»stagingLinks.pagestitle : string [1..1]before : string [0..1]after : string [0..1]summary : string [0..1]stagingLinks«json-schema»stagingLinksbranch : string [1..1]slug : string [1..1]branchUrl : string [1..1]pr : integer [0..1]mainBaseUrl : string [1..1]stagingBaseUrl : string [1..1]pages : stagingLinks.pages[] [0..*]missing : string[] [0..*]ContentValidateOutput«json-schema»ContentValidateOutputoverallStatus : "pass" | "warnings" | "errors" [1..1]results : ContentValidateOutput.results[] [0..*]stagingLinks : stagingLinks [0..1]ContentValidateOutput.results«json-schema»ContentValidateOutput.resultsrule : string [1..1]status : "pass" | "fail" | "warning" | "skipped" [1..1]message : string [0..1]location : string [0..1]stagingLinks.pages«json-schema»stagingLinks.pagestitle : string [1..1]before : string [0..1]after : string [0..1]summary : string [0..1]stagingLinks«json-schema»stagingLinksbranch : string [1..1]slug : string [1..1]branchUrl : string [1..1]pr : integer [0..1]mainBaseUrl : string [1..1]stagingBaseUrl : string [1..1]pages : stagingLinks.pages[] [0..*]missing : string[] [0..*]

input — cat-harness/schemas/skills/content-validate/input.schema.json, https://litlfred.github.io/folio-assistant/cat-harness/skills/content-validate/input.schema.json

fieldtyperequireddescription
targetPathstringyesPath to content to validate.
validationRulesstring[]Specific validation rule IDs to run (empty = all applicable).
schemaRefsstring[]Schema files to validate against.
stagingLinksstagingLinksThe staging preview of the work under review, as the request for feedback carried it, so the reviewer opens the changed pages rather than rebuilding links. Rule: cat-harness skills/authoring/content-lifecycle/feedback-deep-links.md.

output — cat-harness/schemas/skills/content-validate/output.schema.json, https://litlfred.github.io/folio-assistant/cat-harness/skills/content-validate/output.schema.json

fieldtyperequireddescription
overallStatuspass \| warnings \| errorsyes
resultsobject[]yes
stagingLinksstagingLinksThe staging preview of the work this output asks a person to look at: one deep link per changed page, with the same page on main. Required whenever a preview exists; when it does not, say so in missing. Rule: cat-harness skills/authoring/content-lifecycle/feedback-deep-links.md.

content-validation

Source: folio-assistant-sci/skills/content/folio-paper-adapter/content-validation.md.

Also satisfied by: paper-latex-build.

The skill declares no I/O contract (schemas/skills/content-validation/{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
intargetPathRepoPathA paper or chapter directory; absent, every paper the folio declares.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
instrictFlagTreat warnings as errors.boolean · A boolean switch — projects to a bare flag, with no value word
outissuesTextOne line per issue, with its block and file. Exit 2 means NO FOLIO WAS FOUND — could-not-determine, never valid.string · A short single-line human string. Not admissible as a command-line argument.

Processes and tasks

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

processsteplanevia skill
Review taskAccept, or send backEditors + authoring agentscontent-validate
Authoring a documentCheck the profileBuild pipelinecontent-validate
Authoring a documentValidateBuild pipelinecontent-validate
Content lifecycleEditing and HCI validationEditors + authoring agentscontent-validate
Draft, review and publishEditing and HCI validationEditors + authoring agentscontent-validate
Editing and HCI validationSchema and constraint checksMechanical validation (system)content-validate
Editing and HCI validationSyntax, spelling and linksMechanical validation (system)content-validate
Editing and HCI validationCollate findings into a reportHCI validation pipeline (system)content-validate
Authoring a paperValidateBuild pipelinecontent-validate
DTH authoringValidate the draftBusiness analystcontent-validate
L2 component edit and reviewRun the component’s checkerAuthoring agentcontent-validate
L2 DAK authoringAssemble and validate the DAKBusiness analystcontent-validate

How it is deployed and reached

  • Command line. From the repository root: bun run cat content:validate. cat content:validate runs bun run cat-harness-tools/pipeline/validate.ts (declared in cat-harness-tools/package.json).
  • GitHub Actions. No workflow in this checkout runs its command.

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

installnone
runtimebun
networkno

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/folio-assistant-sci/tools/content-manifest-validate.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/folio-assistant-sci/folio-assistant-sci.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/folio-assistant-sci/tools/content-manifest-validate.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/folio-assistant-sci/folio-assistant-sci.jsonld",
  "name": "content-manifest-validate",
  "title": "Content manifest validation",
  "description": "Validate the block manifests under a path against their schemas.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat content:validate"
  },
  "io": {
    "inputs": [
      {
        "name": "targetPath",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "A paper or chapter directory; absent, every paper the folio declares.",
        "required": false,
        "arg": {
          "positional": 0
        }
      },
      {
        "name": "strict",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Treat warnings as errors.",
        "required": false,
        "arg": {
          "flag": "--strict"
        }
      }
    ],
    "outputs": [
      {
        "name": "issues",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "One line per issue, with its block and file. Exit 2 means NO FOLIO WAS FOUND — could-not-determine, never valid."
      }
    ]
  },
  "satisfies": [
    "content-validate",
    "content-validation"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  }
}

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