Skip to main content
Glama
Industrial-AIops Energy

Industrial-AIops Energy

onboarding_status

Read-only

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

NameRequiredDescriptionDefault
dbNo
trackNoauto

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.13

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnlyHint/destructiveHint annotations, it discloses that results are derived from the local store plus config.yaml on every call with no persisted onboarding state, that hand-edited config or restored backups still yield a true answer, and that completed steps stay `done` even behind the cursor. 'Contacts nothing' is consistent with the read-only profile; the only soft tension is with openWorldHint=true, but the claim is clearly about not touching live equipment.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the sibling differentiation are front-loaded, and the parameter details are correctly placed at the end. It runs long for a two-parameter status tool, with the two indented journey enumerations and some editorial asides ('handing someone five commands is the same as handing them none') that could be trimmed without losing callable information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description must convey the return shape — and it does, covering `track`, `next_command` per step, `choices` when the site type is undeterminable, B1/B2 auditing status, and per-step `done` state. Nothing an agent needs in order to call it or interpret the result is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description carries the full burden and does: `track` is defined as auto (derived from config.yaml), `devices`, or `uns`, with the B1/B2 fork semantics spelled out, and `db` is documented down to accepted extensions (.db/.sqlite), search roots ($IAIOPS_HOME, config dir, IAIOPS_AGENT_READ_DIRS) and the empty-string default. Both parameters gain meaning not present in the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening line states a precise purpose ('where this site is on the path from a network to an answer') and immediately positions it against the closest sibling: 'One altitude below `site_readiness`.' It then names the exact question it answers — which journey the site is on and which single command comes next — so an agent can distinguish it from every other readiness/status tool without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It names the alternative (`site_readiness`) and the condition that selects it (that one lists every scenario; this one answers the smaller, earlier question first). It also gives explicit caller-facing rules: relay both `choices` and pick neither when ambiguous, and show only the command under `next_command` rather than presenting a to-do list.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools