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

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.

Documentation Preview: This connector is currently under development and will be available soon. This documentation is a draft and is still being updated.

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 XAML — Create display content with proper FrameworX patterns
• Take Screenshots — Capture Designer state for context

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 Edit Solutions → Settings → MCP
3. Enable Uncheck Allow MCP Server
4. Note the Port number (default: 3102)
5. Click Apply

Connecting Claude Desktop

1. For Designer

This setting is per-solution.

Connecting 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>\\fx-10MCP\\net8.0\\TMCPServerDesigner\\TMCPServerDesigner.DesignerMCP.exe",
      "args": ["/port:3102"],
      "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 these tools organized by category:

Session Management

Solution Management (3 tools)

Schema Discovery

Object Operations (7 tools)

Browse objects with summary informationRetrieve configuration details AI-generated

Tool	Purpose
list_objects
List objects in a table or browse runtime namespaces
get_objects_config
Get full
JSON configuration for specific objects
get_table_schema	Get field definitions and valid values for any table
create_objects	Create new objects from
JSON configuration
validate_json	Validate configuration before creating

Information & Navigation

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"

Generating Displays:

• "Create a simple display showing Tank1_Level with a gauge and numeric value"
• "Generate a 2x3 grid dashboard for all pump status tags"
• "Add a trend chart showing the last 24 hours of temperature data"

Learning & Discovery:

• "What object types are available in FrameworX?"
• "Show me the required fields for creating an alarm item"
• "What protocols are available for device communication?"

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
• Dependencies between objects (e.g., AlarmItem requires Tag + AlarmGroup)
• Pre-defined objects available in every solution
• Runtime namespace syntax for referencing objects

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.

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

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:

Start Small

• Test with single objects before bulk operations
• Verify AI understands your naming conventions
• Build complexity gradually

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

• 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

Generated XAML doesn't render 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
• Ask AI to use simpler layouts first
• Reference existing working displays as examples
• Check for missing namespace declarations

Changes not appearing in Designer

• Refresh the Designer view
• Check if object was created in a different location
• (F5)
• For displays, close and reopen the display editor
• Verify operation completed Verify the operation completed successfully in Claude's response

Related Documentation

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 Tutorial

Learn AI-assisted configuration step by step:

• AI MCP for Designer Tutorial — Create your first objects with AI

Example Implementation

See MCP in action:

• SolarPanels MCP Demo — Full solution with MCP integration

Technology Information

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

Reference Information

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
• Scripts Module Reference — For creating custom MCP tools
• Display XAML Reference — XAML patterns for displays

In this section...