Run the immunization schedule-check app locally on a WHO or country IG
Start litlfred/awho-mcp’s schedule-check web form on this machine: a HAPI FHIR server in Docker, the WHO SMART Immunizations IG loaded, then optionally a country adaptation IG (its decision-logic tables replace WHO’s; its country profile is generated from its input/l2/dependencies.yaml), the CQL cache warmed, and the form served. Both listen on 127.0.0.1. Unbuilt IGs are built with SUSHI first, and each Library’s CQL is embedded from input/cql/ as the IG Publisher would. A re-run reuses a server loaded from the same commits; --down stops both.
| Tool | immz-schedule-app-local |
| IRI | http://smart.who.int/base/tools/immz-schedule-app-local.jsonld |
| part of | http://smart.who.int/base/smart-base.jsonld |
| type | https://litlfred.github.io/cat-harness/v0/ns/Tool |
| declared by | smart-base |
| invoked | shell |
| qa | qa-reports |
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.
l4-application-run-local
Run an L4 application that is already built, on the agent’s own machine, against a clean IG build, so a person can try or demonstrate it before anything is hosted. Read before starting a local copy of an L4 app for a review, a demo or a country adaptation check.
Source: smart-base/L4/skills/smart-l4/l4-application-run-local.md.
The skill declares no I/O contract (schemas/skills/l4-application-run-local/{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 | who-ig | RepoPath | yes | A WHO SMART Immunizations IG checkout, relative to the working directory (the folder holding the checkouts, e.g. ~/space_cats). | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
| in | country-ig | RepoPath | A country adaptation IG checkout, e.g. smart-immunizations-uganda, relative to the working directory. Without it the app follows WHO’s own schedule. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. | |
| in | fhir-port | Port | The HAPI port on 127.0.0.1. Default 8081. | integer · TCP port for a locally bound server; 0 asks the OS for a free one. | |
| in | web-port | Port | The form’s port on 127.0.0.1. Default 8090. | integer · TCP port for a locally bound server; 0 asks the OS for a free one. | |
| in | down | Flag | Stop the form and the server. | boolean · A boolean switch — projects to a bare flag, with no value word | |
| out | url | Url | The form on 127.0.0.1. It stores nothing; each check is one inline $apply round. | string · format uri · An absolute http(s) URL |
Processes and tasks
No process step names a skill this Tool satisfies.
How it is deployed and reached
- Command line. From the repository root:
awho-mcp/scripts/local_up.sh --who-ig <dir> [--country-ig <dir>] [--fhir-port <n>] [--web-port <n>] [--down]. - 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 | cli: git clone https://github.com/litlfred/awho-mcp && cd awho-mcp && python3 -m pip install -e . |
| runtime | docker, python3, git |
| network | yes |
When a host it reaches is refused:
| host / error | remedy |
|---|---|
docker.io | none: The HAPI image comes from Docker Hub; with it refused, set HAPI_IMAGE to an image already pulled. |
github.com | none: awho-mcp is installed from GitHub; with it refused, install from a copy already on the machine. |
| when to choose it | |
|---|---|
| when | Trying or demonstrating the immunizations L4 app on a clean IG build, before anything is hosted, on the viewer’s own machine. |
| limits | Immunizations only (awho-mcp’s catalog is the WHO SMART Immunizations IG). One country per server, because a country IG reuses WHO’s PlanDefinition ids. Local only: nothing is published and the URL does not open from another machine. |
| cost | Docker and about 4 GB of memory. First run: the HAPI image pull, about a minute to load and warm, and a SUSHI build of any unbuilt IG. A re-run on the same commits restarts only the form. |
What it is made of
| role | file | |
|---|---|---|
| script | awho-mcp/scripts/local_up.sh | not in this checkout |
Linked data
The Tool is published as its own JSON-LD document at its IRI, http://smart.who.int/base/tools/immz-schedule-app-local.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": "http://smart.who.int/base/smart-base.context.jsonld",
"@id": "http://smart.who.int/base/tools/immz-schedule-app-local.jsonld",
"@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
"partOf": "http://smart.who.int/base/smart-base.jsonld",
"name": "immz-schedule-app-local",
"title": "Run the immunization schedule-check app locally on a WHO or country IG",
"description": "Start litlfred/awho-mcp's schedule-check web form on this machine: a HAPI FHIR server in Docker, the WHO SMART Immunizations IG loaded, then optionally a country adaptation IG (its decision-logic tables replace WHO's; its country profile is generated from its `input/l2/dependencies.yaml`), the CQL cache warmed, and the form served. Both listen on 127.0.0.1. Unbuilt IGs are built with SUSHI first, and each Library's CQL is embedded from `input/cql/` as the IG Publisher would. A re-run reuses a server loaded from the same commits; `--down` stops both.",
"install": {
"cli": "git clone https://github.com/litlfred/awho-mcp && cd awho-mcp && python3 -m pip install -e ."
},
"invoke": {
"shell": "awho-mcp/scripts/local_up.sh --who-ig <dir> [--country-ig <dir>] [--fhir-port <n>] [--web-port <n>] [--down]"
},
"io": {
"inputs": [
{
"name": "who-ig",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "A WHO SMART Immunizations IG checkout, relative to the working directory (the folder holding the checkouts, e.g. `~/space_cats`).",
"required": true,
"arg": {
"flag": "--who-ig"
}
},
{
"name": "country-ig",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "A country adaptation IG checkout, e.g. `smart-immunizations-uganda`, relative to the working directory. Without it the app follows WHO's own schedule.",
"required": false,
"arg": {
"flag": "--country-ig"
}
},
{
"name": "fhir-port",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Port",
"description": "The HAPI port on 127.0.0.1. Default 8081.",
"required": false,
"arg": {
"flag": "--fhir-port"
}
},
{
"name": "web-port",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Port",
"description": "The form's port on 127.0.0.1. Default 8090.",
"required": false,
"arg": {
"flag": "--web-port"
}
},
{
"name": "down",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
"description": "Stop the form and the server.",
"required": false,
"arg": {
"flag": "--down"
}
}
],
"outputs": [
{
"name": "url",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Url",
"description": "The form on 127.0.0.1. It stores nothing; each check is one inline `$apply` round.",
"render": {
"as": "url",
"reason": "a reader opens the running app; the scheme is checked before it reaches an href"
}
}
]
},
"satisfies": [
"l4-application-run-local"
],
"requirements": {
"runtime": [
"docker",
"python3",
"git"
],
"network": true
},
"remedies": [
{
"host": "docker.io",
"none": "The HAPI image comes from Docker Hub; with it refused, set `HAPI_IMAGE` to an image already pulled."
},
{
"host": "github.com",
"none": "awho-mcp is installed from GitHub; with it refused, install from a copy already on the machine."
}
],
"selection": {
"when": "Trying or demonstrating the immunizations L4 app on a clean IG build, before anything is hosted, on the viewer's own machine.",
"limits": "Immunizations only (awho-mcp's catalog is the WHO SMART Immunizations IG). One country per server, because a country IG reuses WHO's PlanDefinition ids. Local only: nothing is published and the URL does not open from another machine.",
"cost": "Docker and about 4 GB of memory. First run: the HAPI image pull, about a minute to load and warm, and a SUSHI build of any unbuilt IG. A re-run on the same commits restarts only the form."
}
}