You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

  • Name: MCPDesignerServer
  • Version: 1.0.0.0
  • Interface: TCP/IP
  • Configuration:
    • Scripts / Classes


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.

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

Use CaseExample
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"
Object discovery"List all tags in 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

  1. Open FrameworX Designer
  2. Navigate to Edit → Settings → MCP
  3. Enable MCP Server
  4. Note the Port number (default: 3102)
  5. Click Apply

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 the "claude_desktop_config.json" file
  4. Add the MCP for Designer configuration:
{
  "mcpServers": {
    "FrameworX-Designer": {
      "command": "<ProductPath>\\fx-10\\net8.0\\TMCPServerDesigner\\TMCPServerDesigner.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 listed

Available Tools

AI MCP for Designer provides these tools organized by category:

Session Management

ToolPurpose
create_solutionCreate a new FrameworX solution
open_solutionOpen an existing solution to work with
get_solution_infoGet solution statistics and summary

Schema Discovery

ToolPurpose
list_tablesList all available object types (Tags, Alarms, etc.)
get_table_schemaGet field definitions for any object type

Object Operations

ToolPurpose
list_objectsBrowse objects with summary information
get_objectsRetrieve full configuration details
create_objectsCreate new objects from AI-generated configuration
validate_jsonValidate configuration before creating

Information & Navigation

ToolPurpose
search_docsSearch FrameworX documentation
navigate_toNavigate Designer UI to specific location
get_designer_stateGet current Designer view and selection

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:

DoDon't
Be specific about object types and propertiesUse vague descriptions
Reference existing solution patternsAssume AI knows your conventions
Provide context about intended behaviorSkip important constraints
Ask AI to explain what it will do before executingApprove bulk changes without review
Use validate_json before large create operationsSkip 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

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

  • Scripts Module Reference — For creating custom MCP tools
  • Display XAML Reference — XAML patterns for displays



In this section...

The root page @parent could not be found in space FrameworX 10.1.




  • No labels