Reference list from reference nodes
Rewrite each reference-list block of a document (a block whose meta.referenceList is set) from the folio-reference/v1 nodes its cites names, in that order: the node’s printed text verbatim when it has one, otherwise WHO style (or the short Authors. Title. Year. form), as a numbered or bulleted list. The block’s .md is generated whole. --check writes nothing and fails when a list is stale.
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.
graph-rendering
Draw any graph in a harness (schemas, processes, a folio’s block graph and any formal relation its content type adds, a detangle partition) so the picture is derived, checkable and readable. Ten rules, which engine to lay a graph out with and why, and how each graph typology here applies them.
Source: cat-harness/skills/kg/graph-management/graph-rendering.md.
Also satisfied by: auto-docs-viewer, content-graph-uml, document-kinds-viewer, external-schemas-viewer, folio-viewer, kg-viewer, library-viewer, lsi-viewer, methodologies-viewer, node-kind-pages, openapi-pages, processes-viewer, schemas-viewer, site-viewer, staging-graph-viewer, state-viewer, theme-viewer, tools-viewer, translation-status-viewer, uploads-viewer, voices-viewer, web-app-build, archimate-from-glossary, bibliography-page, glossary-page, glossary-table, l1-extraction-pages, iris-pages.
The skill declares no I/O contract (schemas/skills/graph-rendering/{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.
| port | type | required | description | constraint | |
|---|---|---|---|---|---|
| in | instance | RepoPath | yes | The instance root whose folio blocks and references directories are read. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
| in | check | Flag | Fail if a list is stale, instead of writing. | boolean · A boolean switch — projects to a bare flag, with no value word | |
| out | blocks | RepoPath | The rewritten reference-list blocks: each block’s .md. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
Processes and tasks
No process step names a skill this Tool satisfies.
How it is deployed and reached
- Command line. From the repository root:
bun run cat references:render.cat references:renderrunsbun run folio-assistant-core/scripts/references-render.ts(declared infolio-assistant-core/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.
| install | none |
| runtime | bun |
| network | no |
| when to choose it | |
|---|---|
| when | A document’s References list should come from the reference nodes its block cites. For glossary or acronyms tables use glossary-table. |
| limits | Only blocks with meta.referenceList; the whole .md is regenerated. A cited key with no reference node fails the run. |
| cost | Milliseconds per block; reads the instance’s blocks and reference nodes, no network. |
Alternatives (same signature, a shared skill): glossary-table.
What it is made of
| role | file | |
|---|---|---|
| definition | folio-assistant-core/tools/references-render/references-render.ts | |
| script | folio-assistant-core/scripts/references-render.ts |
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/references-render.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/references-render.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": "references-render",
"title": "Reference list from reference nodes",
"description": "Rewrite each reference-list block of a document (a block whose `meta.referenceList` is set) from the folio-reference/v1 nodes its `cites` names, in that order: the node's `printed` text verbatim when it has one, otherwise WHO style (or the short `Authors. Title. Year.` form), as a numbered or bulleted list. The block's `.md` is generated whole. `--check` writes nothing and fails when a list is stale.",
"install": {
"none": true
},
"invoke": {
"shell": "bun run cat references:render"
},
"io": {
"inputs": [
{
"name": "instance",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "The instance root whose folio blocks and references directories are read.",
"required": true,
"arg": {
"flag": "--instance"
}
},
{
"name": "check",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
"description": "Fail if a list is stale, instead of writing.",
"required": false,
"arg": {
"flag": "--check"
}
}
],
"outputs": [
{
"name": "blocks",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "The rewritten reference-list blocks: each block's `.md`."
}
]
},
"satisfies": [
"graph-rendering"
],
"requirements": {
"runtime": [
"bun"
],
"network": false
},
"selection": {
"when": "A document's References list should come from the reference nodes its block cites. For glossary or acronyms tables use glossary-table.",
"limits": "Only blocks with `meta.referenceList`; the whole `.md` is regenerated. A cited key with no reference node fails the run.",
"cost": "Milliseconds per block; reads the instance's blocks and reference nodes, no network."
}
}