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

Compare with Current View Page History

« Previous Version 2 Next »

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.

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 inspect_external_solution. 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:

{
  "mcpServers": {
    "FrameworX-Designer": {
      "command": "dotnet",
      "args": [
        "C:\\Program Files (x86)\\Tatsoft\\FrameworX\\fx-10\\net8.0\\DesignerMCP.dll"
      ],
      "transport": "stdio"
    },
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "C:\\Users\\<username>\\Documents\\FrameworX\\Exchange",
        "C:\\Users\\Public\\Documents\\FrameworX\\Transfers"
      ]
    }
  }
}

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

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

Remote / VM (HTTP):

{
  "mcpServers": {
    "FrameworX-Console": {
      "type": "http",
      "url": "http://localhost:10130/mcp"
    }
  }
}

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 (12)

CategoryTools
Solution managementlist_solutions, open_solution, create_solution
Object operationswrite_objects, get_objects, delete_objects, rename_object
Schema queriesget_table_schema, list_elements, list_dynamics, list_protocols
Documentationsearch_docs, inspect_external_solution

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


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 missingRun dotnet --list-runtimes — 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.dll
HTTP connection refused (remote)Firewall or wrong IPOpen port 10130, verify IP address
Claude web-searches for FrameworX basicsSkill not loadedVerify SKILL.md is in ~/.claude/skills/frameworx-industrial-platform/

Quick Reference: Config Files

FileLocation
Claude Code MCP (project-level).mcp.json in your project root
Claude Code MCP (user-level)~/.claude.json
Claude Code skills~/.claude/skills/frameworx-industrial-platform/SKILL.md
AI Console workspaceDocuments/FrameworX/Exchange/<SolutionName>-json/

Next Steps

  • Back to main setup: MCP and Claude Skill Setup
  • See it in action: [AI Designer In Action](AI Designer In Action)
  • Technical reference: [AI Designer Connector](AI Designer Connector)
  • Download Designer: tatsoft.com/fx-101 (free evaluation, unlimited tags, all features)

Community

Questions or feedback:

  • No labels