Open a render
Open a rendered PDF, HTML page or image in the system browser, or list the renders available to open.
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.
rendering-auditor
Multi-pass rendering auditor for content blocks. Validates markdown+TeX syntax, notation consistency, compilation, layout, and visual output across both HTML and PDF pipelines. Used by author agents after edits and as part of QC reports.
Source: folio-assistant-sci/skills/content/folio-paper-adapter/rendering-auditor.md.
The skill declares no I/O contract (schemas/skills/rendering-auditor/{input,output}.schema.json).
staging-review
Staging preview and before/after comparison for content review. Takes one optional string — what the reader wants to look at, in their own words — and returns a list of URLs, each looked up in the publish ref, with what is published at it and what to review there. Provides before (MAIN) and after (branches/) pairs so reviewers can compare rather than guess. Used by the CRDM feature development workflow, content authoring review sessions, and whenever a staging preview deploys or someone asks to see it.
Source: cat-harness/skills/ui/ui-core/staging-review.md.
Also satisfied by: folio-changeset.
input — cat-harness/schemas/skills/staging-review/input.schema.json, https://litlfred.github.io/folio-assistant/cat-harness/skills/staging-review/input.schema.json
| field | type | required | description |
|---|---|---|---|
ask | string | What the reader wants to look at, verbatim. Absent: the whole preview, every page the branch changed. | |
branch | string | ||
pr | integer |
output — cat-harness/schemas/skills/staging-review/output.schema.json, https://litlfred.github.io/folio-assistant/cat-harness/skills/staging-review/output.schema.json
| field | type | required | description |
|---|---|---|---|
narrative | string | yes | What a reader of the site will now see or do differently, and why, before any link. |
startHere | string | The one page to open first. | |
stagingLinks | stagingLinks | yes |
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 | file | RepoPath | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. | ||
| in | format | PreviewFormat | string · one of pdf, html, png · A previewable artefact: pdf, html or png. | ||
| in | list | Flag | boolean · A boolean switch — projects to a bare flag, with no value word | ||
| out | opened | Markdown | What was opened, or the list of candidates. | string · Markdown text. Not admissible as a command-line argument — see INJECTION_SAFE. |
Processes and tasks
Steps this Tool can carry out, because each names a skill it satisfies:
| process | step | lane | via skill |
|---|---|---|---|
| Review task | Classify what changed | Reviewer / SME | staging-review |
| CRDM Phase 6 — implement, MVP, acceptance | Post summary to issue | Agent | staging-review |
| CRDM Phase 6 — implement, MVP, acceptance | Share MVP with stakeholders | BA / Feature Requestor | staging-review |
| Code change and review | Commit, push, open the PR | Authoring agent | staging-review |
| Code change and review | Review the change | Code reviewer | staging-review |
| Staging a feature branch preview, and taking it down | Comment the preview URL on the PR | CI/CD Pipeline | staging-review |
| Staging a feature branch preview, and taking it down | Post the retention notice on the PR | CI/CD Pipeline | staging-review |
| Adopting an upstream version bump | Review the MVP against what we bind to | Reviewer / SME | staging-review |
| Questionnaire wireframe review | Ask for review with deep links | FHIR modeller | staging-review |
| Committee review of a content change | Compare main vs staging | Review Committee | staging-review |
| Committee review of a content change | Slice the change and assign reviewers | Review Coordinator | staging-review |
| Content Change and Review | Review staged rendering | Content Author | staging-review |
| Content Change and Review | Request further revisions | Content Author | staging-review |
| Content Change and Review | Submit to review committee | Content Author | staging-review |
| Draft, review and publish | Circulate the draft | Publication manager | staging-review |
| Draft, review and publish | Review the draft publication | Review team (content · QC · technical officer) | staging-review |
| Draft, review and publish | Clinical or scientific sign-off | Clinical / scientific SMEs | staging-review |
| Make a decided public comment change | Review the change set on its staging preview | Change set — feature branch and staging | staging-review |
| Review and publish a folio | Review and record feedback | Reviewer | staging-review |
| SMART Guideline end to end | Review each L2 asset (before / after if adapted) | Human adjudicators | staging-review |
| SMART Guideline end to end | Review each L3 asset (before / after if adapted) | Human adjudicators | staging-review |
| SMART Guideline end to end | Adjudicate the L4 wireframes and application | Human adjudicators | staging-review |
| Classify and code content | Stage codings, warnings and exclusions for review | Authoring agent | staging-review |
| L2 component edit and review | Ask for review with staging deep links | Authoring agent | staging-review |
How it is deployed and reached
- MCP. Served as
paper_previewbysage(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.jsondeclares. - In process.
adapters/paper/tools/preview.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_preview — read from its registrar.
| parameter | type | required | description |
|---|---|---|---|
file | string | Specific file to open (path relative to build/ or absolute) | |
format | pdf \| html \| png | Filter by format when listing available renders | |
list | boolean | Just list available renders without opening |
As an API: its operation in the OpenAPI document and the MCP tool list of its layer.
| install | none |
| network | no |
What it is made of
| role | file | |
|---|---|---|
| definition | folio-assistant-sci/tools/paper-preview/paper-preview.ts | |
| in-process module | folio-assistant-sci/adapters/paper/tools/preview.ts |
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-preview.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-preview.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-preview",
"title": "Open a render",
"description": "Open a rendered PDF, HTML page or image in the system browser, or list the renders available to open.",
"install": {
"none": true
},
"invoke": {
"mcp": {
"tool": "paper_preview"
},
"inProcess": {
"module": "adapters/paper/tools/preview.ts"
}
},
"io": {
"inputs": [
{
"name": "file",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"required": false,
"arg": {
"positional": 0
}
},
{
"name": "format",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/PreviewFormat",
"required": false,
"arg": {
"flag": "--format"
}
},
{
"name": "list",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
"required": false,
"arg": {
"flag": "--list"
}
}
],
"outputs": [
{
"name": "opened",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Markdown",
"description": "What was opened, or the list of candidates."
}
]
},
"satisfies": [
"rendering-auditor",
"staging-review"
],
"requirements": {
"network": false
}
}