Skip to main content
Glama
Sign In
TIA Portal MCP Server

TIA Portal MCP Server

by BJM1122
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Read exported HMI alarms

tia_read_hmi_alarm_export
Read-onlyIdempotent

Extract classic HMI alarms and multilingual trigger/acknowledgement data from WinCC alarm XLSX exports for offline review, preserving worksheet and row evidence.

Instructions

Read an existing official WinCC alarm XLSX export, including classic HMI alarms unavailable through Openness. Preserves multilingual text, trigger and acknowledgement columns with worksheet/row evidence. Does not launch Excel, evaluate formulas, attach to TIA or import anything. Workbook project identity is not independently verifiable.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "file": "<file>"
    },
    "name": "tia_read_hmi_alarm_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileYes
limitNo
queryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.29.1

TDQS

A4.2/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), and the description still adds real behavior: no Excel process is launched, formulas are not evaluated (implying cached values are returned), no TIA attachment, no import, and workbook project identity is explicitly not verifiable. The last point is an unusually candid limitation an agent could not infer from any structured field.

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

Conciseness5/5

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

Three tight sentences, front-loaded with the action and its distinguishing scope, then evidence/return hints, then exclusions. No restatement of the title and no filler; each sentence adds a fact the agent cannot get elsewhere.

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 return side is well covered (multilingual text, trigger and acknowledgement columns, worksheet/row evidence) despite no output schema, and limitations are disclosed. However, with zero schema coverage the undefined 'query' and 'limit' semantics leave a real gap for a tool whose main use is filtered reads of a large workbook.

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?

Schema description coverage is 0% across three parameters, so the description must carry the burden and it does not: 'file' is only loosely implied by 'read an existing export', and neither 'query' (what it matches on) nor 'limit' (default 20, max 100, pagination behavior) is addressed. The return-shape hints about columns and row evidence do not substitute for parameter meaning.

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?

States a specific verb and resource (read an existing official WinCC alarm XLSX export) and scopes it further by naming the content only this path reaches: classic HMI alarms unavailable through Openness. That clause alone separates it from tia_analyze_hmi_alarms and the tia_export_* siblings without opening any schema.

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?

The 'classic HMI alarms unavailable through Openness' clause gives a concrete condition for choosing this tool, and the negative list rules out Excel/TIA/import workflows. It stops short of naming a sibling to use instead for modern alarms or for aggregating/analyzing an export, so routing is clear but not fully closed.

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