Skip to main content
Glama
Industrial-AIops Energy

Industrial-AIops Energy

site_readiness

Read-only

Checks which scenarios a site can run today, reports ready, degraded, or blocked status, and lists missing inputs that unlock blocked scenarios without contacting devices or networks.

Instructions

[READ][risk=low] Which scenarios THIS site can run today, and what each gap needs.

The companion to `protocols_supported`, one altitude down. That one says what
the product can do; this says what this installation can do — and calling the
first without the second is how an agent plans a scenario the site has no
inputs for.

Contacts nothing: no device, no network, no historian. It is derived from
`config.yaml` and the local store, which is what makes it runnable against a
site nobody has authorised you to probe — the site that most needs it.

Three states, and the middle one carries the value: `ready`, `degraded` (it
RUNS, on less than full evidence — root cause without a historian still ranks
causes, it just cannot see the two hours before the stoppage) and `blocked`.

`blocked_on` is the actionable half: one missing input usually unlocks several
scenarios, ranked by how many.

It never fills a gap in for you. Which tag is the production counter is
process knowledge, and a wrong guess yields plausible-looking OEE numbers —
considerably worse than an error (D16). Where a prerequisite cannot be
supplied at all yet, the row says `not_yet_expressible` rather than implying
somebody forgot to configure it.

`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": "site_readiness"
  }
}

Input Schema

NameRequiredDescriptionDefault
dbNo

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?

Goes well beyond the readOnly/openWorld annotations: it says the tool contacts nothing (no device, network, historian), is derived from config.yaml and the local store, and explains the three-state outcome with the semantics of `degraded` and `blocked_on`. It also discloses a design constraint (never fills gaps, uses `not_yet_expressible`) that no annotation conveys.

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 is front-loaded in the first line and the paragraphs are logically ordered (contrast, safety, states, blocked_on, policy, param). It is longer than strictly necessary — phrases like 'the site that most needs it' and the D16 aside are colour rather than instruction — but nothing is misleading or wasted enough to hurt.

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?

With no output schema, the description still describes the return shape (per-scenario state rows, `blocked_on` rankings, `not_yet_expressible`) and covers the one parameter and safety posture. An agent has everything needed to decide, call, and interpret it.

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 burden and does: `db` overrides the local store path, accepts .db/.sqlite, resolves under $IAIOPS_HOME, config dir, or an IAIOPS_AGENT_READ_DIRS dir, and empty means the iaiops store. The single parameter is fully documented.

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?

Opens with a specific scope: 'Which scenarios THIS site can run today, and what each gap needs.' It explicitly positions itself against the sibling `protocols_supported` ('one altitude down') so an agent can distinguish product capability from installation capability without reading either 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?

Gives an explicit pairing rule — call this with `protocols_supported`, and warns that 'calling the first without the second is how an agent plans a scenario the site has no inputs for.' Also states the safe-to-call context (no authorisation needed), which is exactly the usage condition an agent needs.

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