Skip to main content
Glama
Industrial-AIops Energy

Industrial-AIops Energy

plc_program_history

Read-only

List tracked PLC programs or retrieve one program's snapshot history from a local baseline store to review change-control evidence without parsing files or touching devices.

Instructions

[READ][risk=low] Tracked programs, or one program's snapshot history.

Local read of the program-baseline store — no file is parsed and no device is
touched. Nothing is ever pruned automatically: a change-control history that
quietly drops last quarter's baseline is worse than one that grows, and a
stored row is block names, hashes and counts rather than source. Removing history is a
deliberate act and is CLI-only (`iaiops program forget`) — deleting
change-control evidence should not be one tool call away.

Args:
    name: Tracked program name. Omit for the list of every tracked program.

Returns dict (listing): {store, program_count, programs:[{program,
    snapshot_count, latest, latest_taken_at}]}; (one program): {store,
    program, snapshot_count, snapshots:[{snapshot_id, taken_at, source_file,
    content_sha256, label, note}]}.

Example: plc_program_history(name="Line3").

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

Input Schema

NameRequiredDescriptionDefault
nameNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.13

TDQS

A4.7/5.0
Behavior5/5

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

Beyond annotations, the description adds important behavioral details: no automatic pruning, removal is deliberately CLI-only, stored data contains block names/hashes/counts rather than source, and no file or device is touched. This substantially exceeds what the annotations already convey.

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 the read-only tag and core purpose, then uses clear sections for Args, Returns, and Example. The prose about pruning is somewhat elaborate, but it earns its place by explaining why history is never automatically dropped and why deletion is restricted.

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 present, the description fully documents both possible return shapes: the listing form and the single-program snapshot form. The optional parameter behavior and an example are also present, making the tool straightforward to invoke correctly.

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%, but the description fully compensates for the single parameter: it explains what `name` selects and the effect of omitting it. The example reinforces the expected invocation syntax.

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 identifies a specific verb ('read') and resource ('program-baseline store'), and the first sentence distinguishes between two behaviors: listing tracked programs versus viewing one program's snapshot history. It also differentiates from device-reading siblings by stating 'no file is parsed and no device is touched.'

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?

Clear context is provided: this tool reads local program-baseline history, and the optional `name` behavior is explained. It does not explicitly name sibling tools to use instead, but the framing and scoping make the use case sufficiently clear.

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