Sean P. KaneandGitHub
f14ab8177d
* chore: rename workbench to FreecadRobustMCPBridge * fix: stdio cleanup and bug fix for JSON RPC * fix: update FreeCAD MCP bridge and tests * test: Fix GUI Integration tests and other issues * fix: unit tests in CI and a few other things * docs: generate GitHub pages site and link to it. * fix: General code improvements and DRY refactoring * chore: General cleanup * chore: small fixes * docs: cleanup * docs: fixes * docs: small corrections * docs: fix * test: release check * bump: workbench v0.6.0 * chore: bump macros to 0.6.0 * docs: Release improvements * refactor: improve DRYness of code
119 lines
4.0 KiB
Python
Executable File
119 lines
4.0 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
r"""Blocking FreeCAD Robust MCP Bridge Server.
|
|
|
|
SPDX-License-Identifier: MIT
|
|
Copyright (c) 2025 Sean P. Kane (GitHub: spkane)
|
|
|
|
This script starts the MCP bridge server and blocks with run_forever().
|
|
It works with both freecad (GUI) and freecadcmd (headless) modes.
|
|
|
|
Use this script when you need FreeCAD to keep running (CI, background servers).
|
|
For interactive GUI sessions, use startup_bridge.py instead (non-blocking).
|
|
|
|
Usage:
|
|
# Headless mode (no GUI features):
|
|
freecadcmd ~/.local/share/FreeCAD/Mod/FreecadRobustMCPBridge/\
|
|
freecad_mcp_bridge/blocking_bridge.py
|
|
|
|
# GUI mode (full features including screenshots):
|
|
freecad ~/.local/share/FreeCAD/Mod/FreecadRobustMCPBridge/\
|
|
freecad_mcp_bridge/blocking_bridge.py
|
|
|
|
# On macOS:
|
|
/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd \
|
|
~/Library/Application\ Support/FreeCAD/Mod/FreecadRobustMCPBridge/\
|
|
freecad_mcp_bridge/blocking_bridge.py
|
|
|
|
Note: In headless mode (freecadcmd), GUI features like screenshots are not available.
|
|
For full functionality, run with the freecad GUI executable.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# Check if we're running inside FreeCAD
|
|
try:
|
|
import FreeCAD
|
|
|
|
print(f"FreeCAD version: {FreeCAD.Version()[0]}.{FreeCAD.Version()[1]}")
|
|
except ImportError:
|
|
print("ERROR: This script must be run with freecad or freecadcmd.")
|
|
print("")
|
|
print("Usage:")
|
|
print(
|
|
" freecadcmd /path/to/FreecadRobustMCPBridge/freecad_mcp_bridge/blocking_bridge.py"
|
|
)
|
|
print("")
|
|
print("On macOS (if workbench installed):")
|
|
print(" /Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd \\")
|
|
print(
|
|
" ~/Library/Application\\ Support/FreeCAD/Mod/FreecadRobustMCPBridge/"
|
|
"freecad_mcp_bridge/blocking_bridge.py"
|
|
)
|
|
print("")
|
|
print("On Linux (if workbench installed):")
|
|
print(
|
|
" freecadcmd ~/.local/share/FreeCAD/Mod/FreecadRobustMCPBridge/"
|
|
"freecad_mcp_bridge/blocking_bridge.py"
|
|
)
|
|
sys.exit(1)
|
|
|
|
# Import the plugin server directly from the module file in the same directory
|
|
script_dir = str(Path(__file__).resolve().parent)
|
|
sys.path.insert(0, script_dir)
|
|
from bridge_utils import get_running_plugin # noqa: E402
|
|
from server import FreecadMCPPlugin # noqa: E402
|
|
|
|
# Check if bridge is already running (from auto-start in Init.py)
|
|
plugin = get_running_plugin()
|
|
|
|
if plugin is None:
|
|
# Get configuration from environment variables (with defaults)
|
|
try:
|
|
socket_port = int(os.environ.get("FREECAD_SOCKET_PORT", "9876"))
|
|
xmlrpc_port = int(os.environ.get("FREECAD_XMLRPC_PORT", "9875"))
|
|
except ValueError as e:
|
|
print(f"ERROR: Invalid port configuration: {e}")
|
|
print("FREECAD_SOCKET_PORT and FREECAD_XMLRPC_PORT must be integers.")
|
|
sys.exit(1)
|
|
|
|
# Create and run the plugin
|
|
plugin = FreecadMCPPlugin(
|
|
host="localhost",
|
|
port=socket_port, # JSON-RPC socket port
|
|
xmlrpc_port=xmlrpc_port, # XML-RPC port
|
|
enable_xmlrpc=True,
|
|
)
|
|
|
|
# Start the plugin
|
|
plugin.start()
|
|
|
|
# Print status messages with flush to ensure they appear immediately
|
|
# (FreeCAD's Python may have buffered stdout)
|
|
# Plugin is guaranteed non-None at this point (either from get_running_plugin or created above)
|
|
actual_xmlrpc_port = plugin.xmlrpc_port
|
|
actual_socket_port = plugin.socket_port
|
|
|
|
print("", flush=True)
|
|
print("=" * 60, flush=True)
|
|
gui_mode = "GUI" if FreeCAD.GuiUp else "headless"
|
|
print(f"MCP Bridge started in {gui_mode} mode!", flush=True)
|
|
print(f" - XML-RPC: localhost:{actual_xmlrpc_port}", flush=True)
|
|
print(f" - Socket: localhost:{actual_socket_port}", flush=True)
|
|
print("", flush=True)
|
|
if not FreeCAD.GuiUp:
|
|
print(
|
|
"Note: Screenshot and view features are not available in headless mode.",
|
|
flush=True,
|
|
)
|
|
print("Press Ctrl+C to stop.", flush=True)
|
|
print("=" * 60, flush=True)
|
|
print("", flush=True)
|
|
|
|
# Run forever (blocks until Ctrl+C)
|
|
# Plugin is guaranteed non-None at this point
|
|
plugin.run_forever()
|