Skip to main content
Glama
Sign In
TIA Portal MCP Server

TIA Portal MCP Server

by BJM1122
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Export HMI configuration for analysis

tia_export_hmi_configuration
Idempotent

Export a canonical JSON observation of an HMI's alarms, tags, connections, screens, and scripts from a TIA Portal project; use refresh only after project changes.

Instructions

Reuse one canonical JSON observation per exact project and HMI, or read alarms, tags, connections, screens and scripts through public Openness APIs. Set refresh only after a project change. Does not execute scripts, modify the project, export PLC blocks, or produce an importable WinCC backup. Partial reads never replace a usable observation.

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": {
      "projectPath": "<projectPath>",
      "hmiName": "<hmiName>",
      "hmiPath": "<hmiPath>"
    },
    "name": "tia_export_hmi_configuration"
  }
}

Input Schema

NameRequiredDescriptionDefault
hmiNameYes
hmiPathYes
refreshNo
processIdNo
timeoutMsNo
maxObjectsNo
projectPathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.29.1

TDQS

B3.2/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), it discloses that results are cached per exact project+HMI, that refresh is the cache-buster, and that partial reads never replace a usable observation — meaningful non-obvious behavior. It still omits where the observation is written, what a caller gets back, and how the timeouts/limits affect partial results.

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

Conciseness3/5

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

Four short sentences with no filler, but the lead sentence is the caching mechanism rather than the action, so the reader must reach sentence two to learn the tool reads HMI artifacts. Front-loading the read operation would improve selection speed.

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

Completeness2/5

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

A tool with 7 undocumented parameters, no output schema, and write-side caching semantics needs more than this: absent are the meaning of processId, timeout/connection-failure behavior, and what maxObjects truncation means for the returned observation. The exclusions are useful, but they do not substitute for operating detail.

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 7 parameters, so the description carries the full burden, yet it explains only refresh semantics and the project/HMI matching idea. processId, timeoutMs and maxObjects — the parameters most likely to cause failures — are entirely unaddressed.

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

Purpose4/5

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

The description names the concrete artifact set being read (alarms, tags, connections, screens and scripts) and explicitly excludes PLC blocks and importable WinCC backups, which separates it from bundle/native export siblings. The opening clause about reusing a "canonical JSON observation" is jargon-heavy and slightly obscures the verb, but the operation is still recoverable.

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

Usage Guidelines3/5

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

"Set refresh only after a project change" is a genuine usage constraint, and caching-by-default is implied. However, there is no guidance on when to pick this over tia_export_hmi_bundle, tia_export_hmi_native or tia_read_hmi_alarm_export, and no stated prerequisites beyond matching project/HMI.

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