Rendering preferences

Read, write or clear the stored rendering preferences — engine, format, scope, math renderer, print mode.

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.

build-pdf

Builds a paper folio’s PDF locally in the workspace — the monolithic PDF plus split per-chapter PDFs.

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

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

build-docs

Builds the Lean HTML documentation (doc-gen4) locally in the workspace, for any paper folio’s Lean package.

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

The skill declares no I/O contract (schemas/skills/build-docs/{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
inactionPreferenceActionstring · one of get, set, reset · Read, write or clear the stored preferences.
inrender_formatRenderFormatstring · one of pdf, html · A render target: pdf or html.
inrender_scopeRenderScopestring · one of full, chapter, section · How much of the folio to render.
inlatex_engineLatexEnginestring · one of pdflatex, lualatex, xelatex · The TeX engine.
inmath_rendererMathRendererstring · one of katex, mathjax · The browser-side math renderer.
inauto_previewFlagboolean · A boolean switch — projects to a bare flag, with no value word
informula_dpiDpiinteger · Dots per inch for rendered formulae.
indefault_chapterRepoPathstring · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
inprint_modePrintModestring · one of formal, compact · Typesetting density.
incompact_inline_refsFlagboolean · A boolean switch — projects to a bare flag, with no value word
outpreferencesMarkdownThe preferences after the call.string · Markdown text. Not admissible as a command-line argument — see INJECTION_SAFE.

Processes and tasks

No process step names a skill this Tool satisfies.

How it is deployed and reached

  • MCP. Served as paper_preferences by sage (cat-harness-tools/scripts/sage-mcp.sh), google-drive (cat-harness-tools/scripts/google-drive-mcp.sh), folio-assistant (bun run cat-harness-tools/src/index.ts --stdio --repo .), the servers .mcp.json declares.
  • In process. adapters/paper/tools/preferences.ts — loaded by the harness directly, with no server.
  • GitHub Actions. No workflow in this checkout runs its command.

The MCP tool it serves, as tools/list answers:

paper_preferences — read from its registrar.

paper_preferences [1..1]paper-preferences«tool»paper-preferencespaper_preferences : PaperPreferencesInput [1..1]PaperPreferencesInput«json-schema»PaperPreferencesInputaction : "get" | "set" | "reset" [0..1]render_format : "pdf" | "html" [0..1]render_scope : "full" | "chapter" | "section" [0..1]latex_engine : "pdflatex" | "lualatex" | "xelatex" [0..1]math_renderer : "katex" | "mathjax" [0..1]auto_preview : boolean [0..1]formula_dpi : number [0..1]default_chapter : string [0..1]print_mode : "formal" | "compact" [0..1]compact_inline_refs : boolean [0..1]
parametertyperequireddescription
actionget \| set \| resetAction: get current, set values, or reset to defaults
render_formatpdf \| htmlPreferred output format
render_scopefull \| chapter \| sectionDefault render scope
latex_enginepdflatex \| lualatex \| xelatexLaTeX engine
math_rendererkatex \| mathjaxMath renderer for HTML output
auto_previewbooleanAutomatically open in browser after render
formula_dpinumberDPI for formula preview PNG
default_chapterstringDefault chapter to render when scope=chapter
print_modeformal \| compactPrint mode: formal (affiliations, expanded) or compact (dense, no affiliations)
compact_inline_refsbooleanIn compact mode, include examples/remarks directly referenced by blocks in the view

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

installnone
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/paper-preferences.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/paper-preferences.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": "paper-preferences",
  "title": "Rendering preferences",
  "description": "Read, write or clear the stored rendering preferences — engine, format, scope, math renderer, print mode.",
  "install": {
    "none": true
  },
  "invoke": {
    "mcp": {
      "tool": "paper_preferences"
    },
    "inProcess": {
      "module": "adapters/paper/tools/preferences.ts"
    }
  },
  "io": {
    "inputs": [
      {
        "name": "action",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/PreferenceAction",
        "required": false,
        "arg": {
          "flag": "--action"
        }
      },
      {
        "name": "render_format",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RenderFormat",
        "required": false,
        "arg": {
          "flag": "--render-format"
        }
      },
      {
        "name": "render_scope",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RenderScope",
        "required": false,
        "arg": {
          "flag": "--render-scope"
        }
      },
      {
        "name": "latex_engine",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/LatexEngine",
        "required": false,
        "arg": {
          "flag": "--latex-engine"
        }
      },
      {
        "name": "math_renderer",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/MathRenderer",
        "required": false,
        "arg": {
          "flag": "--math-renderer"
        }
      },
      {
        "name": "auto_preview",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "required": false,
        "arg": {
          "flag": "--auto-preview"
        }
      },
      {
        "name": "formula_dpi",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Dpi",
        "required": false,
        "arg": {
          "flag": "--formula-dpi"
        }
      },
      {
        "name": "default_chapter",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "required": false,
        "arg": {
          "flag": "--default-chapter"
        }
      },
      {
        "name": "print_mode",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/PrintMode",
        "required": false,
        "arg": {
          "flag": "--print-mode"
        }
      },
      {
        "name": "compact_inline_refs",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "required": false,
        "arg": {
          "flag": "--compact-inline-refs"
        }
      }
    ],
    "outputs": [
      {
        "name": "preferences",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Markdown",
        "description": "The preferences after the call."
      }
    ]
  },
  "satisfies": [
    "build-pdf",
    "build-docs"
  ],
  "requirements": {
    "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