You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: add 3D printing tools, sculpting tools, and mushroom keychain showcase
Adds mesh validation/repair/export tools for 3D printing (check_mesh_for_printing,
repair_mesh, apply_voxel_remesh, export_model, set_scene_units, etc.) and a new
sculpting tool module (enter/exit_sculpt_mode, sculpt_inflate, sculpt_grab,
symmetrize_mesh, set_dyntopo).
Includes a community showcase (Sculpted Mushroom Keychain) built end-to-end
with an n8n agent
Copy file name to clipboardExpand all lines: README.md
+79-13Lines changed: 79 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,17 @@ graph LR
20
20
21
21
### 1. Install Dependencies
22
22
23
+
We recommend using [`uv`](https://docs.astral.sh/uv/) for fast virtual environment management and package installation:
24
+
23
25
```bash
24
-
pip install -r requirements.txt
26
+
# 1. Sync dependencies (automatically creates .venv if missing)
27
+
uv sync
28
+
29
+
# 2. Activate it
30
+
# Windows:
31
+
.venv\Scripts\activate
32
+
# macOS/Linux:
33
+
source .venv/bin/activate
25
34
```
26
35
27
36
## Configuration
@@ -41,9 +50,9 @@ Create a `.env` file in the root directory to customize your setup:
41
50
### Method 1: Zip & Install (Recommended)
42
51
1. Zip the `blender_mcp_addon` folder (into `blender_mcp_addon.zip`).
43
52
2. Open Blender.
44
-
3. Go to **Edit** > **Preferences** > **Add-ons**.
45
-
4. Click **Install...** and select the `.zip` file.
46
-
5. Search for "Blender MCP" and enable the checkbox.
53
+
3.**For Blender 4.2+**: Go to **Edit** > **Preferences** > **Get Extensions** > Click the dropdown arrow in the top right > **Install from Disk...** and select the `.zip`.
54
+
**For Blender 4.0 / 4.1**: Go to **Edit** > **Preferences** > **Add-ons** > **Install...** and select the `.zip`.
55
+
4. Search for "Blender MCP" and enable the checkbox.
47
56
48
57
### Method 2: Manual Copy (Developer)
49
58
1. Copy the `blender_mcp_addon` folder to your Blender addons directory:
@@ -67,10 +76,10 @@ As the addon grows, a single 1800+ line file becomes unmaintainable. We've split
67
76
68
77
```bash
69
78
# Standard mode
70
-
python -m src.main serve
79
+
uv run python -m src.main serve
71
80
72
81
# Recording mode (Save all commands to a file)
73
-
python -m src.main serve --record my_session.json --name "Building My House"
82
+
uv run python -m src.main serve --record my_session.json --name "Building My House"
74
83
```
75
84
76
85
The server will start on `http://localhost:8008` with HTTP Streamable endpoint at `/mcp`. It uses detailed logging to show exactly which tools are being called and their results.
@@ -82,7 +91,7 @@ The **Bridge Sessions** feature allows you to record yours or an AI's tool calls
82
91
### Recording a Session
83
92
To record all tool calls made to the bridge while the server is running:
| Filament Tag |`filament_tag`| Generates a 4-piece modular filament name tag & clip system (NameTagCard, AMSClip, StickonHolder, DeskStand) |
444
+
399
445
See the [Integration Testing Guide](docs/integration_tests.md) for full details on verification and benchmarking.
400
446
447
+
## Code Quality & Standards
448
+
449
+
We enforce code quality standards using [Ruff](https://docs.astral.sh/ruff/) and [Mypy](https://mypy.readthedocs.io/). These are run automatically on GitHub Actions CI.
450
+
451
+
To run these checks locally:
452
+
453
+
```bash
454
+
# 1. Format code (strict black-compatible formatting)
455
+
uv run ruff format src/ tests/ blender_mcp_addon/
456
+
457
+
# 2. Run linter and check code complexity (McCabe <= 12)
458
+
uv run ruff check src/ tests/ blender_mcp_addon/
459
+
460
+
# 3. Auto-fix standard lint issues
461
+
uv run ruff check src/ tests/ blender_mcp_addon/ --fix
462
+
463
+
# 4. Run static type checking
464
+
uv run mypy src/
465
+
```
466
+
401
467
## Troubleshooting
402
468
403
-
**Server won't start**: Install dependencies with `pip install -r requirements.txt`
469
+
**Server won't start**: Install dependencies with `uv sync`
404
470
405
471
**Connection failed**: Ensure Blender MCP addon is running on port 8888.
0 commit comments