onboarding_status
Identifies which onboarding journey a site is on — device scan or UNS connection — and returns the single next command to run, derived live from config and local store.
Instructions
[READ][risk=low] Where this site is on the path from a network to an answer.
One altitude below `site_readiness`. That one lists every scenario and what
each is waiting for; this one answers the smaller, earlier question a caller
actually has first — **which journey this site is on, and which single command
comes next** on it. There are two, with different first steps:
devices — no UNS yet: scan → endpoints → point list → what each point
MEANS → collect → ask the question
uns — data already in an MQTT/UNS broker: connect → audit the
namespace → choose points → MEANS → collect → ask
`track` is `auto` (derived from config.yaml), `devices` or `uns`. On `uns` a
stored namespace audit forks it into B1 (audited clean) and B2 (governance is
the work); until an audit is stored the result says B1/B2 is unknown rather
than assuming either. When nothing is configured, or both kinds of endpoint
are, the single step is a question with two `choices` — relay both to the
caller and pick neither; the files on disk cannot say which kind of site this
is, and neither can you.
Derived from the local store and `config.yaml` every time; there is no
onboarding state file, so a site that edits config.yaml by hand or restores a
backup still gets a true answer rather than a remembered one.
Every step carries its own `command`, including the ones still waiting. Show
the caller the one under `next_command`; the rest are context, not a to-do
list, and handing someone five commands is the same as handing them none.
A step that is genuinely done stays `done` even when it sits behind the
cursor — a site that hand-wrote config.yaml before ever scanning has real
endpoints, and reporting otherwise to keep the sequence tidy would be a lie
in the direction that makes this tool look more necessary.
Contacts nothing. `db` overrides the local store path (.db/.sqlite, under
$IAIOPS_HOME, the config dir or an IAIOPS_AGENT_READ_DIRS dir); empty means the
iaiops store.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "onboarding_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| db | No | ||
| track | No | auto |