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

Documentation: | | AI MCP for Designer Connector

Preview Connector

Preview Version for tests and training, not released for production.

<ac:layout-section ac:type="single"> ac:layout-cell

Overview

The AI MCP for Designer enables AI models to interact with FrameworX Designer, providing intelligent assistance for solution configuration. Describe what you need in natural language—AI generates the configuration.

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

MCP for Designer is Enabled by default. To disable:

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

This setting is per-solution.

Connecting Claude Desktop

1. Open Claude Desktop
2. Go to Settings → Developer → Edit Config
3. Open "claude_desktop_config.json"
4. Add the 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
3. Restart Claude Desktop completely (close via 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 — Designer tools should be listed
5. In Designer, verify the orange "AI MCP" badge appears

Available Tools

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
• 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)

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

"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
• 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...