DRAFT for 10.1.5.1. This page is a child-preview of the live AI Runtime Connector page. The live page will be updated after Marco's review. Reviewers are invited to check tool names, descriptions, groupings, and parameter defaults against the locked 10.1.5.1 design. |
AI Runtime Connector (10.1.5.1 draft) — refreshed tool catalog, renamed gate-bit categories, and the Operator Subset for TServer-embedded chat.
Home → Connectors Library → Browse By Connector Group → IT-Cloud and AI Connectors → AI Runtime Connector → AI Runtime Connector (10.1.5.1 draft)
Release 10.1.5.1 rebuilds the RuntimeMCP tool surface for LLM-efficacy (atomic-interaction, bounded payloads) and to reflect the broader scope of the AI Runtime connector — it reads every runtime-object root, not just Tag/*. The short summary:
runtime_get_info and runtime_set_target collapse into a single runtime_connect(solution?, profile?).runtime_browse_uns → runtime_browse_object_model (the tool walks all 12 runtime roots, not just the P1-strict UNS).runtime_get_object_context → runtime_describe_object — and it absorbs the former runtime_find_by_iri via a new iri parameter.runtime_list_by_type → runtime_list_instances, now bounded with max_results + name_mask wildcard filter.max_* caps with a truncated flag on the response.runtime_list_derived_types dropped — redundant with runtime_describe_object's derivedTypes context block.The MCP for Runtime GroupBox in Solution Settings → Data Servers now shows four category toggles plus the master toggle. Bit positions in ModelOptions are unchanged — existing 10.1.4 solutions decode identically; only the labels and C# accessor names change.
Checkbox label | Category | Covers | Bit |
|---|---|---|---|
Enable MCP for Runtime | Master | Gates every RuntimeMCP tool. | 0x0002 |
Enable UNS Tools | UNS |
| 0x04 |
Enable Alarm Tools | Alarm | Dedicated alarm-query tools only: | 0x08 |
Enable Historian Tools | Historian |
| 0x10 |
Enable Custom Tools | Custom | Solution-authored | 0x20 |
Category semantics. Categories are defined by the TOOL being invoked, not by the runtime-object namespace the path happens to address:
Alarm.* namespace (e.g., runtime_get_value("Alarm.TotalCount")) stays under Enable UNS Tools. Any runtime-object value read is UNS-category regardless of path.runtime_describe_object (reports whether a specific tag is currently in alarm state) is describing the tag — UNS data — and gates on Enable UNS Tools, not Enable Alarm Tools.runtime_get_active_alarms and runtime_query_alarm_history.AI Runtime provides 9 built-in platform tools + solution-authored custom tools, organized by function.
Tool | Description |
|---|---|
runtime_connect | Connect to a FrameworX runtime and receive the Context Package (solution identity, profile, namespaces, quality codes, tool workflows, objType schemas, custom tools). CALL THIS FIRST at the start of every session. No-args mode: returns the current Context Package for whichever runtime this MCP is already bound to. With-args mode (HTTP retargetable only): rebinds this RuntimeMCPHttp instance to a different (solution, profile) BEFORE returning the Context Package. STDIO mode and HTTP-pinned mode: args are accepted but silently ignored; the response includes a |
Tool | Description |
|---|---|
runtime_get_value | Get the current LIVE value of a tag or object from the running solution's Unified Namespace (UNS). Returns: value, quality (0=Bad, 64=Uncertain, 192=Good), timestamp, and metadata (description, units, min/max) when available. Reads live operational data — not solution configuration from Designer. Use for: process values ( |
runtime_browse_object_model | Browse the live runtime object-model tree — returns child nodes at the specified path. Works across all runtime roots: |
runtime_search_uns | Ranked semantic search across the live runtime UNS — UserTypes, Tags, members, Enumerations, and AssetTree folders. Scores across Name, DisplayText, Labels, SourceIri, and (auto-thresholded) Attributes annotation content. Returns ranked matches with |
runtime_describe_object | Describe a single runtime UNS object — inheritance chain, derived UDTs, and (for Tag paths) live current value, quality, timestamp, and alarm state. Pass EITHER |
runtime_list_instances | List all live tags of a given UDT (UserType), with current value/quality/timestamp for each. Returns one row per matching tag, ordered alphabetically by tag name. Optional |
Tool | Description |
|---|---|
runtime_get_active_alarms | Get currently ACTIVE alarms from the running solution. Returns alarms that are in alarm state right now (not yet normalized), including tag name, message, priority, active time, area, and group. This is LIVE alarm status, not alarm configuration or history. For PAST alarms that have already normalized, use |
runtime_query_alarm_history | Query HISTORICAL alarm records from the Alarm Historian database. Only SELECT statements are allowed; INSERT, UPDATE, DELETE, DROP, and other modifying statements are blocked. Available columns: TagName, Message, ActiveTime, AckTime, NormTime, UserName, Priority, Area, GroupName. Server-side row cap applies even if the SQL omits TOP — |
Tool | Description |
|---|---|
runtime_get_tag_history | Query HISTORICAL time-series data for a tag from the Historian database. The tag must be configured for Historian storage in the solution to have historical data available. This retrieves STORED historical data, not the current live value — use |
Solution authors expose additional tools by creating Scripts → Classes of type MCP Tool. Methods decorated with [McpServerTool] + [Description(...)] attributes become tools on the RuntimeMCP surface for that solution. Recommended naming: runtime_<toolName> in snake_case. See the authoring guidance on the live AI Runtime Connector page for code examples and scripts-module patterns.
Restart the AI client (close from Task Manager, not just the window) after adding or modifying custom methods.
In 10.1.5.1 the RuntimeMCP surface has two callers:
RuntimeMCP.exe (STDIO) or RuntimeMCPHttp.exe (HTTP). Gets the full 9-tool platform surface plus the solution's custom tools. This is what the Available Tools section above describes.TServer.exe. Offline-by-design: zero outbound network traffic; the chat runs entirely on the factory-network. Operators don't explore the namespace — the HMI tells them tag and equipment names — so the operator LLM gets a reduced tool set optimized for atomic interaction and small-model reliability.Chain B exposes 4 platform tools + solution custom tools:
runtime_connect (bootstrap — always)runtime_get_valueruntime_get_active_alarmsruntime_get_tag_historyThe Operator Subset is declared through a marker attribute read by the Chain B dispatcher — Chain A ignores the marker and serves the full surface. Operator-chat authoring and dispatcher details live in the Chat in Displays documentation (separate release track).
Customers upgrading from 10.1.5 or earlier should update any AI prompts, solution-authored wrappers, or integration scripts that reference the old names:
Old name (10.1.5 and earlier) | 10.1.5.1 replacement | Notes |
|---|---|---|
|
| Same payload on no-args; optional |
|
| Merged as the with-args branch. |
|
| Same parameters plus a bounding |
|
| Absorbs external-IRI lookup via a new |
|
| Merged into describe_object — same single-object intent, different lookup key. IRI ambiguity returns |
|
| Renamed. Adds |
| — (removed) | Redundant: |
|
| (Renamed earlier in 10.1.5; retained here for completeness.) |
Version | Date | Changes |
|---|---|---|
1.2 (draft) | 2026-04-24 | Refreshed for 10.1.5.1. Tool catalog went to 9 platform tools + custom (was 7). Session bootstrap unified as |
1.1 | 2026-02 | 7 built-in tools; updated architecture diagram; added |