Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Advanced command-line integration for FrameworX with Claude Code.
AI Integration|Claude Skill and MCP Setup| Claude Code MCP Setup


Overview

Claude Code connects to FrameworX from the terminal — no GUI needed. Two MCP servers are available depending on your workflow:

AI Designer (DesignerMCP) connects Claude Code to the live Designer IDE on the same machine. Every tool call produces immediate visual changes — the same co-pilot experience as Claude Desktop, but driven from the command line. Use this when you want live building with Designer open on your screen.

AI Console (ConsoleMCP) connects Claude Code to a file-based engineering workflow. No running Designer needed — Claude generates JSON configuration files following the ExportFormat 1.2 standard, which the engineer imports into Designer for validation and deployment. Use this for analyzing existing projects, generating solutions from specifications, or batch-building.

Table of Contents
maxLevel2
minLevel2
indent10px
excludeOverview
stylenone

You can install both. They register as separate MCP servers and do not conflict.

ScenarioUse
Claude Code on the same Windows machine as Designer — want live co-pilotAI Designer
Generate configs without a running DesignerAI Console
Analyze existing projects, audit configurationsAI Console
Batch-build or generate solutions from specificationsAI Console

Prerequisites for both: FrameworX v10.1.3+ installed, .NET 8.0 Runtime installed, Claude Code installed.


Install the Claude Skill (Claude Code)

If you haven't already installed the skill, copy the SKILL.md file to Claude Code's skills directory:

mkdir -p ~/.claude/skills/frameworx-industrial-platform
cp SKILL.md ~/.claude/skills/frameworx-industrial-platform/SKILL.md

Claude Code discovers skills automatically — no restart needed.

Other AI Agents

The same SKILL.md works with any compatible agent:

AgentSkill Location
GitHub Copilot.github/skills/frameworx-industrial-platform/SKILL.md
Cursor.cursor/skills/frameworx-industrial-platform/SKILL.md
OpenAI Codex CLI.codex/skills/frameworx-industrial-platform/SKILL.md

AI Designer Setup (Live IDE Co-Pilot)

This connects Claude Code to the running FrameworX Designer IDE on the same Windows machine. Claude Code launches DesignerMCP directly as a subprocess — the simplest possible setup.

Step 1: Add the MCP Server

Open a terminal and run:

claude mcp add FrameworX-Designer -- dotnet "C:\Program Files (x86)\Tatsoft\FrameworX\fx-10\net8.0\DesignerMCP.dll"

This saves the configuration at project level by default. For other scopes:

  • -s project — saves to .mcp.json in the project root (shared via version control)
  • -s user — saves to global/user-level config, available in all projects

For a global install:

claude mcp add -s user FrameworX-Designer -- dotnet "C:\Program Files (x86)\Tatsoft\FrameworX\fx-10\net8.0\DesignerMCP.dll"

Step 2: (Optional) Add the Filesystem Server

The filesystem MCP server allows Claude to directly read files produced by get_screenshot and get_solution_export_files. Without it, those tools still work but you must manually provide the files. All other Designer tools work independently.

The filesystem server requires Node.js — install from https://nodejs.org if not already present.

claude mcp add filesystem -- npx -y @modelcontextprotocol/server-filesystem "C:\Users\<username>\Documents\FrameworX\Exchange" "C:\Users\Public\Documents\FrameworX\Transfers"

Replace <username> with your Windows username.

Step 3: Verify

claude mcp list

You should see FrameworX-Designer (and filesystem if added) in the list.

Alternative: Manual Configuration

If you prefer editing config files directly, add to your .mcp.json or Claude Code MCP settings:

From first install to productive AI sessions in minutes.

AI Integration | Claude Skill and MCP Setup

Together, the skill conditions Claude's behavior before the first tool fires, and MCP gives Claude the tools to act on that knowledge. The result is an AI co-pilot that truly understands the platform and builds solutions correctly from the first response.

Note: AI Runtime is a separate integration that connects AI to running solutions for live data queries and operations interactions. This page covers the Designer integration — the build-time experience. See AI Runtime Connector for runtime setup.

Looking for Claude Code? If you use Claude Code from the command line, see Claude Code MCP Setup for advanced integration options including file-based engineering without a running Designer.

What You Need

Component

Purpose

Install Time

Claude Skill

Prepares Claude for FrameworX sessions

2 minutes

MCP Bundles (.mcpb)

Connects Claude Desktop to the live Designer IDE

2 minutes

FrameworX Designer (v10.1.3+)

The IDE that Claude controls

Download

Requires a Claude Pro, Max, Team, or Enterprise plan.
Any LLM with MCP protocol support can be used; Claude is our recommendation.

Step 1: Install the Claude Skill

The Claude Skill is a portable SKILL.md file that follows the Agent Skills open standard. Install it once — it activates automatically whenever you mention FrameworX, SCADA, HMI, or related topics.

All setup files are located in your Documents folder:

Documents\FrameworX\AISetup

  1. Open File Explorer and navigate to Documents\FrameworX\AISetup
  2. Find frameworx-industrial-platform.skill
  3. Open Claude Desktop
  4. Click the hamburger menu (?) at the top-left corner
  5. Click Settings
  6. In the left sidebar, click Capabilities
  7. Scroll down to the Skills section
  8. Click Upload skill
  9. Browse to the .skill file and select it
  10. Make sure the skill toggle is set to On
  11. Close the Settings window — the skill is now active for all future conversations

Step 2: Install the MCP Bundles

Two MCP Bundles connect Claude Desktop to FrameworX — one for the Designer tools, one for file access (screenshots, file exchange). Both are single-click installs.

Prerequisites: FrameworX Designer v10.1.3+ must be installed first. The bundles are in the AISetup folder created by the product installation.

  1. Open File Explorer and navigate to Documents\FrameworX\AISetup
  2. Double-click frameworkx-designer-mcp.mcpb
  3. Claude Desktop opens an install dialog — click Install
  4. Double-click frameworkx-filesystem.mcpb
  5. Claude Desktop opens an install dialog — click Install
  6. Both extensions appear in Settings → Extensions

Note: If Claude Desktop is not running, it will launch automatically when you double-click the .mcpb file. The install dialog may ask you to confirm the FrameworX installation path and Transfers folder — the defaults are correct for standard installations.

Step 3: Set Permissions and Verify

Set Tool Permissions

Without this step, Claude will ask you to approve every single tool call, which breaks longer building sessions.

  1. In Claude Desktop, click the hamburger menu (?) at the top-left
  2. Click Settings
  3. In the left sidebar, click Extensions
  4. Find FrameworX AI Designer in the list
  5. Set Tool Permissions to Always Allow
  6. Find FrameworX File Access in the list
  7. Set Tool Permissions to Always Allow
  8. Close the Settings window

Verify It Works

  1. In Settings → Extensions, verify that both FrameworX AI Designer and FrameworX File Access show status "running"
  2. Open a new chat and click Search and Tools — Designer tools should appear in the list
  3. In FrameworX Designer, verify the orange "AI Designer" badge appears

Test it: Open a new conversation and ask "Create a new FrameworX solution with a bottling line" — Claude should immediately start building, calling create_solution and writing objects.

You're done! Jump to Next Steps.

Advanced: Different Computers

Use this when Claude Desktop and FrameworX Designer run on different machines — for example, Claude Desktop running on a Mac with FrameworX Designer inside a Windows virtual machine (Parallels, VMware), or FrameworX running on a separate Windows computer on the network.

In this setup, DesignerMCPHttp runs as a lightweight HTTP server on the Windows machine. Claude Desktop connects to it over the network using mcp-remote, an open-source MCP-to-HTTP bridge. All communication happens exclusively through the MCP tools — no shared folders or filesystem server is needed.

Example JSON configuration files are provided in Documents\FrameworX\AISetup\HTTP — copy the appropriate example into your Claude Desktop config file.

Prerequisites:

  • FrameworX Designer v10.1.3+ installed on the Windows machine
  • Node.js (LTS version) installed on the machine running Claude Desktop (for the mcp-remote bridge)
  • Claude Desktop installed

1. Start DesignerMCPHttp on the Windows Machine

On the Windows machine where FrameworX is installed:

  1. Open File Explorer and navigate to Documents\FrameworX\Utilities
  2. Double-click StartDesignerMCPHttp.bat

You should see a console window confirming the server is listening on port 10150. Leave this window open — the server must stay running.

Important: The MCP server must be started before Claude Desktop. If you ever restart the server, you must also restart Claude Desktop.

2. Install Node.js on the Claude Desktop Machine (if not already installed)

On the machine where Claude Desktop runs (e.g., your Mac):

  1. Go to https://nodejs.org
  2. Download the LTS (Long Term Support) version
    • Windows: Windows Installer (.msi), 64-bit
    • macOS: macOS Installer (.pkg)
  3. Run the installer — accept defaults. On Windows, make sure "Add to PATH" is checked.
  4. Verify by opening a terminal and typing:
Code Block
node --version

You should see a version number like v22.x.x.

3. Configure Claude Desktop

Find and open the configuration file:

  • Windows: Press Win + R, type %APPDATA%\Claude and press Enter. Open claude_desktop_config.json.
  • macOS: Open Finder, press Cmd + Shift + G, type ~/Library/Application Support/Claude and press Enter. Open claude_desktop_config.json.

If the file doesn't exist, create a new text file with that exact name.

Replace the entire contents with the appropriate example from Documents\FrameworX\AISetup\HTTP:

If FrameworX is in a VM on the same host machine (use config-example-localhost.json):

Code Blockjsonjson
{
  "mcpServers": {
    "FrameworX-Designer": {
      "command": "
npx
dotnet",
      "args": [
        "
-y", "mcp-remote", "http://127.0.0.1:10150/sse
C:\\Program Files (x86)\\Tatsoft\\FrameworX\\fx-10\\net8.0\\DesignerMCP.dll"
      ],
    
}
  
} }

For Mac + Parallels/VMware: You may need to configure port forwarding in your VM settings to route port 10150 from the Mac host to the Windows guest.

If FrameworX is on a different computer on the network (use config-example-remote.json and edit the IP address):

Code Blockjsonjson{ "mcpServers": {
"transport": "stdio"
    },
    "
FrameworX-Designer
filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "
mcp
@modelcontextprotocol/server-
remote
filesystem",
        "
http://192.168.1.50:10150/sse
C:\\Users\\<username>\\Documents\\FrameworX\\Exchange",
        "C:\\Users\\Public\\Documents\\FrameworX\\Transfers"
      ]
    }
  }
}

Make sure port 10150 is open in Windows Firewall on the FrameworX machine.

Save and close the file.

4. Restart Claude Desktop

  1. Fully close Claude Desktop:
    • Windows: Right-click the Claude icon in the system tray and click Quit, or end it via Task Manager (Ctrl + Shift + Esc).
    • macOS: Right-click the Claude icon in the Dock and click Quit, or press Cmd + Q.
  2. Relaunch Claude Desktop.

5. Set Tool Permissions

  1. In Claude Desktop, click the hamburger menu (?) at the top-left
  2. Click Settings
  3. In the left sidebar, click Connectors
  4. Find FrameworX-Designer in the list
  5. Click Configure
  6. Set Tool Permissions to Always Allow
  7. Close the Settings window

6. Verify It Works

  1. Go to Settings → Developer and verify FrameworX-Designer shows status "running"
  2. Open a new chat and click Search and Tools — Designer tools should appear
  3. In FrameworX Designer on the Windows machine, verify the orange "AI Designer" badge appears

Test it: Ask "Create a new FrameworX solution with a bottling line" — Claude should immediately start building.

Advanced: Manual JSON Configuration

If the MCP Bundles do not work for your environment, or you prefer manual control, you can configure Claude Desktop by editing the JSON configuration file directly.

Prerequisites:

1. Find the Configuration File

  • Press Win + R, type %APPDATA%\Claude and press Enter
  • Open the file claude_desktop_config.json in any text editor (Notepad works fine)
  • If the file doesn't exist, create a new text file with that exact name

2. Paste the Configuration

Replace the entire contents of the file with:

Warning
titleReplace <username>

Replace <username> in "C:\\Users\\<username>\\Documents\\FrameworX
Exchange"

Go to your c:\Users folder to confirm the exact name of your user in the computer

Code Block

Replace <username> with your Windows username. The path shown is the default FrameworX installation location — adjust if you installed to a different drive or folder.

Note: Claude Code handles tool authorization inline — it prompts on first use and remembers the decision for the session. No pre-configuration of permissions is needed.


AI Console Setup (File-Based Engineering)

AI Console connects Claude Code to FrameworX without a running Designer. Claude generates JSON configuration files that the engineer imports into Designer later for validation and deployment.

Step 1: Add the MCP Server

Local machine (stdio):

claude mcp add FrameworX-Console -- dotnet "C:\Program Files (x86)\Tatsoft\FrameworX\fx-10\net8.0\ConsoleMCP.dll"

For a global install:

claude mcp add -s user FrameworX-Console -- dotnet "C:\Program Files (x86)\Tatsoft\FrameworX\fx-10\net8.0\ConsoleMCP.dll"

Remote machine or VM (HTTP):

When FrameworX is on another machine (e.g., Claude Code running on macOS managing FrameworX in a Windows Parallels VM):

claude mcp add --transport http FrameworX-Console http://localhost:10130/mcp

Replace localhost with the remote machine's IP address if needed.

Step 2: Verify

claude mcp list

You should see FrameworX-Console in the list.

Alternative: Manual Configuration

Local (stdio):

jsonjson
{
  "mcpServers": {
    "FrameworX-
Designer
Console": {
      "command": "dotnet",
      "args": [
        "C:\\Program Files (x86)\\Tatsoft\\FrameworX\\fx-10\\net8.0\\
DesignerMCP
ConsoleMCP.dll"
      ],
      "transport": "stdio"
    }
,

  }
}

Remote / VM (HTTP):

{
  "
filesystem
mcpServers": {
    
"
command
FrameworX-Console": 
"npx",
{
      "
args
type":
[
 
"-y
"http",
      
"@modelcontextprotocol/server-filesystem", "C:\\Users\\Public\\Documents\\FrameworX\\Transfers" ]
"url": "http://localhost:10130/mcp"
    }
  }
}

Important: Replace <username> with your Windows username. To find it, press Win + R, type cmd, press Enter, and type echo %USERNAME%.

Save and close the file.

Note: The DesignerMCP path above is the default installation location. If you installed FrameworX to a different drive or folder, adjust accordingly. Use double backslashes in all paths.

3. Restart Claude Desktop

  1. Fully close Claude Desktop — don't just close the window. Right-click the Claude icon in the system tray (bottom-right corner near the clock) and click Quit. If you don't see it there, open Task Manager (Ctrl + Shift + Esc), find any Claude processes, and end them.
  2. Relaunch Claude Desktop.

4. Set Tool Permissions

  1. In Claude Desktop, click the hamburger menu (?) at the top-left
  2. Click Settings
  3. In the left sidebar, click Connectors
  4. Find FrameworX-Designer in the list
  5. Click Configure
  6. Set Tool Permissions to Always Allow
  7. Repeat for the filesystem entry — set it to Always Allow as well
  8. Close the Settings window

5. Verify It Works

  1. In Claude Desktop, go to Settings → Developer
  2. Verify that both FrameworX-Designer and filesystem show status "running"
  3. Open a new chat and click Search and Tools — Designer tools should appear in the list
  4. In FrameworX Designer, verify the orange "AI Designer" badge appears

How the File-Based Workflow Works

  1. Claude calls create_solution or open_solution — creates or opens a <name>-json/ folder under Documents/FrameworX/Exchange/
  2. Claude calls get_table_schema to fetch column definitions, then write_objects to generate JSON files
  3. Each JSON file follows the ExportFormat 1.2 envelope structure — ready for Designer import
  4. The engineer opens Designer, imports the JSON files, validates, and deploys

Available AI Console Tools (14)

CategoryTools
Solution managementlist_solutions, open_solution, create_solution
Object operationswrite_objects, get_objects, delete_objects, rename_objects, browse_object_model
Schema queriesget_table_schema, list_elements, list_dynamics, list_protocols
Documentationsearch_docs, get_solution_export_files

Test Your Setup

AI Designer test: Open Designer, then ask Claude Code: "Create a new FrameworX solution with a bottling line" — Claude should call create_solution and start building in the live IDE.

AI Console test: Ask Claude Code: "Create a new FrameworX solution with 10 motor tags and Modbus communication" — Claude should call create_solution, fetch schemas, and start writing JSON files into the Exchange folderTest it: Open a new conversation and ask "Create a new FrameworX solution with a bottling line" — Claude should immediately start building, calling create_solution and writing objects.


Troubleshooting

SymptomLikely CauseFix
claude mcp list doesn't show FrameworXAdd command failed or wrong scopeRe-run claude mcp add with -s user for global install
DesignerMCP or ConsoleMCP won't start.NET 8 runtime missing

Claude web-searches for FrameworX basics

Skill not loaded

Check Settings → Capabilities → Skills

"MCP tools not connected"

Server not running or config error

Verify both .mcpb bundles are installed in Settings → Extensions. For manual config, check JSON for typos.

Tools timeout or fail

Permissions not set

Set tool permissions to Always Allow for both extensions (Step 3)

MCP Bundle won't install

Claude Desktop outdated

Update Claude Desktop to the latest version

Screenshots not working

Filesystem extension not installed

Install frameworkx-filesystem.mcpb from Documents\FrameworX\AISetup|

DesignerMCP won't start (manual config)

.NET 8 not installed or wrong DLL pathRun dotnet --list-runtimes to verify .NET 8 is installed. Verify DesignerMCP.dll exists at the path in your config.

Filesystem server won't start (manual config)

Node.js not installed

— install from dotnet.microsoft.com
"No active solution" in AI ConsoleSolution not openedCall open_solution or create_solution first
"Control schemas not found" in AI ConsoleMissing data fileEnsure ControlSchemas.json is in the MCP folder alongside ConsoleMCP.dllRun node --version to verify Node.js is installed.
HTTP connection refused (different computersremote)Firewall , or wrong IP, or server not runningOpen port 10150 in Windows Firewall10130, verify IP , make sure the BAT file is runningaddress
Claude web-searches for FrameworX basicsSkill not loadedVerify SKILL.md is in ~/.claude/skills/frameworx-industrial-platform/

"Cannot connect" Mac → Windows VM

Port forwarding not configured

Configure VM port forwarding for port 10150

Quick Reference: Config Files

FileLocation
Claude Desktop config (Windows)Code MCP (project-level).mcp.json in your project root
Claude Code MCP (user-level)~/.claude%APPDATA%\Claude\claude_desktop_config.json
Claude Desktop config (macOS)Code skills~/Library.claude/Application Support/Claude/claude_desktop_config.json

AISetup folder

Documents\FrameworX\AISetup

Anchornext-stepsnext-steps

Next Steps

skills/frameworx-industrial-platform/SKILL.md
AI Console workspaceDocuments/FrameworX/Exchange/<SolutionName>-json/

Next Steps

  • Back to main setup: MCP and Claude Setup
  • See it in action: AI Designer In Action
  • Technical Referencereference: AI Designer ConnectorClaude Code Integration: Claude Code MCP Setup
  • Download Designer: FrameworX (free evaluation, unlimited tags, all features)

Community

Questions or feedback: