Glossary build

Build a paper’s glossary index from its manifests and render the LaTeX. --check reports drift instead of writing, comparing everything except the generated timestamp so a re-run is not mistaken for a change.

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.

document-intake

Process uploaded documents (PDFs, scans, LaTeX, structured/normative guidelines, etc.) from uploads/ into structured content objects. Handles OCR extraction, environment detection, structural analysis, and content-object generation. Supports multi-stage pipelines: raw upload → extracted text → structured blocks → .ts/.md content objects.

Source: folio-assistant-core/skills/library/ingestion/document-intake.md.

The skill declares no I/O contract (schemas/skills/document-intake/{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
intargetPathRepoPathyesThe paper directory, which must hold a <paper>.ts manifest. Absent, the command exits 2 with its usage — could-not-determine, not an empty glossary.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
incheckFlagReport drift and write nothing.boolean · A boolean switch — projects to a bare flag, with no value word
outglossaryRepoPathglossary.json beside the paper, and chapters/glossary.tex at the repo root.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.

Processes and tasks

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

processsteplanevia skill
Getting startedScan the repo for content worth importingOnboarding agent (system)document-intake
Evidence for a recommendationSearch trusted L1 sourcesEvidence agent (system)document-intake
Evidence for a recommendationSearch trusted L2 and L3 contentEvidence agent (system)document-intake
Evidence for a recommendationQuery data repositories and statistical datasetsEvidence agent (system)document-intake
L1 document ingestion — a document to the L1 source knowledge graphDetect media type, mint a doc idIngestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graphEstablish the licence from the uploadIngestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graphExtract structureIngestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graphDerive content from the assetsIngestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graphBuild the L1 knowledge graphIngestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graph[Move into library//](../../../processes/l1-document-ingestion.html#step-Task_Promote)Ingestion Engine (agent, runs unattended)document-intake
L1 document ingestion — a document to the L1 source knowledge graphAvailable to cite as an L1 sourceIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — build the L1 knowledge graphWrite dublin-core.jsonld (the record of truth)Ingestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — build the L1 knowledge graphWrite manifest.jsonld referencing itIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — build the L1 knowledge graphRecord assets[] — local path or remote URLIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — build the L1 knowledge graphBind the folder to its bibliography slugIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — build the L1 knowledge graphLink L1 nodes into the corpus graphIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsArchive → greppable contents manifestIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsFile info, sizes, hashes, timestamps, mimetypeIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsNarrative description per image, localizedIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsTranscribe and translate audioIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsSheet names, headers, shape, narrativeIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsExtract figures and tablesIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — derive content from the assetsCite the author of every narrativeIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — extract structureExtract the text layerIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — extract structureOCR to ocr/page-*.txtIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — extract structureSplit into sections/*.md with doc_brief front-matterIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — extract structureWrite structure.jsonIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — extract structureExtract claim candidatesIngestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — the L1 completeness gateIs every derived artefact present?Ingestion Engine (agent, runs unattended)document-intake
Ingestion subprocess — the L1 completeness gateAdjudicate the flagged passageReviewer (SME or editor)document-intake
Ingestion subprocess — the L1 completeness gateRecord the L1 completeness verdictIngestion Engine (agent, runs unattended)document-intake

How it is deployed and reached

  • Command line. From the repository root: bun run folio-assistant-core/scripts/build-glossary.ts.
  • 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-core/tools/glossary-build.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-core/folio-assistant-core.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/folio-assistant-core/tools/glossary-build.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/folio-assistant-core/folio-assistant-core.jsonld",
  "name": "glossary-build",
  "title": "Glossary build",
  "description": "Build a paper's glossary index from its manifests and render the LaTeX. `--check` reports drift instead of writing, comparing everything except the `generated` timestamp so a re-run is not mistaken for a change.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run folio-assistant-core/scripts/build-glossary.ts"
  },
  "io": {
    "inputs": [
      {
        "name": "targetPath",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The paper directory, which must hold a `<paper>.ts` manifest. Absent, the command exits 2 with its usage — could-not-determine, not an empty glossary.",
        "required": true,
        "arg": {
          "positional": 0
        }
      },
      {
        "name": "check",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Report drift and write nothing.",
        "required": false,
        "arg": {
          "flag": "--check"
        }
      }
    ],
    "outputs": [
      {
        "name": "glossary",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "`glossary.json` beside the paper, and `chapters/glossary.tex` at the repo root."
      }
    ]
  },
  "satisfies": [
    "document-intake"
  ],
  "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