Page History

Enable AI-powered solution configuration through Model Context Protocol integration.

Documentation pages: AI Integration  | MCP for Designer In Action | AI MCP for Designer Connector

Integration Architecture

Key Capabilities

• Navigate Designer UI — AI can observe and navigate the Designer interface
• Create Objects — Generate Tags, Displays, Alarms, Devices, and other solution objects
• Query Objects — Search and inspect existing solution configuration
• Validate Configuration — Pre-check configurations before creating objects
• Generate Displays — Create Canvas and Dashboard displays with proper FrameworX patterns
• Discover Protocols — Search available communication protocols and their configuration schemas
• Track Changes — Query audit trails, cross-references, and version control
• Access Documentation — Search docs and download example solutions

When to Use MCP for Designer

Visual Indicator

When AI is connected to Designer, you'll see:

• "AI MCP" badge — Orange label in the toolbar area
• Orange border — Glowing border around the main working area

This provides clear visual feedback that AI is actively controlling the Designer.

Prerequisites

• FrameworX 10.1 Designer
• .NET 8.0 runtime
• Claude Desktop or compatible MCP client
• Network connectivity (if Designer runs on remote machine)

Configuration

Enable/Disable MCP for Designer

The MCP for Designer is Enabled by default. If you want to To disable it:

1. Open FrameworX Designer
2. Navigate to Solutions → Settings
3. Uncheck Allow MCP For Designer

This configuration has the scope of that solution onlysetting is per-solution.

Connecting Claude Desktop

Claude Desktop

1. Open Claude Desktop
2. Go to Settings → Developer → Edit Config
3. Open the "claude_desktop_config.json" file
4. Add the MCP for Designer configuration:

{
  "mcpServers": {
    "FrameworX-Designer": {
      "command": "<ProductPath>\\MCP\\DesignerMCP.exe",
      "transport": "stdio"
    }
  }
}

1. Replace <ProductPath> with your FrameworX installation directory (use double backslashes)
2. Save and close the file
3. Restart Claude Desktop completely (close via Windows Task Manager)

Tip: You can run both MCP for Designer and MCP for Runtime simultaneously by including both configurations in your claude_desktop_config.json file.

Verifying Connection

1. Open Claude Desktop
2. Go to Settings → Developer
3. Verify "FrameworX-Designer" shows status "running"
4. Open a new chat and click Search and Tools — you should see the Designer tools should be listed
5. In Designer, verify the orange "AI MCP" badge appears

Available Tools

AI MCP for Designer provides 17 tools organized by category:

Solution Management (3 tools)

Object Operations (7 tools)

Runtime Values: When runtime is connected, object tools include live values. Use designer_action('get_runtime_diagnostics') to check connection status.

Designer Control (1 tool)

Available actions:

• navigate — Go to module, table, or object path
• get_state — Get current Designer view and selection (optional screenshot)
• get_runtime_status — Check if runtime is running
• get_startup_config — Get startup module settings
• start_runtime / stop_runtime — Control runtime execution
• set_execution_profile — Switch between Development and Production

Display Tools (1 tool)

Special queries:

• get_element_schema('Canvas') — Canvas display structure with layout info
• get_element_schema('Dashboard') — Dashboard grid and cell structure
• get_element_schema('WizardSymbol') — Industrial symbols: BLOWER, MOTOR, PUMP, TANK, VALVE

Protocol Tools (2 tools)

Search examples:

• list_protocols(search='siemens') → S7, S7Plus
• list_protocols(search='allen') → EtherNet/IP, DF1, ControlLogix
• list_protocols(search='modbus') → Modbus TCP, Modbus RTU
• list_protocols(search='opc') → OPC UA, OPC DA

Documentation Tools (2 tools)

Documentation labels: concept, tutorial, how-to, example, reference, connector, code, control

Track Changes (1 tool)

Available tables:

• RecentChanges — Audit trail of who changed what and when
• VersionControl — Table versions and modification dates
• CrossReference — Where an object is used (requires object_name)
• UseCount — Usage frequency per object

Table Types

Quick Reference

Syntax

Tag Access Methods

Context-Specific Syntax

Quick Reference

System Namespaces

Module Namespaces

Every configured object has runtime properties accessible via namespace:

• Alarm.Group.Critical.AckRequired, Alarm.Item.HighTemp.Active
• Device.Channel.Modbus1.Status, Device.Node.PLC1.Error
• Script.Task.Startup.LastRun, Display.MainPage.IsOpen

Use list_objects('Server') or list_objects('Alarm.Group') to explore.

Tag Path Syntax

• Folders: Tag.Folder1/Folder2/TagName
• UDT members: Tag.Controller1.SP
• Arrays: Tag.ArrayTag[5]

MCP Category and Update Protection

Objects created by AI automatically receive Category = "MCP" to track AI-created vs manually-created objects.

Update Permissions

How

it works:

1. AI creates object → Category automatically set to "MCP"
2. User edits object in Designer → "MCP" removed from Category
3. AI tries to update updates → Limited to Description field only
4. To re-enable full AI updates → Manually add "MCP" to Category

Display JSON Formats

Canvas Display

Canvas displays use absolute pixel positioning with an Elements array:

{
  "Name": "TankOverview",
  "PanelType": "Canvas",
  "Size": "1366 x 728",
  "Elements": [
    {
      "Type": "TextBox",
      "Left": 100,
      "Top": 50,
      "Width": 120,
      "Height": 28,
      "LinkedValue": "@Tag.Tank1.Level.Value"
    },
    {
      "Type": "Symbol",
      "WizardType": "TANK",
      "Left": 100,
      "Top": 100,
      "Width": 65,
      "Height": 65
    }
  ]
}

Dashboard Display

Dashboard displays use grid-based positioning with Cells array:

{
  "Name": "MotorDashboard",
  "PanelType": "Dashboard",
  "Size": "1366 x 728",
  "DashboardDisplay": {
    "Columns": ["*", "*"],
    "Rows": ["*", "*"]
  },
  "Cells": [
    {
      "Row": 0,
      "Col": 0,
      "Cell": { "HeaderLink": "Motor 1" },
      "Content": {
        "Type": "TextBox",
        "LinkedValue": "@Tag.Motor1.Speed.Value"
      }
    }
  ]
}

Wizard Symbols

Pre-built industrial symbols with default appearance:

Common Workflows

Creating Tags

"Create a Double tag called TankLevel in the Tanks folder with range 0-100"

Device Communication

"I need to connect Connect to a Siemens S7-1500 PLC at IP 192.168.1.10"

AI will: Search protocols → Present options → Create Channel → Create Node → Help map Points

Creating Displays

"Create a dashboard with 4 cells showing TankLevel, TankTemp, PumpStatus, and AlarmCount"

Configuring Alarms

"Create high and low alarms for TankLevel: High at 90 (Critical), Low at 10 (Warning)"

Finding

Object Usage

"Where is tag Tank1Level used in the solution?"

AI will useuses: get_track_changes('CrossReference', object_name='Tag.Tank1Level')

Best Practices

Be Specific

Instead of "Create some tags", say:

"Create these tags in the Production folder: MixerSpeed (Double, 0-1000 RPM), MixerRunning (Digital), BatchCount (Integer)"

Validate Before Bulk Operations

"Validate this configuration before creating 50 tags"

Review Changes

"Show me the recent changes" or "Navigate to the Tags tab"

Use Documentation

"Search the documentation for alarm configuration options"

Troubleshooting

Designer MCP Server not starting

• Verify .NET 8.0 runtime is installed
• Check that Designer is running
• Confirm MCP is enabled in Designer settings
• Check firewall settings for the configured port

Claude doesn't see Designer tools

• Ensure claude_desktop_config.json path is correct (use double backslashes)
• Restart Claude completely (close via Task Manager)
• Verify Designer MCP shows "running" in Claude settings

"Update blocked" message

• The object Object doesn't have MCP in its Category
• User edited the object in Designer, removing MCP
• AI can only update the Description field
• To enable full updates: add "MCP" to Category in Designer

Changes not appearing in Designer

• Refresh the Designer view (F5)
• For displays, close and reopen the display editor
• Verify the operation completed successfully in Claude's response

No visual indicator (orange border)

• Verify MCP connection is active in Claude Desktop
• Check Designer settings for MCP enabled
• Restart Designer if needed

Related Documentation

• Overview and examples
• Query live data
• Deep technical details
• Technical architecture
• AI MCP for Runtime Connector — Query live tags, alarms, and historian
• AI-Ready by Design — Technical architecture for AI integration
• Devices Module Reference — Channel, Node, Point configuration
• Displays Module Reference — Canvas and Dashboard formats

In this section...