Overview
The AI MCP for Designer service enables AI models to interact with the FrameworX Designer application, providing intelligent assistance for solution configuration tasks. Instead of manually creating and configuring objects, you can describe what you need in natural language and let AI generate the configuration.
Note: This connector is for configuration-time operations (building solutions in Designer.exe). For querying live data from running solutions, see AI MCP for Runtime Connector.
| Info |
|---|
title | Documentation Preview
: This connector
is 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
Modify Configuration — Update existing objects with AI assistanceImport JSON — Bulk import configurations generated by AI- 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
| Use Case | Example |
|---|
| Bulk object creation | "Create 50 temperature tags following naming pattern Area{N}_Temp" |
| Display generation | "Create a dashboard showing all pump statuses in a 3x4 grid" |
| Configuration validation | "Review my alarm configuration and suggest improvements" |
| Learning assistance | "Show me how to configure a historian for this tag" |
RefactoringRename Section1 to follow camelCase convention| the Boiler area that don't have alarms configured" |
Prerequisites
- FrameworX 10.1 Designer
- .NET 8.0 runtime
- Claude Desktop or compatible MCP client
- Network connectivity (if Designer runs on remote machine)
Configuration
Enabling MCP for Designer
- Open FrameworX Designer
- Navigate to Edit → Settings → MCP
- Enable MCP Server
- Note the Port number (default: 3102)
- Click Apply
Connecting Claude Desktop
Configure Claude Desktop to connect to the Designer MCP server:
- Open Claude Desktop
- Go to Settings → Developer → Edit Config
- Open the "claude_desktop_config.json" file
- Add the MCP for Designer configuration:
json
{
"mcpServers": {
"FrameworX-Designer": {
"command": "<ProductPath>\\fx-10\\net8.0\\TMCPServerDesigner\\TMCPServerDesigner.exe",
"args": ["/port:3102"],
"transport": "stdio"
}
}
}
- Replace <ProductPath> with your FrameworX installation directory (use double backslashes)
- Save and close the file
- 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
- Open Claude Desktop
- Go to Settings → Developer
- Verify "FrameworX-Designer" shows status "running"
- Open a new chat and click Search and Tools — you should see the Designer tools listed
ToolsBuilt-in AI MCP for Designer provides these
pre-configured tools organized by category:
Session Management
| GetSolutionStructure | Retrieve the solution tree structure |
| GetObjectProperties | Read properties of any solution object |
| CreateObject | Create new tags, displays, alarms, etc. |
| ModifyObject | Update properties of existing objects |
| DeleteObject | Remove objects from the solution |
| SearchObjects | Find objects by name, type, or property |
| ImportJSON | Bulk import configuration from JSON |
| ExportJSON | Export configuration to JSON format |
| GenerateXAML | Create display XAML content |
|
|---|
| create_solution | Create a new FrameworX solution |
| open_solution | Open an existing solution to work with |
| get_solution_info | Get solution statistics and summary |
Schema Discovery
| Tool | Purpose |
|---|
| list_tables | List all available object types (Tags, Alarms, etc.) |
| get_table_schema | Get field definitions for any object type |
Object Operations
| Tool | Purpose |
|---|
| list_objects | Browse objects with summary information |
| get_objects | Retrieve full configuration details |
| create_objects | Create new objects from AI-generated configuration |
| validate_json | Validate configuration before creating |
| Tool | Purpose |
|---|
| search_docs | Search FrameworX documentation |
| navigate_to | Navigate Designer UI to specific location |
| get_designer_state | Get current Designer view and selection |
TakeScreenshot | Capture current Designer view
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"
Modifying ConfigurationLearning & Discovery:
Change the high alarm limit on all temperature tags from 80 to 85- What object types are available in FrameworX?"
- "
Update the description on all tags in Area1 to include 'Production Line A'""Rename tag OldName to NewName and update all references"- 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
Integration with AI Context Documents
For AI to generate valid FrameworX configuration, it uses context documents that describe the platform's data model and XAML patterns:
| Document | Purpose |
|---|
| MCP Designer Context | FrameworX object model and namespaces |
| MCP Display Context | Display XAML patterns and conventions |
| Display XAML Reference | Complete XAML specification |
| TControl XAML Inventory | Control lookup tables |
These documents are located in Support Resources and are optimized for AI consumption. FrameworX feeds automatically that information for AI to give it context on how to create solutions.
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:
| Do | Don't |
|---|
| Be specific about object types and properties | Use vague descriptions |
| Reference existing solution patterns | Assume AI knows your conventions |
| Provide context about intended behavior | Skip important constraints |
| Ask AI to explain what it will do before executing | Approve bulk changes without review |
| Use validate_json before large create operations | Skip validation on bulk imports |
Start Small
- Test with single objects before bulk operations
- Verify AI understands your naming conventions
- Build complexity gradually
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
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
Generated XAML doesn't render correctly
- 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
- Verify the operation completed successfully in Claude's response
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
- AI-Ready by Design — Platform architecture for AI integration
- Scripts Module Reference — For creating custom MCP tools
- Display XAML Reference — XAML patterns for displays