Versions Compared

Key

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

Get Claude working with FrameworX

...

:  from first install to productive AI sessions in minutes.

AI Integration | How-to Guide

...

Note: AI Runtime is a separate integration that connects AI to running solutions for live data queries, dashboards, and troubleshooting. This page covers the Designer integration — the build-time experience. See [AI Runtime Connector](AI Runtime Connector) for runtime setup.

...

What You Need

ComponentPurposeInstall Time
Claude SkillPrepares Claude for FrameworX sessions2 minutes
AI DesignerConnects Claude to the live Designer IDE (co-pilot mode)3 minutes
SolutionMCPConnects Claude Code to file-based engineering (offline mode)3 minutes
FrameworX Designer (v10.13+)The IDE that Claude controls (AI Designer) or imports into (SolutionMCP)Download

Requires a Claude Pro, Max, Team, or Enterprise plan.

Which MCP server do I need?

ScenarioUse
Claude Code on the same Windows machine as Designer — want live co-pilotAI Designer (stdio)
Claude Desktop or Claude.ai — want live co-pilot over the networkAI Designer (HTTP/SSE)
Claude Code — want to generate configs without a running DesignerSolutionMCP

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

...

The same SKILL.md works with any compatible agent:

AgentSkill 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

...

Step 2: Connect MCP Tools

...

  1. Claude calls create_solution or open_solution — this 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 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

Tip: You can install both AI Designer and SolutionMCP side by side. They register as separate MCP servers (FrameworX-Designer and FrameworX-SolutionMCP) and do not conflict. Use AI Designer when you want live co-pilot mode, and SolutionMCP when you want offline file generation.

...

If Claude says MCP tools are not connected, verify the server is running and check your config file for typos.

...

Troubleshooting

SymptomLikely CauseFix
Claude web-searches for FrameworX basicsSkill not loadedCheck Settings → Capabilities → Skills
"MCP tools not connected"Server not running or config errorVerify DesignerMCP/SolutionMCP is running, check config JSON
Tools timeout or failPermissions not setSet tool permissions to Always Allow (Claude Desktop)
HTTP connection refusedFirewall or wrong IPOpen port 4000, verify IP address
"Cannot connect" on Mac → Windows VMPort forwarding not configuredConfigure VM port forwarding for port 4000
Node.js errors with mcp-remoteNode.js not installedInstall from nodejs.org
"No active solution" in SolutionMCPSolution not openedCall open_solution or create_solution first
"Control schemas not found" in SolutionMCPMissing data fileEnsure ControlSchemas.json is in the MCP folder alongside SolutionMCP.exe
SolutionMCP fails to launch.NET 8 runtime missingRun dotnet --list-runtimes — install from dotnet.microsoft.com

...

Quick Reference: Config Files

...