forkless/freecad-robust-mcp-fc111
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0d1eccb315b0a4d43f266a63cec9bb8e4e03a278
freecad-robust-mcp-fc111/latest/USER_GUIDE/index.html
T

97 lines
78 KiB
HTML
Raw Blame History

<!DOCTYPE html><html lang="en" class="no-js"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="description" content="FreeCAD Robust MCP Suite - MCP Server, Bridge Workbench, and Macros for AI assistant integration"><link href="https://github.com/spkane/freecad-addon-robust-mcp-server/latest/USER_GUIDE/" rel="canonical"><link href="../guide/resources/" rel="prev"><link href="../MCP_TOOLS_REFERENCE/" rel="next"><link rel="icon" href="../assets/images/favicon.png"><meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>Detailed User Guide - FreeCAD Robust MCP Suite</title><link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css"><link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel="stylesheet" href="../css/timeago.css"><link rel="stylesheet" href="../assets/_mkdocstrings.css"><script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"><script src="../assets/javascripts/glightbox.min.js"></script><style id="glightbox-style">
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: white; }
.gscrollbar-fixer { padding-right: 15px; }
.gdesc-inner { font-size: 0.75rem; }
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color); }
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color); }
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color); }
</style></head> <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="purple"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#freecad-robust-mcp-user-guide" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <div data-md-color-scheme="default" data-md-component="outdated" hidden> </div> <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href=".." title="FreeCAD Robust MCP Suite" class="md-header__button md-logo" aria-label="FreeCAD Robust MCP Suite" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"></path></svg> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> FreeCAD Robust MCP Suite </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> Detailed User Guide </span> </div> </div> </div> <form class="md-header__option" data-md-component="palette"> <input class="md-option" data-md-color-media data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0"> <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg> </label> <input class="md-option" data-md-color-media data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1"> <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> <label class="md-search__icon md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg> </label> <nav class="md-search__options" aria-label="Search"> <a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text data-md-component="search-share" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"></path></svg> </a> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg> </button> </nav> <div class="md-search__suggest" data-md-component="search-suggest"></div> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a href="https://github.com/spkane/freecad-addon-robust-mcp-server" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"></path></svg> </div> <div class="md-source__repository"> spkane/freecad-addon-robust-mcp-server </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a href=".." class="md-tabs__link"> Home </a> </li> <li class="md-tabs__item"> <a href="../getting-started/installation/" class="md-tabs__link"> Getting Started </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../guide/connection-modes/" class="md-tabs__link"> User Guide </a> </li> <li class="md-tabs__item"> <a href="../COMPARISON/" class="md-tabs__link"> Comparisons </a> </li> <li class="md-tabs__item"> <a href="../api/server/" class="md-tabs__link"> API Reference </a> </li> <li class="md-tabs__item"> <a href="../development/contributing/" class="md-tabs__link"> Development </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href=".." title="FreeCAD Robust MCP Suite" class="md-nav__button md-logo" aria-label="FreeCAD Robust MCP Suite" data-md-component="logo"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"></path></svg> </a> FreeCAD Robust MCP Suite </label> <div class="md-nav__source"> <a href="https://github.com/spkane/freecad-addon-robust-mcp-server" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"></path></svg> </div> <div class="md-source__repository"> spkane/freecad-addon-robust-mcp-server </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href=".." class="md-nav__link"> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2"> <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> <span class="md-ellipsis"> Getting Started </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../getting-started/installation/" class="md-nav__link"> <span class="md-ellipsis"> Installation </span> </a> </li> <li class="md-nav__item"> <a href="../getting-started/configuration/" class="md-nav__link"> <span class="md-ellipsis"> Configuration </span> </a> </li> <li class="md-nav__item"> <a href="../getting-started/quickstart/" class="md-nav__link"> <span class="md-ellipsis"> Quick Start </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked> <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex> <span class="md-ellipsis"> User Guide </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_3"> <span class="md-nav__icon md-icon"></span> User Guide </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../guide/connection-modes/" class="md-nav__link"> <span class="md-ellipsis"> Connection Modes </span> </a> </li> <li class="md-nav__item"> <a href="../guide/workbench/" class="md-nav__link"> <span class="md-ellipsis"> Robust MCP Bridge Workbench </span> </a> </li> <li class="md-nav__item"> <a href="../guide/macros/" class="md-nav__link"> <span class="md-ellipsis"> MCP Macro Tools </span> </a> </li> <li class="md-nav__item"> <a href="../guide/tools/" class="md-nav__link"> <span class="md-ellipsis"> Tools Overview </span> </a> </li> <li class="md-nav__item"> <a href="../guide/resources/" class="md-nav__link"> <span class="md-ellipsis"> MCP Resources </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> <span class="md-ellipsis"> Detailed User Guide </span> <span class="md-nav__icon md-icon"></span> </label> <a href="./" class="md-nav__link md-nav__link--active"> <span class="md-ellipsis"> Detailed User Guide </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#table-of-contents" class="md-nav__link"> <span class="md-ellipsis"> Table of Contents </span> </a> </li> <li class="md-nav__item"> <a href="#getting-started" class="md-nav__link"> <span class="md-ellipsis"> Getting Started </span> </a> <nav class="md-nav" aria-label="Getting Started"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#prerequisites" class="md-nav__link"> <span class="md-ellipsis"> Prerequisites </span> </a> </li> <li class="md-nav__item"> <a href="#starting-freecad-with-mcp-bridge" class="md-nav__link"> <span class="md-ellipsis"> Starting FreeCAD with MCP Bridge </span> </a> </li> <li class="md-nav__item"> <a href="#verifying-connection" class="md-nav__link"> <span class="md-ellipsis"> Verifying Connection </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#running-modes" class="md-nav__link"> <span class="md-ellipsis"> Running Modes </span> </a> <nav class="md-nav" aria-label="Running Modes"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#headless-vs-gui-mode" class="md-nav__link"> <span class="md-ellipsis"> Headless vs GUI Mode </span> </a> </li> <li class="md-nav__item"> <a href="#detecting-the-current-mode" class="md-nav__link"> <span class="md-ellipsis"> Detecting the Current Mode </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#basic-workflows" class="md-nav__link"> <span class="md-ellipsis"> Basic Workflows </span> </a> <nav class="md-nav" aria-label="Basic Workflows"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#creating-a-document" class="md-nav__link"> <span class="md-ellipsis"> Creating a Document </span> </a> </li> <li class="md-nav__item"> <a href="#creating-simple-shapes" class="md-nav__link"> <span class="md-ellipsis"> Creating Simple Shapes </span> </a> </li> <li class="md-nav__item"> <a href="#positioning-objects" class="md-nav__link"> <span class="md-ellipsis"> Positioning Objects </span> </a> </li> <li class="md-nav__item"> <a href="#boolean-operations" class="md-nav__link"> <span class="md-ellipsis"> Boolean Operations </span> </a> </li> <li class="md-nav__item"> <a href="#saving-and-exporting" class="md-nav__link"> <span class="md-ellipsis"> Saving and Exporting </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#object-creation-examples" class="md-nav__link"> <span class="md-ellipsis"> Object Creation Examples </span> </a> <nav class="md-nav" aria-label="Object Creation Examples"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#example-1-simple-box-with-hole" class="md-nav__link"> <span class="md-ellipsis"> Example 1: Simple Box with Hole </span> </a> </li> <li class="md-nav__item"> <a href="#example-2-pipetube-shape" class="md-nav__link"> <span class="md-ellipsis"> Example 2: Pipe/Tube Shape </span> </a> </li> <li class="md-nav__item"> <a href="#example-3-l-bracket" class="md-nav__link"> <span class="md-ellipsis"> Example 3: L-Bracket </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#partdesign-workflow" class="md-nav__link"> <span class="md-ellipsis"> PartDesign Workflow </span> </a> <nav class="md-nav" aria-label="PartDesign Workflow"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#understanding-partdesign-concepts" class="md-nav__link"> <span class="md-ellipsis"> Understanding PartDesign Concepts </span> </a> </li> <li class="md-nav__item"> <a href="#basic-partdesign-example" class="md-nav__link"> <span class="md-ellipsis"> Basic PartDesign Example </span> </a> </li> <li class="md-nav__item"> <a href="#revolving-profiles" class="md-nav__link"> <span class="md-ellipsis"> Revolving Profiles </span> </a> </li> <li class="md-nav__item"> <a href="#pattern-operations" class="md-nav__link"> <span class="md-ellipsis"> Pattern Operations </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#complete-example-mounting-bracket" class="md-nav__link"> <span class="md-ellipsis"> Complete Example: Mounting Bracket </span> </a> <nav class="md-nav" aria-label="Complete Example: Mounting Bracket"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#design-requirements" class="md-nav__link"> <span class="md-ellipsis"> Design Requirements </span> </a> </li> <li class="md-nav__item"> <a href="#step-by-step-workflow" class="md-nav__link"> <span class="md-ellipsis"> Step-by-Step Workflow </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#tips-and-best-practices" class="md-nav__link"> <span class="md-ellipsis"> Tips and Best Practices </span> </a> <nav class="md-nav" aria-label="Tips and Best Practices"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#1-be-specific-with-dimensions" class="md-nav__link"> <span class="md-ellipsis"> 1. Be Specific with Dimensions </span> </a> </li> <li class="md-nav__item"> <a href="#2-specify-units" class="md-nav__link"> <span class="md-ellipsis"> 2. Specify Units </span> </a> </li> <li class="md-nav__item"> <a href="#3-use-meaningful-names" class="md-nav__link"> <span class="md-ellipsis"> 3. Use Meaningful Names </span> </a> </li> <li class="md-nav__item"> <a href="#4-work-incrementally" class="md-nav__link"> <span class="md-ellipsis"> 4. Work Incrementally </span> </a> </li> <li class="md-nav__item"> <a href="#5-save-frequently" class="md-nav__link"> <span class="md-ellipsis"> 5. Save Frequently </span> </a> </li> <li class="md-nav__item"> <a href="#6-use-partdesign-for-parametric-parts" class="md-nav__link"> <span class="md-ellipsis"> 6. Use PartDesign for Parametric Parts </span> </a> </li> <li class="md-nav__item"> <a href="#7-export-to-multiple-formats" class="md-nav__link"> <span class="md-ellipsis"> 7. Export to Multiple Formats </span> </a> </li> <li class="md-nav__item"> <a href="#8-use-the-execute_python-tool-for-advanced-operations" class="md-nav__link"> <span class="md-ellipsis"> 8. Use the execute_python Tool for Advanced Operations </span> </a> </li> <li class="md-nav__item"> <a href="#9-check-gui-mode-for-visual-features" class="md-nav__link"> <span class="md-ellipsis"> 9. Check GUI Mode for Visual Features </span> </a> </li> <li class="md-nav__item"> <a href="#10-use-patterns-for-repetitive-features" class="md-nav__link"> <span class="md-ellipsis"> 10. Use Patterns for Repetitive Features </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#common-operations-quick-reference" class="md-nav__link"> <span class="md-ellipsis"> Common Operations Quick Reference </span> </a> </li> <li class="md-nav__item"> <a href="#troubleshooting" class="md-nav__link"> <span class="md-ellipsis"> Troubleshooting </span> </a> <nav class="md-nav" aria-label="Troubleshooting"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#gui-not-available-error" class="md-nav__link"> <span class="md-ellipsis"> "GUI not available" Error </span> </a> </li> <li class="md-nav__item"> <a href="#objects-not-appearing" class="md-nav__link"> <span class="md-ellipsis"> Objects Not Appearing </span> </a> </li> <li class="md-nav__item"> <a href="#boolean-operations-failing" class="md-nav__link"> <span class="md-ellipsis"> Boolean Operations Failing </span> </a> </li> <li class="md-nav__item"> <a href="#sketch-errors" class="md-nav__link"> <span class="md-ellipsis"> Sketch Errors </span> </a> </li> <li class="md-nav__item"> <a href="#connection-issues" class="md-nav__link"> <span class="md-ellipsis"> Connection Issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#next-steps" class="md-nav__link"> <span class="md-ellipsis"> Next Steps </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../MCP_TOOLS_REFERENCE/" class="md-nav__link"> <span class="md-ellipsis"> Tools Reference </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4"> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0"> <span class="md-ellipsis"> Comparisons </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4"> <span class="md-nav__icon md-icon"></span> Comparisons </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../COMPARISON/" class="md-nav__link"> <span class="md-ellipsis"> Other Implementations </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5"> <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0"> <span class="md-ellipsis"> API Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5"> <span class="md-nav__icon md-icon"></span> API Reference </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../api/server/" class="md-nav__link"> <span class="md-ellipsis"> Server </span> </a> </li> <li class="md-nav__item"> <a href="../api/bridge/" class="md-nav__link"> <span class="md-ellipsis"> Bridge </span> </a> </li> <li class="md-nav__item"> <a href="../api/config/" class="md-nav__link"> <span class="md-ellipsis"> Config </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6"> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0"> <span class="md-ellipsis"> Development </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_6"> <span class="md-nav__icon md-icon"></span> Development </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../development/contributing/" class="md-nav__link"> <span class="md-ellipsis"> Contributing </span> </a> </li> <li class="md-nav__item"> <a href="../development/architecture/" class="md-nav__link"> <span class="md-ellipsis"> Architecture </span> </a> </li> <li class="md-nav__item"> <a href="../development/architecture-detailed/" class="md-nav__link"> <span class="md-ellipsis"> Detailed Architecture </span> </a> </li> <li class="md-nav__item"> <a href="../development/releasing/" class="md-nav__link"> <span class="md-ellipsis"> Release Process </span> </a> </li> <li class="md-nav__item"> <a href="../development/mkdocs-guide/" class="md-nav__link"> <span class="md-ellipsis"> MkDocs Guide </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#table-of-contents" class="md-nav__link"> <span class="md-ellipsis"> Table of Contents </span> </a> </li> <li class="md-nav__item"> <a href="#getting-started" class="md-nav__link"> <span class="md-ellipsis"> Getting Started </span> </a> <nav class="md-nav" aria-label="Getting Started"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#prerequisites" class="md-nav__link"> <span class="md-ellipsis"> Prerequisites </span> </a> </li> <li class="md-nav__item"> <a href="#starting-freecad-with-mcp-bridge" class="md-nav__link"> <span class="md-ellipsis"> Starting FreeCAD with MCP Bridge </span> </a> </li> <li class="md-nav__item"> <a href="#verifying-connection" class="md-nav__link"> <span class="md-ellipsis"> Verifying Connection </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#running-modes" class="md-nav__link"> <span class="md-ellipsis"> Running Modes </span> </a> <nav class="md-nav" aria-label="Running Modes"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#headless-vs-gui-mode" class="md-nav__link"> <span class="md-ellipsis"> Headless vs GUI Mode </span> </a> </li> <li class="md-nav__item"> <a href="#detecting-the-current-mode" class="md-nav__link"> <span class="md-ellipsis"> Detecting the Current Mode </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#basic-workflows" class="md-nav__link"> <span class="md-ellipsis"> Basic Workflows </span> </a> <nav class="md-nav" aria-label="Basic Workflows"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#creating-a-document" class="md-nav__link"> <span class="md-ellipsis"> Creating a Document </span> </a> </li> <li class="md-nav__item"> <a href="#creating-simple-shapes" class="md-nav__link"> <span class="md-ellipsis"> Creating Simple Shapes </span> </a> </li> <li class="md-nav__item"> <a href="#positioning-objects" class="md-nav__link"> <span class="md-ellipsis"> Positioning Objects </span> </a> </li> <li class="md-nav__item"> <a href="#boolean-operations" class="md-nav__link"> <span class="md-ellipsis"> Boolean Operations </span> </a> </li> <li class="md-nav__item"> <a href="#saving-and-exporting" class="md-nav__link"> <span class="md-ellipsis"> Saving and Exporting </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#object-creation-examples" class="md-nav__link"> <span class="md-ellipsis"> Object Creation Examples </span> </a> <nav class="md-nav" aria-label="Object Creation Examples"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#example-1-simple-box-with-hole" class="md-nav__link"> <span class="md-ellipsis"> Example 1: Simple Box with Hole </span> </a> </li> <li class="md-nav__item"> <a href="#example-2-pipetube-shape" class="md-nav__link"> <span class="md-ellipsis"> Example 2: Pipe/Tube Shape </span> </a> </li> <li class="md-nav__item"> <a href="#example-3-l-bracket" class="md-nav__link"> <span class="md-ellipsis"> Example 3: L-Bracket </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#partdesign-workflow" class="md-nav__link"> <span class="md-ellipsis"> PartDesign Workflow </span> </a> <nav class="md-nav" aria-label="PartDesign Workflow"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#understanding-partdesign-concepts" class="md-nav__link"> <span class="md-ellipsis"> Understanding PartDesign Concepts </span> </a> </li> <li class="md-nav__item"> <a href="#basic-partdesign-example" class="md-nav__link"> <span class="md-ellipsis"> Basic PartDesign Example </span> </a> </li> <li class="md-nav__item"> <a href="#revolving-profiles" class="md-nav__link"> <span class="md-ellipsis"> Revolving Profiles </span> </a> </li> <li class="md-nav__item"> <a href="#pattern-operations" class="md-nav__link"> <span class="md-ellipsis"> Pattern Operations </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#complete-example-mounting-bracket" class="md-nav__link"> <span class="md-ellipsis"> Complete Example: Mounting Bracket </span> </a> <nav class="md-nav" aria-label="Complete Example: Mounting Bracket"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#design-requirements" class="md-nav__link"> <span class="md-ellipsis"> Design Requirements </span> </a> </li> <li class="md-nav__item"> <a href="#step-by-step-workflow" class="md-nav__link"> <span class="md-ellipsis"> Step-by-Step Workflow </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#tips-and-best-practices" class="md-nav__link"> <span class="md-ellipsis"> Tips and Best Practices </span> </a> <nav class="md-nav" aria-label="Tips and Best Practices"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#1-be-specific-with-dimensions" class="md-nav__link"> <span class="md-ellipsis"> 1. Be Specific with Dimensions </span> </a> </li> <li class="md-nav__item"> <a href="#2-specify-units" class="md-nav__link"> <span class="md-ellipsis"> 2. Specify Units </span> </a> </li> <li class="md-nav__item"> <a href="#3-use-meaningful-names" class="md-nav__link"> <span class="md-ellipsis"> 3. Use Meaningful Names </span> </a> </li> <li class="md-nav__item"> <a href="#4-work-incrementally" class="md-nav__link"> <span class="md-ellipsis"> 4. Work Incrementally </span> </a> </li> <li class="md-nav__item"> <a href="#5-save-frequently" class="md-nav__link"> <span class="md-ellipsis"> 5. Save Frequently </span> </a> </li> <li class="md-nav__item"> <a href="#6-use-partdesign-for-parametric-parts" class="md-nav__link"> <span class="md-ellipsis"> 6. Use PartDesign for Parametric Parts </span> </a> </li> <li class="md-nav__item"> <a href="#7-export-to-multiple-formats" class="md-nav__link"> <span class="md-ellipsis"> 7. Export to Multiple Formats </span> </a> </li> <li class="md-nav__item"> <a href="#8-use-the-execute_python-tool-for-advanced-operations" class="md-nav__link"> <span class="md-ellipsis"> 8. Use the execute_python Tool for Advanced Operations </span> </a> </li> <li class="md-nav__item"> <a href="#9-check-gui-mode-for-visual-features" class="md-nav__link"> <span class="md-ellipsis"> 9. Check GUI Mode for Visual Features </span> </a> </li> <li class="md-nav__item"> <a href="#10-use-patterns-for-repetitive-features" class="md-nav__link"> <span class="md-ellipsis"> 10. Use Patterns for Repetitive Features </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#common-operations-quick-reference" class="md-nav__link"> <span class="md-ellipsis"> Common Operations Quick Reference </span> </a> </li> <li class="md-nav__item"> <a href="#troubleshooting" class="md-nav__link"> <span class="md-ellipsis"> Troubleshooting </span> </a> <nav class="md-nav" aria-label="Troubleshooting"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#gui-not-available-error" class="md-nav__link"> <span class="md-ellipsis"> "GUI not available" Error </span> </a> </li> <li class="md-nav__item"> <a href="#objects-not-appearing" class="md-nav__link"> <span class="md-ellipsis"> Objects Not Appearing </span> </a> </li> <li class="md-nav__item"> <a href="#boolean-operations-failing" class="md-nav__link"> <span class="md-ellipsis"> Boolean Operations Failing </span> </a> </li> <li class="md-nav__item"> <a href="#sketch-errors" class="md-nav__link"> <span class="md-ellipsis"> Sketch Errors </span> </a> </li> <li class="md-nav__item"> <a href="#connection-issues" class="md-nav__link"> <span class="md-ellipsis"> Connection Issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#next-steps" class="md-nav__link"> <span class="md-ellipsis"> Next Steps </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="freecad-robust-mcp-user-guide">FreeCAD Robust MCP User Guide<a class="headerlink" href="#freecad-robust-mcp-user-guide" title="Permanent link"></a></h1> <p>This guide explains how to use AI assistants with FreeCAD via the MCP (Model Context Protocol) server to create and manipulate 3D CAD models.</p> <hr> <h2 id="table-of-contents">Table of Contents<a class="headerlink" href="#table-of-contents" title="Permanent link"></a></h2> <ol> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#running-modes">Running Modes</a></li> <li><a href="#basic-workflows">Basic Workflows</a></li> <li><a href="#object-creation-examples">Object Creation Examples</a></li> <li><a href="#partdesign-workflow">PartDesign Workflow</a></li> <li><a href="#complete-example-mounting-bracket">Complete Example: Mounting Bracket</a></li> <li><a href="#tips-and-best-practices">Tips and Best Practices</a></li> </ol> <hr> <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link"></a></h2> <h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link"></a></h3> <ol> <li><strong>FreeCAD installed</strong> - Version 1.0.x or later</li> <li><strong>An MCP client</strong> (Claude Code, or other MCP-compatible AI assistant) configured</li> <li><strong>Python 3.11</strong> - Must match FreeCAD's bundled Python version</li> </ol> <h3 id="starting-freecad-with-mcp-bridge">Starting FreeCAD with MCP Bridge<a class="headerlink" href="#starting-freecad-with-mcp-bridge" title="Permanent link"></a></h3> <p>You have two options depending on your workflow:</p> <h4 id="headless-mode-command-line-only">Headless Mode (Command-line only)<a class="headerlink" href="#headless-mode-command-line-only" title="Permanent link"></a></h4> <p>Best for automated workflows, batch processing, or when you don't need visual feedback.</p> <div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>just<span class="w"> </span>freecad::run-headless
</span></code></pre></div> <p><strong>Capabilities:</strong> All modeling operations, export, scripting. <strong>Limitations:</strong> No screenshots, no visual feedback, no color/visibility control.</p> <h4 id="gui-mode-full-graphical-interface">GUI Mode (Full graphical interface)<a class="headerlink" href="#gui-mode-full-graphical-interface" title="Permanent link"></a></h4> <p>Best for interactive design work where you want to see results visually.</p> <div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>just<span class="w"> </span>freecad::run-gui
</span></code></pre></div> <p><strong>Capabilities:</strong> Everything headless mode can do, plus screenshots, colors, view control.</p> <h3 id="verifying-connection">Verifying Connection<a class="headerlink" href="#verifying-connection" title="Permanent link"></a></h3> <p>Once FreeCAD is running with the MCP bridge, you can verify the connection:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>"Check the FreeCAD connection status"
</span></code></pre></div> <p>Claude will use the <code>get_connection_status</code> tool to confirm the bridge is working.</p> <hr> <h2 id="running-modes">Running Modes<a class="headerlink" href="#running-modes" title="Permanent link"></a></h2> <h3 id="headless-vs-gui-mode">Headless vs GUI Mode<a class="headerlink" href="#headless-vs-gui-mode" title="Permanent link"></a></h3> <table> <thead> <tr> <th>Feature</th> <th>Headless Mode</th> <th>GUI Mode</th> </tr> </thead> <tbody> <tr> <td>Object creation</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Boolean operations</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Export (STEP, STL, etc.)</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Save documents</td> <td>Yes</td> <td>Yes</td> </tr> <tr> <td>Screenshots</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Object colors</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Object visibility</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Camera control</td> <td>No</td> <td>Yes</td> </tr> <tr> <td>Interactive selection</td> <td>No</td> <td>Yes</td> </tr> </tbody> </table> <h3 id="detecting-the-current-mode">Detecting the Current Mode<a class="headerlink" href="#detecting-the-current-mode" title="Permanent link"></a></h3> <p>When working with Claude, it will automatically detect whether FreeCAD is in GUI or headless mode and adapt accordingly. GUI-only operations will return informative errors in headless mode rather than crashing.</p> <hr> <h2 id="basic-workflows">Basic Workflows<a class="headerlink" href="#basic-workflows" title="Permanent link"></a></h2> <h3 id="creating-a-document">Creating a Document<a class="headerlink" href="#creating-a-document" title="Permanent link"></a></h3> <p>Every FreeCAD project needs a document. You can ask Claude:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>"Create a new FreeCAD document called 'MyProject'"
</span></code></pre></div> <p>Claude will use the <code>create_document</code> tool.</p> <h3 id="creating-simple-shapes">Creating Simple Shapes<a class="headerlink" href="#creating-simple-shapes" title="Permanent link"></a></h3> <p>Ask Claude to create primitive shapes:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>"Create a box that's 50mm long, 30mm wide, and 10mm tall"
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>"Add a cylinder with radius 5mm and height 20mm"
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>"Create a sphere with 15mm radius"
</span></code></pre></div> <h3 id="positioning-objects">Positioning Objects<a class="headerlink" href="#positioning-objects" title="Permanent link"></a></h3> <p>Move and rotate objects:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>"Move the box to position (100, 50, 0)"
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>"Rotate the cylinder 45 degrees around the Z axis"
</span></code></pre></div> <h3 id="boolean-operations">Boolean Operations<a class="headerlink" href="#boolean-operations" title="Permanent link"></a></h3> <p>Combine shapes:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>"Fuse the box and cylinder together"
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>"Cut a hole through the box using the cylinder"
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>"Find the intersection of the two shapes"
</span></code></pre></div> <h3 id="saving-and-exporting">Saving and Exporting<a class="headerlink" href="#saving-and-exporting" title="Permanent link"></a></h3> <div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>"Save the document as MyProject.FCStd"
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>"Export the model to STEP format"
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>"Export for 3D printing as STL"
</span></code></pre></div> <hr> <h2 id="object-creation-examples">Object Creation Examples<a class="headerlink" href="#object-creation-examples" title="Permanent link"></a></h2> <h3 id="example-1-simple-box-with-hole">Example 1: Simple Box with Hole<a class="headerlink" href="#example-1-simple-box-with-hole" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>Create a 50x50x20mm box with a 10mm diameter hole through the center.
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li>Creates a document</li> <li>Creates a box (50x50x20)</li> <li>Creates a cylinder (radius 5, height 30) positioned at center</li> <li>Performs boolean cut operation</li> <li>Returns the result</li> </ol> <h3 id="example-2-pipetube-shape">Example 2: Pipe/Tube Shape<a class="headerlink" href="#example-2-pipetube-shape" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>Create a pipe with outer diameter 40mm, inner diameter 30mm, and length 100mm.
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li>Creates outer cylinder (radius 20, height 100)</li> <li>Creates inner cylinder (radius 15, height 100)</li> <li>Cuts inner from outer to create hollow tube</li> </ol> <h3 id="example-3-l-bracket">Example 3: L-Bracket<a class="headerlink" href="#example-3-l-bracket" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>Create an L-shaped bracket:
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>- Horizontal part: 100mm x 50mm x 5mm
</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>- Vertical part: 5mm x 50mm x 80mm standing on the horizontal part
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li>Creates horizontal box</li> <li>Creates vertical box positioned at correct location</li> <li>Fuses them together</li> </ol> <hr> <h2 id="partdesign-workflow">PartDesign Workflow<a class="headerlink" href="#partdesign-workflow" title="Permanent link"></a></h2> <p>For parametric modeling that maintains design history, use the PartDesign workflow.</p> <h3 id="understanding-partdesign-concepts">Understanding PartDesign Concepts<a class="headerlink" href="#understanding-partdesign-concepts" title="Permanent link"></a></h3> <p><strong>Body</strong>: A container for a single solid model built from features.</p> <p><strong>Sketch</strong>: A 2D drawing that defines profiles for 3D operations.</p> <p><strong>Features</strong>: Operations like Pad (extrude), Pocket (cut), Fillet, etc.</p> <h3 id="basic-partdesign-example">Basic PartDesign Example<a class="headerlink" href="#basic-partdesign-example" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>Create a parametric mounting plate:
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>1. Start with a PartDesign body
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>2. Create a sketch on the XY plane with a 100x60mm rectangle
</span><span id="__span-11-4"><a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a>3. Pad it 8mm thick
</span><span id="__span-11-5"><a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a>4. Add four 5mm holes near each corner for mounting screws
</span><span id="__span-11-6"><a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a>5. Fillet all edges with 2mm radius
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li><code>create_partdesign_body()</code> - Creates the Body container</li> <li><code>create_sketch(body_name="Body", plane="XY_Plane")</code> - Creates attached sketch</li> <li><code>add_sketch_rectangle(...)</code> - Adds the profile geometry</li> <li><code>pad_sketch(sketch_name="Sketch", length=8)</code> - Extrudes to solid</li> <li>Creates new sketches with points for hole locations</li> <li><code>create_hole(...)</code> for each mounting hole</li> <li><code>fillet_edges(...)</code> - Rounds the edges</li> </ol> <h3 id="revolving-profiles">Revolving Profiles<a class="headerlink" href="#revolving-profiles" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>Create a turned part:
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a>- Draw a profile on the XZ plane
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>- Revolve it 360 degrees around the X axis
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li>Creates body and sketch on XZ plane</li> <li>Draws the profile using lines and arcs</li> <li>Uses <code>revolution_sketch()</code> to create the solid</li> </ol> <h3 id="pattern-operations">Pattern Operations<a class="headerlink" href="#pattern-operations" title="Permanent link"></a></h3> <p><strong>Request:</strong></p> <div class="language-text highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>Create a plate with a row of 6 holes spaced 15mm apart.
</span></code></pre></div> <p><strong>What Claude does:</strong></p> <ol> <li>Creates the base plate</li> <li>Creates one hole feature</li> <li>Uses <code>linear_pattern()</code> to repeat the hole</li> </ol> <hr> <h2 id="complete-example-mounting-bracket">Complete Example: Mounting Bracket<a class="headerlink" href="#complete-example-mounting-bracket" title="Permanent link"></a></h2> <p>This detailed example shows a complete workflow for creating a practical part.</p> <h3 id="design-requirements">Design Requirements<a class="headerlink" href="#design-requirements" title="Permanent link"></a></h3> <p>Create a mounting bracket with:</p> <ul> <li>Base plate: 80mm x 60mm x 5mm</li> <li>Vertical support: 5mm thick, 50mm tall, 60mm wide</li> <li>Two mounting holes (6mm diameter) on the base</li> <li>One slot (10mm x 20mm) on the vertical support</li> <li>3mm fillets on external corners</li> </ul> <h3 id="step-by-step-workflow">Step-by-Step Workflow<a class="headerlink" href="#step-by-step-workflow" title="Permanent link"></a></h3> <h4 id="step-1-ask-claude-to-create-the-bracket">Step 1: Ask Claude to create the bracket<a class="headerlink" href="#step-1-ask-claude-to-create-the-bracket" title="Permanent link"></a></h4> <div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>Create a mounting bracket with the following specifications:
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>Base plate:
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a>- Size: 80mm x 60mm x 5mm
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>- Two 6mm diameter mounting holes, centered 15mm from each short edge
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a>
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a>Vertical support:
</span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a>- Attached to one end of the base
</span><span id="__span-14-9"><a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a>- 5mm thick, 60mm wide, 50mm tall
</span><span id="__span-14-10"><a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a>- One slot: 10mm wide x 20mm tall, centered
</span><span id="__span-14-11"><a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a>
</span><span id="__span-14-12"><a id="__codelineno-14-12" name="__codelineno-14-12" href="#__codelineno-14-12"></a>Finish:
</span><span id="__span-14-13"><a id="__codelineno-14-13" name="__codelineno-14-13" href="#__codelineno-14-13"></a>- 3mm fillet on all outer edges
</span><span id="__span-14-14"><a id="__codelineno-14-14" name="__codelineno-14-14" href="#__codelineno-14-14"></a>- Export as STEP file when done
</span></code></pre></div> <h4 id="step-2-claudes-approach">Step 2: Claude's approach<a class="headerlink" href="#step-2-claudes-approach" title="Permanent link"></a></h4> <p>Claude will break this down into manageable operations:</p> <div class="language-python highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="c1"># 1. Create document and PartDesign body</span>
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="n">create_document</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"MountingBracket"</span><span class="p">)</span>
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">create_partdesign_body</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"Body"</span><span class="p">)</span>
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="c1"># 2. Create base plate sketch and pad</span>
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">create_sketch</span><span class="p">(</span><span class="n">body_name</span><span class="o">=</span><span class="s2">"Body"</span><span class="p">,</span> <span class="n">plane</span><span class="o">=</span><span class="s2">"XY_Plane"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"BaseSketch"</span><span class="p">)</span>
</span><span id="__span-15-7"><a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a><span class="n">add_sketch_rectangle</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"BaseSketch"</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
</span><span id="__span-15-8"><a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="n">pad_sketch</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"BaseSketch"</span><span class="p">,</span> <span class="n">length</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
</span><span id="__span-15-9"><a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a>
</span><span id="__span-15-10"><a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a><span class="c1"># 3. Add vertical support</span>
</span><span id="__span-15-11"><a id="__codelineno-15-11" name="__codelineno-15-11" href="#__codelineno-15-11"></a><span class="n">create_sketch</span><span class="p">(</span><span class="n">body_name</span><span class="o">=</span><span class="s2">"Body"</span><span class="p">,</span> <span class="n">plane</span><span class="o">=</span><span class="s2">"XZ_Plane"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"SupportSketch"</span><span class="p">)</span>
</span><span id="__span-15-12"><a id="__codelineno-15-12" name="__codelineno-15-12" href="#__codelineno-15-12"></a><span class="c1"># ... add geometry</span>
</span><span id="__span-15-13"><a id="__codelineno-15-13" name="__codelineno-15-13" href="#__codelineno-15-13"></a><span class="n">pad_sketch</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"SupportSketch"</span><span class="p">,</span> <span class="n">length</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
</span><span id="__span-15-14"><a id="__codelineno-15-14" name="__codelineno-15-14" href="#__codelineno-15-14"></a>
</span><span id="__span-15-15"><a id="__codelineno-15-15" name="__codelineno-15-15" href="#__codelineno-15-15"></a><span class="c1"># 4. Add mounting holes</span>
</span><span id="__span-15-16"><a id="__codelineno-15-16" name="__codelineno-15-16" href="#__codelineno-15-16"></a><span class="n">create_sketch</span><span class="p">(</span><span class="n">body_name</span><span class="o">=</span><span class="s2">"Body"</span><span class="p">,</span> <span class="n">plane</span><span class="o">=</span><span class="s2">"XY_Plane"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"HoleSketch"</span><span class="p">)</span>
</span><span id="__span-15-17"><a id="__codelineno-15-17" name="__codelineno-15-17" href="#__codelineno-15-17"></a><span class="n">add_sketch_point</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"HoleSketch"</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">30</span><span class="p">)</span>
</span><span id="__span-15-18"><a id="__codelineno-15-18" name="__codelineno-15-18" href="#__codelineno-15-18"></a><span class="n">add_sketch_point</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"HoleSketch"</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">65</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">30</span><span class="p">)</span>
</span><span id="__span-15-19"><a id="__codelineno-15-19" name="__codelineno-15-19" href="#__codelineno-15-19"></a><span class="n">create_hole</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"HoleSketch"</span><span class="p">,</span> <span class="n">diameter</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">hole_type</span><span class="o">=</span><span class="s2">"ThroughAll"</span><span class="p">)</span>
</span><span id="__span-15-20"><a id="__codelineno-15-20" name="__codelineno-15-20" href="#__codelineno-15-20"></a>
</span><span id="__span-15-21"><a id="__codelineno-15-21" name="__codelineno-15-21" href="#__codelineno-15-21"></a><span class="c1"># 5. Add slot (as pocket)</span>
</span><span id="__span-15-22"><a id="__codelineno-15-22" name="__codelineno-15-22" href="#__codelineno-15-22"></a><span class="n">create_sketch</span><span class="p">(</span><span class="n">body_name</span><span class="o">=</span><span class="s2">"Body"</span><span class="p">,</span> <span class="n">plane</span><span class="o">=</span><span class="s2">"Face..."</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"SlotSketch"</span><span class="p">)</span>
</span><span id="__span-15-23"><a id="__codelineno-15-23" name="__codelineno-15-23" href="#__codelineno-15-23"></a><span class="n">add_sketch_rectangle</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
</span><span id="__span-15-24"><a id="__codelineno-15-24" name="__codelineno-15-24" href="#__codelineno-15-24"></a><span class="n">pocket_sketch</span><span class="p">(</span><span class="n">sketch_name</span><span class="o">=</span><span class="s2">"SlotSketch"</span><span class="p">,</span> <span class="n">length</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"ThroughAll"</span><span class="p">)</span>
</span><span id="__span-15-25"><a id="__codelineno-15-25" name="__codelineno-15-25" href="#__codelineno-15-25"></a>
</span><span id="__span-15-26"><a id="__codelineno-15-26" name="__codelineno-15-26" href="#__codelineno-15-26"></a><span class="c1"># 6. Add fillets</span>
</span><span id="__span-15-27"><a id="__codelineno-15-27" name="__codelineno-15-27" href="#__codelineno-15-27"></a><span class="n">fillet_edges</span><span class="p">(</span><span class="n">object_name</span><span class="o">=</span><span class="s2">"..."</span><span class="p">,</span> <span class="n">radius</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
</span><span id="__span-15-28"><a id="__codelineno-15-28" name="__codelineno-15-28" href="#__codelineno-15-28"></a>
</span><span id="__span-15-29"><a id="__codelineno-15-29" name="__codelineno-15-29" href="#__codelineno-15-29"></a><span class="c1"># 7. Export</span>
</span><span id="__span-15-30"><a id="__codelineno-15-30" name="__codelineno-15-30" href="#__codelineno-15-30"></a><span class="n">export_step</span><span class="p">(</span><span class="n">file_path</span><span class="o">=</span><span class="s2">"/path/to/bracket.step"</span><span class="p">)</span>
</span></code></pre></div> <h4 id="step-3-view-the-result-gui-mode">Step 3: View the result (GUI mode)<a class="headerlink" href="#step-3-view-the-result-gui-mode" title="Permanent link"></a></h4> <div class="language-text highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>Take a screenshot of the bracket from an isometric view
</span></code></pre></div> <p>Claude will use <code>get_screenshot(view_angle="Isometric")</code> to capture and display the result.</p> <hr> <h2 id="tips-and-best-practices">Tips and Best Practices<a class="headerlink" href="#tips-and-best-practices" title="Permanent link"></a></h2> <h3 id="1-be-specific-with-dimensions">1. Be Specific with Dimensions<a class="headerlink" href="#1-be-specific-with-dimensions" title="Permanent link"></a></h3> <p><strong>Good:</strong> "Create a box 50mm x 30mm x 10mm"</p> <p><strong>Vague:</strong> "Create a small box"</p> <h3 id="2-specify-units">2. Specify Units<a class="headerlink" href="#2-specify-units" title="Permanent link"></a></h3> <p>FreeCAD uses millimeters by default. Always include units to avoid confusion:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>"Create a cylinder with 25.4mm (1 inch) diameter"
</span></code></pre></div> <h3 id="3-use-meaningful-names">3. Use Meaningful Names<a class="headerlink" href="#3-use-meaningful-names" title="Permanent link"></a></h3> <div class="language-text highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>"Create a box named 'BasePlate' and a cylinder named 'MountingHole'"
</span></code></pre></div> <p>This makes it easier to reference objects later.</p> <h3 id="4-work-incrementally">4. Work Incrementally<a class="headerlink" href="#4-work-incrementally" title="Permanent link"></a></h3> <p>For complex parts, build step by step:</p> <ol> <li>Create the basic shape</li> <li>Verify it looks correct</li> <li>Add features one at a time</li> <li>Check after each major operation</li> </ol> <h3 id="5-save-frequently">5. Save Frequently<a class="headerlink" href="#5-save-frequently" title="Permanent link"></a></h3> <div class="language-text highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>"Save the document"
</span></code></pre></div> <p>FreeCAD can crash, and you don't want to lose work.</p> <h3 id="6-use-partdesign-for-parametric-parts">6. Use PartDesign for Parametric Parts<a class="headerlink" href="#6-use-partdesign-for-parametric-parts" title="Permanent link"></a></h3> <p>If you might need to modify dimensions later, use the PartDesign workflow with sketches rather than direct Part operations.</p> <h3 id="7-export-to-multiple-formats">7. Export to Multiple Formats<a class="headerlink" href="#7-export-to-multiple-formats" title="Permanent link"></a></h3> <p>For manufacturing or 3D printing:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>"Export as STEP for CNC machining and STL for 3D printing"
</span></code></pre></div> <h3 id="8-use-the-execute_python-tool-for-advanced-operations">8. Use the execute_python Tool for Advanced Operations<a class="headerlink" href="#8-use-the-execute_python-tool-for-advanced-operations" title="Permanent link"></a></h3> <p>For operations not covered by the standard tools, Claude can execute custom Python:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>"Calculate the volume and center of mass of the part"
</span></code></pre></div> <p>Claude will use <code>execute_python()</code> to run the necessary FreeCAD Python commands.</p> <h3 id="9-check-gui-mode-for-visual-features">9. Check GUI Mode for Visual Features<a class="headerlink" href="#9-check-gui-mode-for-visual-features" title="Permanent link"></a></h3> <p>Before asking for screenshots or colors:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>"Is FreeCAD running in GUI mode?"
</span></code></pre></div> <h3 id="10-use-patterns-for-repetitive-features">10. Use Patterns for Repetitive Features<a class="headerlink" href="#10-use-patterns-for-repetitive-features" title="Permanent link"></a></h3> <p>Instead of creating many individual features:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>"Create one hole and pattern it in a 4x3 grid with 20mm spacing"
</span></code></pre></div> <hr> <h2 id="common-operations-quick-reference">Common Operations Quick Reference<a class="headerlink" href="#common-operations-quick-reference" title="Permanent link"></a></h2> <table> <thead> <tr> <th>Task</th> <th>How to Ask</th> </tr> </thead> <tbody> <tr> <td>Create box</td> <td>"Create a box 50x30x10mm"</td> </tr> <tr> <td>Create cylinder</td> <td>"Create a cylinder with 10mm radius and 20mm height"</td> </tr> <tr> <td>Move object</td> <td>"Move MyBox to position (100, 50, 0)"</td> </tr> <tr> <td>Rotate object</td> <td>"Rotate MyCylinder 45 degrees around Z axis"</td> </tr> <tr> <td>Boolean union</td> <td>"Fuse Box and Cylinder together"</td> </tr> <tr> <td>Boolean subtract</td> <td>"Cut Cylinder from Box"</td> </tr> <tr> <td>Create hole</td> <td>"Add a 6mm through hole at (25, 15)"</td> </tr> <tr> <td>Fillet edges</td> <td>"Add 3mm fillet to all edges"</td> </tr> <tr> <td>Chamfer edges</td> <td>"Add 2mm chamfer to selected edges"</td> </tr> <tr> <td>Export STEP</td> <td>"Export to STEP format"</td> </tr> <tr> <td>Export STL</td> <td>"Export for 3D printing"</td> </tr> <tr> <td>Save document</td> <td>"Save the document as MyPart.FCStd"</td> </tr> <tr> <td>Screenshot</td> <td>"Take a screenshot from the front view" (GUI mode only)</td> </tr> <tr> <td>Change color</td> <td>"Make the box red" (GUI mode only)</td> </tr> </tbody> </table> <hr> <h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link"></a></h2> <h3 id="gui-not-available-error">"GUI not available" Error<a class="headerlink" href="#gui-not-available-error" title="Permanent link"></a></h3> <p>You're running in headless mode and trying to use a GUI-only feature. Either:</p> <ul> <li>Switch to GUI mode: <code>just freecad::run-gui</code></li> <li>Use an alternative approach (e.g., skip visual operations)</li> </ul> <h3 id="objects-not-appearing">Objects Not Appearing<a class="headerlink" href="#objects-not-appearing" title="Permanent link"></a></h3> <p>Make sure to recompute the document:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>"Recompute the document"
</span></code></pre></div> <h3 id="boolean-operations-failing">Boolean Operations Failing<a class="headerlink" href="#boolean-operations-failing" title="Permanent link"></a></h3> <p>Ensure:</p> <ol> <li>Both objects have valid shapes</li> <li>The objects actually intersect</li> <li>Objects are in the same document</li> </ol> <h3 id="sketch-errors">Sketch Errors<a class="headerlink" href="#sketch-errors" title="Permanent link"></a></h3> <p>Sketches need to be fully constrained for PartDesign operations. Ask Claude to:</p> <div class="language-text highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>"Check if the sketch is fully constrained"
</span></code></pre></div> <h3 id="connection-issues">Connection Issues<a class="headerlink" href="#connection-issues" title="Permanent link"></a></h3> <p>If the MCP bridge isn't responding:</p> <ol> <li>Check FreeCAD is running with the bridge started</li> <li>Verify ports 9875 (XML-RPC) and 9876 (socket) are available</li> <li>Restart FreeCAD with <code>just freecad::run-gui</code> or <code>just freecad::run-headless</code></li> </ol> <hr> <h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link"></a></h2> <ul> <li>See <a href="../MCP_TOOLS_REFERENCE/">MCP_TOOLS_REFERENCE.md</a> for detailed API documentation</li> <li>Explore the FreeCAD wiki for advanced techniques</li> <li>Practice with simple parts before attempting complex assemblies</li> </ul> <aside class="md-source-file"> <span class="md-source-file__fact"> <span class="md-icon" title="Last update"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"></path></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 12, 2026 17:30:05 UTC"><span class="timeago" datetime="2026-01-12T17:30:05+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 12, 2026 17:30:05 UTC">2026-01-12</span> </span> <span class="md-source-file__fact"> <span class="md-icon" title="Created"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"></path></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 4, 2026 00:48:59 UTC"><span class="timeago" datetime="2026-01-04T00:48:59+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 4, 2026 00:48:59 UTC">2026-01-04</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"></path></svg> Back to top </button> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> <div class="md-social"> <a href="https://github.com/spkane/freecad-addon-robust-mcp-server" target="_blank" rel="noopener" title="github.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"></path></svg> </a> <a href="https://hub.docker.com/r/spkane/freecad-robust-mcp" target="_blank" rel="noopener" title="hub.docker.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"></path></svg> </a> <a href="https://pypi.org/project/freecad-robust-mcp/" target="_blank" rel="noopener" title="pypi.org" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6M286.2 444.7a20.4 20.4 0 1 1 0-40.7 20.4 20.4 0 1 1 0 40.7M167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4m-6.6-183.4a20.4 20.4 0 1 1 0 40.8 20.4 20.4 0 1 1 0-40.8"></path></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["content.code.copy", "content.code.annotate", "content.tabs.link", "navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.sections", "navigation.top", "toc.follow", "search.suggest", "search.highlight", "search.share"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src="../assets/javascripts/bundle.79ae519e.min.js"></script> <script src="../js/timeago.min.js"></script> <script src="../js/timeago_mkdocs_material.js"></script> <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
document$.subscribe(()=>{ lightbox.reload(); });
</script></body></html>
Reference in New Issue View Git Blame Copy Permalink