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

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

AI MCP for Designer Connector

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

Integration Architecture

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.

Key Capabilities

• Navigate Designer UI — AI can observe and interact with the Designer interface
• Create Objects — Generate Tags, Displays, Alarms, 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
• Export/Import Displays — Work with displays in AI-friendly JSON format
• Take Screenshots — Capture Designer state for context
• Discover Protocols — List available communication protocols and their configuration schemas
• Explore Data Sources — Browse MQTT, OPC UA, PLC, and SQL data sources interactively

When to Use MCP for 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

MCP for Designer is Enabled by default. To disable:

1. Open FrameworX Designer
2. Navigate to

1. Solutions → Settings

1. Uncheck Allow MCP

1. For Designer

This setting is per-solution.

Connecting Claude Desktop

Configure Claude Desktop to connect to the Designer MCP server:

1. Open Claude Desktop
2. Go to Settings → Developer → Edit Config
3. Open

1. "claude_desktop_config.json"

2. Add the

1. configuration:

{
  "mcpServers": {
    "FrameworX-Designer": {
      "command": "<ProductPath>\\fx-10MCP\\net8.0\\TMCPServerDesigner\\TMCPServerDesigner.exe",
      "args": ["/port:3102"]DesignerMCP.exe",
      "transport": "stdio"
    }
  }
}

1. Replace <ProductPath> with your FrameworX installation directory (use double backslashes)
2. Save and close

2. Restart Claude Desktop completely (close via

1. 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 —

1. Designer tools should be listed
2. In Designer, verify the orange "AI MCP" badge appears

Available Tools

AI MCP for Designer provides these tools organized by category:

Session Management

Solution Management (3 tools)

Schema Discovery

Object Operations (7 tools)

Tool	Purpose
list_objects

Browse objects with summary information

List objects in a table or browse runtime namespaces

get_objects_config

Retrieve

Get full

configuration details

JSON configuration for specific objects
get_table_schema	Get field definitions and valid values for any table
create_objects	Create new objects from

AI-generated configuration

JSON configuration
validate_json	Validate configuration before creating objects
update_

objects

object

Modify existing objects (respects MCP Category)

validate_jsonValidate configuration before creating

Display Operations

delete_objects

Remove objects from solution

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
• 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
• get_element_schema('Dashboard') — Dashboard grid and cell structure
• get_element_schema('WizardSymbol') — Industrial symbols: BLOWER, MOTOR, PUMP, TANK, VALVE

Protocol Tools (2 tools)

Protocol Groups

Protocols are organized into these groups:

Data Explorer

Supported Data Sources

Information & Navigation

Display JSON Formats

AI MCP for Designer uses simplified JSON formats for creating and modifying displays.

Canvas Display Format

Canvas displays use absolute pixel positioning:

{
  "Type": "DisplaysList",
  "Name": "TankOverview",
  "Width": 1366,
  "Height": 768,
  "DisplayMode": "Page",
  "Children": [
    {
      "Type": "Symbol",
      "SymbolName": "HMI/Tanks/TankWithLevel",
      "Left": 100,
      "Top": 50,
      "Width": 200,
      "Height": 300,
      "SymbolLabels": [
        { "Key": "Level", "Value": "@Tag.Tank1.Level" },
        { "Key": "Title", "Value": "Tank 1" }
      ]
    },
    {
      "Type": "TrendChart",
      "Left": 350,
      "Top": 50,
      "Width": 400,
      "Height": 300,
      "LinkedValue": "@Tag.Tank1.Level"
    }
  ]
}

Dashboard Display Format

Dashboard displays use grid-based positioning with resizable cells:

{
  "Type": "DisplaysList",
  "Name": "MotorDashboard",
  "Width": 1366,
  "Height": 768,
  "DisplayMode": "Page",
  "DashboardDisplay": {
    "Columns": ["*", "*", "*"],
    "Rows": ["*", "*"]
  },
  "Cells": [
    {
      "Row": 0, "Col": 0,
      "Cell": { "HeaderLink": "Motor 1" },
      "Content": {
        "Type": "Symbol",
        "SymbolName": "HMI/Motors/MotorStatus",
        "SymbolLabels": [
          { "Key": "Value", "Value": "@Tag.Motor1.Status" }
        ]
      }
    },
    {
      "Row": 1, "Col": 0, "ColSpan": 3,
      "Cell": { "HeaderLink": "Trend" },
      "Content": {
        "Type": "TrendChart",
        "LinkedValue": "@Tag.Motor1.Speed"
      }
    }
  ]
}

Key Format Features

For complete format specifications, see:

• Canvas and Symbol JSON Reference
• Dashboard JSON Reference

Example Queries

Creating Objects

• "Create a new analog tag called Tank1_Level with engineering units in gallons, range 0-1000"
• "Create 10 temperature sensor tags named Sensor_T01 through Sensor_T10"
• "Add a high alarm at 85 and high-high alarm at 95 to all temperature tags"
• "Create a Modbus TCP channel for PLC at 192.168.1.10"

Querying Configuration

• "List all tags in the Boiler area"
• "Show me the alarm configuration for Tank1_Level"
• "What displays reference the tag Pump1_Status?"
• "Show me the schema for creating historian tags"

Creating Canvas Displays

• "Create a canvas display showing Tank1 with a level gauge and numeric readout"
• "Add a status indicator that turns red when Tank1_Level exceeds 900"
• "Create a P&ID style display with three tanks connected by pipes"

Creating Dashboard Displays

• "Create a 2×3 dashboard for monitoring six motors"
• "Make a dashboard with a navigation panel on the left (200px) and content area on the right"
• "Create a dashboard with AlarmViewer spanning the bottom row"

Modifying Displays

• "Export the MotorOverview display so I can see its structure"
• "Add a CircularGauge to the Motor 1 cell showing speed"
• "Change the TrendChart to show the last 48 hours instead of 24"

Protocol Schema Discovery

• "What communication protocols are available?"
• "List all protocols in the AutomationVendors group"
• "Show me the schema for the Modbus protocol"
• "What are the key fields needed for an OPC UA connection?"
• "What interfaces does the S7 protocol support?"

Data Explorer & Device Configuration

• "Connect to the MQTT broker at tcp://192.168.1.100:1883"
• "Open the Data Explorer for OPC UA server at opc.tcp://192.168.1.100:4840"
• "What node is currently selected in the Data Explorer?"
• "Create a TagProvider from the current Data Explorer selection called Plant1_Sensors"
• "Create a Device configuration from the selected MQTT topic"
• "Browse the PLC at 192.168.1.50 and show available tags"

Learning & Discovery

• "What object types are available in FrameworX?"
• "Show me the required fields for creating an alarm item"
• "What symbols are available for motor status?"
• "List the parameters for the HMI/Labels/ShortLabel symbol"

How AI Context Works

When you open or create a solution, the AI automatically receives context about the FrameworX object model, including:

• Available object types and their relationships
• JSON formats for creating objects and displays
• Dependencies between objects (e.g., AlarmItem requires Tag + AlarmGroup)
• Pre-defined objects available in every solution
• Runtime namespace syntax for referencing objects
• Symbol library structure and common symbols

This context enables the AI to generate valid configuration without you needing to explain the FrameworX data model. For detailed information beyond what's in the context, the AI can use the search_docs tool to query the FrameworX documentation.

Display Context

For display operations, the AI also receives:

• Available control types and their properties
• Symbol library categories and naming conventions
• Dashboard grid constraints (≤4×4 for simple format)
• Dynamic behavior options (color change, visibility, etc.)
• Theme property mappings

Protocol Context

For device configuration, the AI can discover:

• Available protocols organized by group (AutomationVendors, FactoryFloor, ITCloud, etc.)
• Protocol-specific schemas for ProtocolOptions, PrimaryStation, and Address fields
• Key fields that must be configured (marked with * suffix)
• Valid value ranges, enumerations, and default values
• Interface options (Serial, TCPIP, Custom)

Data Explorer Context

When using Data Explorer tools, the AI receives:

• Connection status and current data source type
• Selected node path and available children
• Pre-built "recipes" for creating TagProviders or Devices from the selection
• Protocol-specific connection string formats

Best Practices

Review Before Committing

AI-generated configuration should always be reviewed before saving:

• Verify object names and hierarchy placement
• Check property values and units
• Validate alarm configurations
• Test display layouts and bindings
• Preview dashboards at different screen sizes

Use Version Control

• Save solution backups before bulk AI operations
• Use FrameworX solution versioning features
• Consider Git integration for exported JSON files

Effective Prompting

For best results when working with AI MCP for Designer:

Display Creation Tips

Device Configuration Tips

Start Small

• Test with single objects before bulk operations
• Verify AI understands your naming conventions
• Build complexity gradually
• Create simple displays before complex dashboards
• Test device connections before creating TagProviders

Search examples:

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

Documentation Tools (2 tools)

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

Track Changes (1 tool)

Available tables:

• RecentChanges — Audit trail
• VersionControl — Table versions
• CrossReference — Where an object is used (requires object_name)
• UseCount — Usage frequency

Table Types Quick Reference

Syntax Quick Reference

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 receive Category = "MCP" to track AI-created vs manually-created.

How it works:

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

Common Workflows

Creating Tags

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

Device Communication

"Connect to a Siemens S7-1500 PLC at 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?"

AI uses: 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

Claude doesn't see Designer tools

• Ensure claude_desktop_config.json path is correct (

• double backslashes)
• Restart Claude completely (close via Task Manager)
• Verify Designer MCP shows "running" in Claude settings

AI creates objects in wrong location

• Specify full path in your request (e.g., "in the Boiler/Tanks folder")
• Ask AI to show the solution structure first
• Provide explicit parent object references

Display not rendering correctly

• Check that all referenced tags exist
• Verify symbol paths are correct (use search_symbols to find)
• For dashboards, ensure grid dimensions ≤4×4 for simple format
• Check for missing SymbolLabels on symbols

Dashboard cells not positioned correctly

"Update blocked" message

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

Changes not appearing in Designer

• Refresh

• Designer view (F5)

• For displays, close and reopen the display editor

Protocol not found

• Use list_protocols to see available protocols
• Check spelling (protocol names are case-sensitive)
• Some protocols may not be installed — check FrameworX license

Data Explorer connection failed

• Verify the connection URL format matches the source type
• Check network connectivity to the data source
• Verify credentials if authentication is required
• For OPC UA, ensure the server is running and accessible
• For MQTT, check broker is accepting connections on the specified port

Data Explorer shows no selection

• Browse the tree in Data Explorer and select a node
• Call get_data_explorer_state after selecting to get updated recipes
• Some nodes may not support TagProvider or Device creation

Related Documentation

JSON Format References

• Canvas and Symbol JSON Reference — Complete Canvas/Symbol format specification
• Dashboard JSON Reference — Dashboard format specification
• XAML-JSON Translation Specification — How JSON maps to XAML

Protocol Schema Reference

• Protocol Schema Specification — JSON schema format for protocol fields
• Devices Module Reference — Channel, Node, Point configuration
• UNS Module Reference — TagProvider configuration

AI MCP for Runtime

For querying live data from running solutions:

• AI MCP for Runtime Connector — Query tags, alarms, and historian
• AI MCP for Runtime Tutorial — Step-by-step guide

Quick Start Tutorials

• AI MCP for Designer Tutorial — Create your first objects with AI
• Creating Displays with AI — Display generation walkthrough
• Connecting Data Sources with AI — Using Data Explorer tools

Example Implementation

• SolarPanels MCP Demo — Full solution with MCP integration

Technology Information

• AI-Ready by Design — Platform architecture for AI integration

Reference Information

• Display XAML Reference — XAML patterns for displays
• TControl XAML Inventory — Complete control reference
• Scripts Module Reference — For creating custom MCP tools

Change Log

• Verify operation completed 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

In this section...