Skip to content
Back to search

formastep

Clean-room parametric 3D CAD engine with SolidWorks/CATIA-style desktop & web studio, ISO 10303-21 STEP validator, DFM auditor, and MCP server

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/eldertek--formastep/badge.svg)](/listings/eldertek--formastep)

HTML

<a href="/listings/eldertek--formastep"><img src="/api/listings/eldertek--formastep/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

git clone https://github.com/eldertek/formastep.git
cd formastep
pip install -e ".[dev]"

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 166 lines
  1. # formastep
  2. Clean-room open-source parametric 3D CAD engine, local offline CAD & DFM Web Studio, ISO 10303-21 STEP inspector/exporter, DFM manufacturability auditor, and Model Context Protocol (MCP) server.
  3. `formastep` compiles parametric solids from strict declarative JSON (`PartSpec`), verifies manifold topology, exports STEP / 3MF / STL / 3-view orthographic SVG drawings, and runs automated Design for Manufacturing (DFM) checks from the GUI (`formastep ui`), CLI, or MCP server with zero proprietary licenses or cloud lock-in.
  4. Live browser demo: [https://eclipse-technology.eu/demos/formastep/](https://eclipse-technology.eu/demos/formastep/)
  5. ![formastep CAD & DFM Studio](docs/assets/studio-desktop-en.png)
  6. ## Documentation
  7. - **English**: [Documentation Home](docs/index.md) | [GUI Studio Guide](docs/gui-guide.md) | [CLI Reference](docs/cli-reference.md) | [MCP Setup](docs/mcp-setup.md)
  8. - **Francais**: [Accueil](docs/fr/index.md) | [Guide Studio GUI](docs/fr/gui-guide.md) | [Reference CLI](docs/fr/cli-reference.md) | [Configuration MCP](docs/fr/mcp-setup.md)
  9. ## Why formastep
  10. Commercial CAD suites charge $299/yr to $2,820+/yr per seat and gate STEP export or headless batch automation behind proprietary desktop licenses. `formastep` gives hardware engineers and automated manufacturing pipelines a deterministic, MIT-licensed toolchain:
  11. - **Zero arbitrary code execution**: declarative Pydantic v2 `PartSpec` schema with an explicit AST arithmetic evaluator for named parameters (zero `eval`, zero `exec`).
  12. - **Offline SolidWorks/CATIA-Style CAD & DFM Workstation (`formastep ui`)**: local loopback GUI (`127.0.0.1:8743`) or standalone desktop window (`--desktop` / `formastep-desktop`) with CommandManager ribbon, FeatureManager Design Tree, PropertyManager, interactive 3D viewport (`Shaded+Edges`, `Shaded`, `Hidden Lines`, `Wireframe`, `CATIA Blue` backdrop), ISO 3-view blueprints, 1-click exports, STEP validator, and EN/FR interface.
  13. - **Guaranteed-manifold CSG compilation**: uses `manifold3d` and `trimesh` for exact boolean union/difference/intersection, fillets, chamfers, extruded 2D profiles with holes, revolutions, countersunk holes, and linear/circular patterns.
  14. - **Clean-room ISO 10303-21 STEP**: built-in STEP AP214/AP203 parser and referential-integrity validator (`step_inspect`), plus a deterministic AP214 `FACETED_BREP` writer.
  15. - **Automated DFM QA & BOM**: checks watertightness, 2-manifold topology, Euler/genus, ray-cast minimum wall thickness, build-plate overhang angles, sharp internal corners, hole aspect ratios, injection draft angles, and emits a structured BOM JSON.
  16. - **Deterministic 3-view engineering drawings**: pure vector orthographic SVG sheets (`TOP (XY)`, `FRONT (XZ)`, `RIGHT (YZ)`) with silhouette and crease edge extraction.
  17. - **Native MCP Server**: exposes typed tools (`part_build`, `step_inspect`, `dfm_audit`, `view_render_svg`, `export_manufacturing_bundle`) over `stdio` with workspace path confinement.
  18. ## Requirements
  19. - Python 3.10+
  20. ## Installation
  21. ```bash
  22. git clone https://github.com/eldertek/formastep.git
  23. cd formastep
  24. pip install -e ".[dev]"
  25. ```
  26. ## Quickstart CAD Workstation
  27. Launch the offline SolidWorks/CATIA-style CAD & DFM Workstation (`127.0.0.1:8743`):
  28. ```bash
  29. formastep ui
  30. # Or launch in a standalone desktop application window:
  31. formastep ui --desktop
  32. formastep-desktop --workspace-dir ./parts
  33. # Or use the dedicated web-UI entrypoint:
  34. formastep-ui --workspace-dir ./parts
  35. ```
  36. Use `--port 0 --no-open` to bind an ephemeral port without launching a browser tab automatically. See the [GUI Studio Guide](docs/gui-guide.md) for a full walkthrough, or try the live web demo at [https://eclipse-technology.eu/demos/formastep/](https://eclipse-technology.eu/demos/formastep/).
  37. ## Quickstart CLI
  38. Check installed geometry backends:
  39. ```bash
  40. formastep doctor
  41. ```
  42. Save a parametric mounting flange (`flange.json`):
  43. ```json
  44. {
  45. "schema_version": "1.0",
  46. "name": "motor_flange_v1",
  47. "units": "mm",
  48. "parameters": {
  49. "outer_d": 60.0,
  50. "bore_d": 22.0,
  51. "thickness": 8.0,
  52. "bolt_circle_r": 21.0
  53. },
  54. "material": {
  55. "name": "PETG-CF",
  56. "density_g_cm3": 1.32,
  57. "process": "fdm"
  58. },
  59. "root": {
  60. "kind": "cylinder",
  61. "diameter": "outer_d",
  62. "height": "thickness",
  63. "center": true
  64. },
  65. "features": [
  66. {
  67. "kind": "hole",
  68. "diameter": "bore_d",
  69. "position": [0, 0, 0],
  70. "axis": "z"
  71. },
  72. {
  73. "kind": "cut",
  74. "node": {
  75. "kind": "circular_pattern",
  76. "count": 4,
  77. "axis": "z",
  78. "radius": "bolt_circle_r",
  79. "child": {
  80. "kind": "hole",
  81. "diameter": 4.5,
  82. "countersink_diameter": 8.2,
  83. "depth": "thickness + 2"
  84. }
  85. }
  86. }
  87. ]
  88. }
  89. ```
  90. Compile and export the full manufacturing bundle (`STEP`, `3MF`, `Binary STL`, `3-view SVG`, `DFM JSON`, `BOM JSON`, and SHA-256 manifest):
  91. ```bash
  92. formastep bundle flange.json --out-dir ./bundle
  93. ```
  94. Other CLI commands:
  95. ```bash
  96. formastep build flange.json --out-dir ./out --formats step,3mf,stl,svg
  97. formastep inspect-step ./out/motor_flange_v1.step
  98. formastep dfm flange.json --process fdm --min-wall-mm 1.2
  99. formastep render-svg flange.json --output ./out/motor_flange_v1.svg
  100. ```
  101. ## MCP Server
  102. Start the server on `stdio`:
  103. ```bash
  104. formastep-mcp
  105. # or
  106. formastep mcp-serve
  107. ```
  108. Set `FORMASTEP_WORKSPACE_ROOT` to confine all file reads and artifact writes to a specific directory (defaults to the current working directory).
  109. Exposed MCP tools:
  110. - `part_build`: Compile `PartSpec` and write `step`, `3mf`, `stl`, `stl_ascii`, `svg`.
  111. - `step_inspect`: Parse and validate an ISO 10303-21 `.step`/`.stp` file (schema, entities, units, bounding box, duplicate IDs, dangling references).
  112. - `dfm_audit`: Run watertightness, manifoldness, ray-cast wall thickness, overhang/draft, and BOM audit on a `PartSpec` or `.stl`/`.3mf` file.
  113. - `view_render_svg`: Generate deterministic 3-view orthographic SVG output.
  114. - `export_manufacturing_bundle`: End-to-end build, STEP verification, DFM audit, and SHA-256 manifest export.
  115. ## v0.1 Scope and Known Limitations
  116. - Default STEP output uses deterministic ISO 10303-21 AP214 `FACETED_BREP` (triangulated closed manifold shells), not analytical NURBS surfaces; optional B-Rep tooling is declared under the `[brep]` extra (`build123d`).
  117. - `PartSpec` targets single-part parametric geometry; multi-part assemblies, mates, and kinematic constraints are not implemented in v0.1.
  118. - Minimum wall-thickness checks rely on mesh ray-casting and depend on cylinder/arc tessellation resolution.
  119. ## Development & Tests
  120. ```bash
  121. ruff check src tests
  122. pytest -v
  123. ```
  124. ## Commercial Support & Custom Pipelines
  125. Need headless CAD automation, custom DFM checks, or STEP/ERP integration? See [Eclipse Technology Open Source Pro](https://eclipse-technology.eu/open-source-pro.html).
  126. ## License
  127. MIT License. See [LICENSE](LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.