Skip to main content
Glama
Industrial-AIops Energy

Industrial-AIops Energy

investigation_readiness

Read-only

Assess how far an investigation can proceed at a site by checking which of eight evidence steps are possible and what each gap needs, using config and local data without contacting devices.

Instructions

[READ][risk=low] How far into an investigation this site could get, and what each gap needs.

`readiness` answers "which scenarios can this site run"; this answers the
next question down — if something stopped tomorrow, how many of the eight
evidence steps could actually be walked, and for each one that could not,
what is missing.

Contacts nothing: no device, no network, no historian. It is derived from
the config and the local store, which is what makes it usable on a site
nobody has been authorised to probe yet.

Each gap says whether it is *unmet* (you have not supplied it — the fix names
the command) or *not yet expressible* (this product offers no way to supply
it at all). Those two send a person to very different places.

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": "investigation_readiness"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteNodefault

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.13

TDQS

A4.1/5.0
Behavior5/5

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

Beyond the readOnlyHint and destructiveHint annotations, the description discloses that the tool contacts no device, network, or historian and is derived from config and local store, explaining why it is safe on unauthorized sites. It also explains the two possible gap outcomes, unmet vs not yet expressible, giving the agent a clear picture of result semantics. There is no contradiction with annotations.

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?

The description is front-loaded with a READ/risk tag and a one-line summary, then uses short paragraphs to cover scope, safety, and gap semantics. Each paragraph earns its place, though the first two sentences are slightly repetitive in expressing the 'how far can this site go' idea.

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

Completeness3/5

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

The description covers core behavior, safety, and output distinction between unmet and not-yet-expressible gaps well. However, with only one input parameter, omitting parameter guidance entirely is a meaningful gap, and there is no output schema to fill that in. The eight evidence steps are also left unnamed, though that may be acceptable product-domain knowledge.

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

Parameters2/5

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

The input schema contains one `site` parameter with a default, but the description never mentions it or explains how to populate it. With 0% schema description coverage, the description needed to compensate and did not. The parameter name and default are somewhat self-evident, but the description adds no meaning about valid values, site identity, or how the default affects the analysis.

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 description clearly states that investigation_readiness evaluates how far into an evidence-gathering investigation a site can currently get, and identifies what each missing gap needs. It explicitly contrasts itself with `readiness` (site_readiness), saying readiness answers which scenarios a site can run while this tool answers the next question down. This makes the tool's purpose specific and distinguishable from its sibling.

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

Usage Guidelines4/5

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

It gives a clear when-to-use condition: 'usable on a site nobody has been authorised to probe yet' because the tool contacts nothing and derives data from config and local store. It also distinguishes from the site_readiness sibling by describing the relationship between the two tools. However, it does not explicitly name alternatives for cases where live device, network, or historian probing is desired, so exclusion guidance is mostly implicit.

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