File-based MCP surface for FrameworX. Author solutions as JSON workspace folders with no running Designer.

AI Integration → ConsoleMCP Reference

Vocabulary vs. DesignerMCP

Both servers expose parallel operations with deliberately distinct tool names so the mode is always obvious in a transcript.

Tools with no mode-specific vocabulary keep the same name in both servers: write_objects, get_objects, delete_objects, rename_objects, browse_object_model, get_table_schema, list_elements, list_dynamics, list_protocols, search_docs, get_solution_export_files, search_uns, import_graph_model, export_graph_model, generate_uns_visual.

Workspace Folder Layout

A workspace folder holds one JSON file per table, using the ExportFormat 1.2 envelope. ConsoleMCP creates the folder under Public Documents\FrameworX\Exchange\<Name>-json\ and keeps a session log in mcp_session_log.json alongside the tables.

<Name>-json/
  UnsUserTypes.json
  UnsTags.json
  UnsAssetTree.json
  UnsEnumerations.json
  DisplaysList.json
  DisplaysSymbols.json
  AlarmsItems.json
  DevicesChannels.json
  ...
  Exchange/
    Graphs/
      <Name>_UNS_Graph.rj
    Visualizations/
      <Name>_UNS_Visual.md
  mcp_session_log.json
      

Overlay semantics apply on import. When you run import_graph_model, the overlay is written as UnsUserTypes-graph-<ts>.json next to the canonical file. Canonical files are never overwritten until you explicitly build the .dbsln.

Tool Catalog (17 tools)

Note. ConsoleMCP does NOT expose promote_retentive_attributes. That tool mutates runtime state via the live Designer pipe and is intentionally excluded from the file-based surface.

create_solution_file

Turns a workspace into a new .dbsln. ConsoleMCP spawns SolutionCreator.exe headlessly and waits for completion.

create_solution_file(
  solution_name="Foo",
  workspace="C:\\Users\\Public\\Documents\\FrameworX\\Exchange\\Foo-json",
  template="HeaderLayout",
  platform="Windows",
  output_folder=null
)
      

Response includes the produced .dbsln path, exit code, per-file import attribution (created, modified, skipped, errors), and the headless log.

update_solution_file

Refreshes an existing .dbsln in place from a workspace. Auto-backs up the target .dbsln with keep-last-3 retention, then applies the workspace JSON files with always-upsert semantics (existing objects with the same name are overwritten by the workspace version).

update_solution_file(
  solution="C:\\Solutions\\Foo.dbsln",
  workspace="C:\\Users\\Public\\Documents\\FrameworX\\Exchange\\Foo-json"
)
      

The solution argument is an absolute path ending in .dbsln and must point to an existing file. Backup filename pattern: <Name>.dbsln__backup__<timestamp>.backup. Response mirrors create_solution_file and includes the backup path.

Interop with DesignerMCP

DesignerMCP's open_solution and create_solution accept an optional from_workspace parameter. When supplied, Designer opens or creates the target .dbsln, auto-backs up (3-file retention), and imports every *.json file from the workspace folder using the same upsert semantics as update_solution_file. Use this to apply a workspace authored in ConsoleMCP to an existing or fresh solution from inside a live Designer session.

• open_solution(name, from_workspace="C:\\Path\\Foo-json")
• create_solution(name, template="HeaderLayout", from_workspace="C:\\Path\\Foo-json")

A missing folder, an empty folder, or a pipe exception becomes a warning. The open or create still succeeds. The response carries a workspaceImport section with per-file results.

Error Codes

In this section...