ArchiMate model from the glossary

Make an ArchiMate model agree with the instance’s folio-glossary/v1 terms whose focus is an ArchiMate element: elements matched by their skosConcept property (never by name) take the term’s prefLabel and definition, a term with no element gets one on no view, and the relationships the terms list are added. A type that disagrees is reported, never changed. A relationship between two linked elements that no term lists is reported, and removed with --prune along with the lines that draw it. No box or line is moved. Without --write it only reports; --check fails when anything would change. --seed goes the other way once, and only from an ingested model held under library/ (--from): an authored model is never a source of the glossary.

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, bibliography-page, glossary-page, glossary-table, references-render, 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.

porttyperequireddescriptionconstraint
ininstanceRepoPathyesThe instance root holding glossary/*.glossary.json and archimate/cat-archimate.config.json.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
inmodelArchimateModelIdThe model’s id in the ArchiMate config. Required except with --seed --from.string · pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$ · An ArchiMate model’s id in cat-archimate.config.json, e.g. 0.2.0
inwriteFlagWrite the changes into the model file.boolean · A boolean switch — projects to a bare flag, with no value word
inpruneFlagAlso remove relationships between linked elements that no term lists.boolean · A boolean switch — projects to a bare flag, with no value word
inseedFlagOnce: give linked terms without a focus the element type and relationships of an INGESTED model (under library/). Refused for an authored model.boolean · A boolean switch — projects to a bare flag, with no value word
infromRepoPathWith --seed: the ingested model file, under the instance’s library/.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
incheckFlagFail if the model and the graph disagree.boolean · A boolean switch — projects to a bare flag, with no value word
outmodelRepoPathThe model file, rewritten in place with --write.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 archimate:from-glossary. cat archimate:from-glossary runs bun run folio-assistant-core/scripts/archimate-from-glossary.ts (declared in folio-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.

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/archimate-from-glossary.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/archimate-from-glossary.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": "archimate-from-glossary",
  "title": "ArchiMate model from the glossary",
  "description": "Make an ArchiMate model agree with the instance's folio-glossary/v1 terms whose `focus` is an ArchiMate element: elements matched by their `skosConcept` property (never by name) take the term's prefLabel and definition, a term with no element gets one on no view, and the relationships the terms list are added. A type that disagrees is reported, never changed. A relationship between two linked elements that no term lists is reported, and removed with `--prune` along with the lines that draw it. No box or line is moved. Without `--write` it only reports; `--check` fails when anything would change. `--seed` goes the other way once, and only from an ingested model held under `library/` (`--from`): an authored model is never a source of the glossary.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat archimate:from-glossary"
  },
  "io": {
    "inputs": [
      {
        "name": "instance",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The instance root holding `glossary/*.glossary.json` and `archimate/cat-archimate.config.json`.",
        "required": true,
        "arg": {
          "flag": "--instance"
        }
      },
      {
        "name": "model",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/ArchimateModelId",
        "description": "The model's id in the ArchiMate config. Required except with `--seed --from`.",
        "required": false,
        "arg": {
          "flag": "--model"
        }
      },
      {
        "name": "write",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Write the changes into the model file.",
        "required": false,
        "arg": {
          "flag": "--write"
        }
      },
      {
        "name": "prune",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Also remove relationships between linked elements that no term lists.",
        "required": false,
        "arg": {
          "flag": "--prune"
        }
      },
      {
        "name": "seed",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Once: give linked terms without a focus the element type and relationships of an INGESTED model (under `library/`). Refused for an authored model.",
        "required": false,
        "arg": {
          "flag": "--seed"
        }
      },
      {
        "name": "from",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "With `--seed`: the ingested model file, under the instance's `library/`.",
        "required": false,
        "arg": {
          "flag": "--from"
        }
      },
      {
        "name": "check",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Fail if the model and the graph disagree.",
        "required": false,
        "arg": {
          "flag": "--check"
        }
      }
    ],
    "outputs": [
      {
        "name": "model",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The model file, rewritten in place with `--write`."
      }
    ]
  },
  "satisfies": [
    "graph-rendering"
  ],
  "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