From first install to productive AI sessions in minutes.
AI Integration | Claude Skill and MCP Setup
The FrameworX AI Designer experience has two components that work as a pair:
The Claude Skill is a lightweight file (SKILL.md) that loads into Claude at the start of every session. It gives Claude baseline FrameworX knowledge and trained instincts — build-don't-plan : progressive build discipline, schema-then-write patterns, trust-tool-results rules. Without the skill, Claude works but starts every session without context. With it, Claude behaves like an experienced FrameworX engineer from the first message.
MCP Tools connect Claude directly to the FrameworX engineering environment. Two MCP servers are available depending on your workflow:
AI Designer connects Claude to the liveDesigner IDE. Every tool call produces immediate visual changes — tags, displays, alarms, and devices appear in real time while the engineer watches.
1618 tools cover the full solution lifecycle from create_solution through start_runtime. This is the co-pilot experience — Claude and the engineer work side by side on the same screen.
SolutionMCP connects Claude Code to FrameworX in a file-based 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. 12 tools cover solution creation, object CRUD, schema queries, and documentation search. This is the offline engineering experience — Claude builds the configuration, the engineer reviews and imports.
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Together style none
Note: AI Runtime is a separate integration that connects AI to running solutions for live data queries , dashboards, and troubleshootingoperations interactions. This page covers the Designer integration — the build-time experience. See [AI Runtime Connector](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.
| Component | Purpose | Install Time | ||||
|---|---|---|---|---|---|---|
| Claude Skill | Prepares Claude for FrameworX sessions | 2 minutes | ||||
| AI Designer MCP | Connects Claude Desktop to the live Designer IDE (co-pilot mode) | 3 minutes | SolutionMCP | Connects Claude Code to file-based engineering (offline mode) | 5 3 minutes | |
| FrameworX Designer (v10.1.133+) | The IDE that Claude controls (AI Designer) or imports into (SolutionMCP) | Download | ||||
| .NET 8.0 Runtime | Required to run the MCP server | Download | ||||
| Node.js (LTS) | Required for the filesystem server | Download |
Requires a Claude Pro, Max, Team, or Enterprise plan.
Which MCP server do I need?
| Scenario | Use |
|---|---|
| Claude Code on the same Windows machine as Designer — want live co-pilot | AI Designer (stdio) |
| Claude Desktop or Claude.ai — want live co-pilot over the network | AI Designer (HTTP/SSE) |
| Claude Code — want to generate configs without a running Designer | SolutionMCP |
You can install both. They register as separate MCP servers and do not conflict.
Any LLM with MCP protocol support can be used; Claude is our recommendation.
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.
mkdir -p ~/.claude/skills/FrameworX-skill
cp SKILL.md ~/.claude/skills/FrameworX-skill/SKILL.md
Claude Code discovers skills automatically — no restart needed.
The same SKILL.md works with any compatible agent:
| Agent | Skill Location |
|---|---|
| GitHub Copilot | .github/skills/FrameworX-skill/SKILL.md |
| Cursor | .cursor/skills/FrameworX-skill/SKILL.md |
| OpenAI Codex CLI | .codex/skills/FrameworX-skill/SKILL.md |
Three connection modes depending on your setup. Pick the one that matches.
.skill file and select itBefore connecting MCP tools, make sure the following are installed on your Windows machine:
Required to run the DesignerMCP server.
dotnet --list-runtimes
You should see a line containing Microsoft.NETCore.App 8.x.x.
Required for the filesystem server, which enables Claude to read screenshots and inspect external solutions directly. Without it, tools like get_screenshot and inspect_external_solution will not work.
node --version
You should see a version number like v22.x.x. If you see an error, restart your Command Prompt and try again.
Choose the scenario that matches your setup. Most users will use Scenario A.
Use this when Claude Desktop Use this when Claude Code and FrameworX Designer run on the same Windows machine. This is the simplest setup — Claude Code Claude Desktop launches DesignerMCP directly as a subprocess, and the filesystem server gives Claude direct access to screenshots and exported configurations.
Prerequisites:
Configuration:
Add to your Claude Code MCP settings:Win + R, type %APPDATA%\Claude and press Enterclaude_desktop_config.json in any text editor (Notepad works fine)Replace the entire contents of the file with:
| Warning | ||
|---|---|---|
| ||
Replace <username> in
|
{
"mcpServers": {
"FrameworX-Designer": {
"command": "<ProductPath>dotnet",
"args": [
"C:\\Program Files\\Tatsoft\\FrameworX\\fx-10\\net8.0\\DesignerMCP.exe"dll"
],
"transport": "stdio"
},
}
}
Replace <ProductPath> with your FrameworX installation directory. Example:
C:\\Program Files (x86)\\Tatsoft\\FrameworX\\fx-10\\MCP\\DesignerMCP.exe
Use double backslashes in the path.
Use this when Claude runs on a different machine than Designer, or when using Claude Desktop App or Claude.ai (the web chat interface). This mode uses HTTP with Server-Sent Events (SSE), which works across machines, across operating systems, and even across VMs.
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"C:\\Users\\Public\\Documents\\FrameworX\\Transfers"
]
}
}
}
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.
Ctrl + Shift + Esc), find any Claude processes, and end them.Without this step, Claude will ask you to approve every single tool call, which breaks longer building sessions.
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.
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, How it works: DesignerMCPHttp runs as a lightweight HTTP server on the Windows machine alongside Designer. 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.
Prerequisites:
mcp-remote bridge)On the Windows machine where FrameworX is installed:
Documents\FrameworX\UtilitiesYou should see a console window confirming the server is listening on port 10150. Leave this window open — the server must stay running
cd "<ProductPath>\DesignerMCPHttp"
dotnet DesignerMCPHttp.dll
This starts the HTTP/SSE server on port 4000. Leave this running — it must be started before Claude.
Important: The MCP server must be running started before you launch Claude Desktop. If you ever restart the server, you must also restart Claude Desktop as well.
Step 2 — Configure Claude
For Claude Desktop App, edit claude_desktop_config.json:
On the machine where Claude Desktop runs (e.g., your Mac):
node --version
You should see a version number like v22.x.x.
Find and open the configuration file:
Win + R, type %APPDATA%\Claude and press Enter. Open Windows: %APPDATA%\Claude\claude_desktop_config.json.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:
If FrameworX is in a VM on the same host machine (e.g., Parallels/VMware on Mac — use 127.0.0.1):
{
"mcpServers": {
"DesignerMCPHttpFrameworX-Designer": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"http://127.0.0.1:400010150/sse"
]
}
}
}
Claude.ai (web interface with Claude in Chrome), the same HTTP endpoint works — configureFor
http://127.0.0.1:4000/sse as the MCP server URL.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.
Step 3 — Restart Claude Desktop
Close Claude Desktop completely (use Task Manager to ensure it is fully closed) and relaunch.
If Designer runs on a different machine than Claude (including a Windows VM accessed from a Mac host):
ReplaceIf FrameworX is on a different computer on the network, replace
127.0.0.1 with the IP address of
127.0.0.1 works from the Mac sideExample for a Designer running on that machine. For example, if the Windows machine is at 192.168.1.50:
{
"mcpServers": {
"DesignerMCPHttpFrameworX-Designer": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"http://192.168.1.50:400010150/sse"
]
}
}
}
Use this when you want Claude Code to generate FrameworX configurations offline — no running Designer required. Claude creates JSON files in an Exchange folder, and the engineer imports them into Designer later for validation and deployment.
This is ideal for:
Prerequisites:
Configuration:
Add to your Claude Code MCP settings (.mcp.json in your project root, or global Claude Code config):
{
"mcpServers": {
"FrameworX-SolutionMCP": {
"command": "<ProductPath>\\SolutionMCP.exe",
"transport": "stdio"
}
}
}
Replace <ProductPath> with the MCP directory inside your FrameworX installation. Example:
C:\\Program Files (x86)\\Tatsoft\\FrameworX\\fx-10\\MCP\\SolutionMCP.exe
How the file-based workflow works:
create_solution or open_solution — this creates or opens a <name>-json/ folder under Documents/FrameworX/Exchange/get_table_schema to fetch column definitions, then write_objects to generate JSON filesAvailable tools (12):
| Category | Tools |
|---|---|
| Solution management | list_solutions, open_solution, create_solution |
| Object operations | write_objects, get_objects, delete_objects, rename_object |
| Schema queries | get_table_schema, list_elements, list_dynamics, list_protocols |
| Documentation | search_docs, inspect_external_solution |
Tip: You can install both AI Designer and SolutionMCP side by side. They register as separate MCP servers (
FrameworX-DesignerandFrameworX-SolutionMCP) and do not conflict. Use AI Designer when you want live co-pilot mode, and SolutionMCP when you want offline file generation.
Security Authorization
After restarting Claude Desktop with MCP installed:
- Go to Settings → Connectors
- Find FrameworX-Designer (or DesignerMCPHttp) in the list
- Click Configure and set Tool Permissions to Always Allow
Without this, Claude will prompt for authorization on every tool call. Longer responses that use many tools may fail if permissions are not set to Always Allow.
Claude Code handles tool authorization differently — it prompts inline on first use and remembers the decision for the session. No pre-configuration needed.
Start a new Claude conversation and try:
Without MCP (skill only): Ask "How do I set up FrameworX MCP tools?" — Claude should provide step-by-step instructions from the skill, not a web search.
Make sure port 10150 is open in Windows Firewall on the FrameworX machine.
Save and close the file.
Ctrl + Shift + Esc).Cmd + Q.Test itWith AI Designer connected: Ask "Create a new FrameworX solution with a bottling line" — Claude should immediately load the New Solution skill and start building, not spend a response outlining a plan.With SolutionMCP connected: Ask "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 folder.
If Claude is web-searching for basic FrameworX setup information, the skill may not be enabled. Check Settings → Capabilities → Skills.
If Claude says MCP tools are not connected, verify the server is running and check your config file for typos.
| Symptom | Likely Cause | Fix | |||
|---|---|---|---|---|---|
| Claude web-searches for FrameworX basics | Skill not loaded | Check Settings → Capabilities → Skills | |||
| "MCP tools not connected" | Server not running or config error | Verify DesignerMCP/SolutionMCP is running, check config JSONconfig JSON for typos. For Scenario B, make sure the BAT file is running. | |||
| Tools timeout or fail | Permissions not set | Set tool permissions to Always Allow (Claude Desktop)Step A4 or B5) | |||
| DesignerMCP won't start (Scenario A) | .NET 8 not installed or wrong DLL path | Run dotnet --list-runtimes to verify .NET 8 is installed. Verify DesignerMCP.dll exists at the path in your config. | |||
| Filesystem server won't start (Scenario A) | Node.js not installed or wrong username | Run node --version to verify Node.js. Check that <username> was replaced with your actual Windows username. | |||
get_screenshot or inspect_external_solution not working (Scenario A) | Filesystem server not running or not set to Always Allow | Check Settings → Developer — filesystem should show "running". Check Settings → Connectors — filesystem should be set to Always Allow. | |||
| HTTP connection refused (Scenario B) | Firewall, wrong IP, or server not running | Open port 10150 in Windows Firewall, verify IP, make sure the BAT file is running | HTTP connection refused | Firewall or wrong IP | Open port 4000, verify IP address |
| "Cannot connect" on Mac → Windows VM | Port forwarding not configured | Configure VM port forwarding for port 400010150 | |||
| Node.js errors with mcp-remote (Scenario B) | Node.js not installed or outdated | Install from nodejs.org | |||
| "No active solution" in SolutionMCP | Solution not opened | Call open_solution or create_solution first | |||
| "Control schemas not found" in SolutionMCP | Missing data file | Ensure ControlSchemas.json is in the MCP folder alongside SolutionMCP.exe | |||
| SolutionMCP fails to launch | .NET 8 runtime missing | Run dotnet --list-runtimes — install from dotnet.microsoft.com, verify with node --version |
| File | Location |
|---|---|
| Claude Desktop config (Windows) |
%APPDATA%\Claude\claude_desktop_config.json | |
| Claude Desktop config (macOS) |
~/Library/Application Support/Claude/claude_desktop_config.json |
Claude Code MCP (project-level): .mcp.json in your project root
Claude Code skills: ~/.claude/skills/FrameworX-skill/SKILL.md
SolutionMCP workspace: Documents/FrameworX/Exchange/<SolutionName>-json/
Questions or feedback: