dcc-mcp-substance3d-designer
Showcase: reference image to Designer materials and Blender lookdev
A Codex-generated reference guided a 2.2 m wooden crate modeled in Blender with painted wood and rusted steel authored in Substance 3D Designer 16. Wood scratches, metal scratches and rust are independent procedural layers in the SD graphs. Their exported PBR maps drive the Blender materials. Layered broken battens combine attached wood fibers with native SD height displacement; fine wood grain uses a separate UV layer with consistent physical density.
| Codex-generated reference | Blender Cycles render using SD maps |
|---|---|
Model UVs — coordinates and a rendered checker:
| UV coordinates | Checker on the model |
|---|---|
Wood detail uses one tile per 0.45 m. UVs intentionally tile and overlap; the UV review explains the two layers and the existing steel UVs.
Complete material graphs — unretouched Designer screenshots:
| Painted wood: 37 nodes | Rusted steel: 35 nodes |
|---|---|
Blender scene with packed textures · Editable SBS, SBSAR, maps and workflow · UV checker · Broken wood detail · Blender showcase · Website gallery · Earlier color-correction study
The crate is a reference-guided modeling and lookdev study. Its proportions, board UVs and hardware were authored in Blender; it is not a scan of the generated image. The material screenshots use the project's DCC-CUA route.
Agent workflow
AI agents should use the shared gateway through dcc-mcp-cli; IDE users may
continue to use the MCP endpoint. Prefer typed skills and tools over raw scripts.
Install or update the CLI
dcc-mcp-cli is the preferred control path for every shell-capable agent. If
it is missing, ask the user before installing the latest official release:
# Linux/macOS
curl -fsSL https://raw.githubusercontent.com/dcc-mcp/dcc-mcp-core/main/scripts/install-cli.sh | sh
# Windows PowerShell
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/dcc-mcp/dcc-mcp-core/main/scripts/install-cli.ps1 | iex"
Keep an official build current through the release manifest:
dcc-mcp-cli update check
dcc-mcp-cli update apply
update apply downloads and stages the latest CLI for the next launch. It
does not update a running dcc-mcp-server; update that server in its own
environment.
dcc-mcp-cli dcc-types
dcc-mcp-cli list
dcc-mcp-cli search --query "<task>" --dcc-type substance3d_designer
dcc-mcp-cli describe <tool-slug>
dcc-mcp-cli call <tool-slug> --json '{"key":"value"}'
dcc-types reports release-catalog support; list reports live sessions. If a
tool belongs to an inactive progressive skill, call dcc-mcp-cli load-skill <skill-name> --dcc-type substance3d_designer before retrying. For post-task improvement,
attach a stable session id with --meta-json, query dcc-mcp-cli stats --range 24h --session-id <task-id>, then pass the bounded evidence to the
review_skill_improvement prompt from dcc-mcp-skills-creator.
Substance 3D Designer adapter for the DCC Model Context Protocol (MCP).
The package runs an embedded Streamable HTTP MCP server inside Designer, so tools execute through Designer's Qt main thread instead of a separate process.
Install and load
Follow the canonical Install SOP for automatic host discovery, a zero-write plan, staged installation, receipt-owned uninstall, and verify-to-usable diagnostics:
python3.11 -m pip install dcc-mcp-substance3d-designer
dcc-mcp-substance3d-designer install --dcc-path "/path/to/Designer" --python python3.11 --json --dry-run
dcc-mcp-substance3d-designer install --dcc-path "/path/to/Designer" --python python3.11 --json --yes
The receipted launcher preserves existing SBS_DESIGNER_PYTHON_PATH and PYTHONPATH values while
adding the dedicated plugin. A source checkout may still be loaded interactively through Tools >
Plugin Manager as documented in the SOP. Each adapter instance uses an OS-assigned port and
registers it for CLI discovery.
Connect through the stable gateway at http://127.0.0.1:9765/mcp; set
DCC_MCP_SUBSTANCE3D_DESIGNER_PORT only when a fixed direct endpoint is required.
Standard DCC_MCP_GATEWAY_PORT and DCC_MCP_REGISTRY_DIR settings are also honoured.
For unattended launches, pass Designer a persistent configuration with
--config-file <path-to-default_configuration.sbscfg>. This prevents a stale
session-specific configuration reference from opening a blocking startup
dialog.
Bundled skills
Host APIs are imported only while a tool runs, so metadata discovery remains safe outside Designer.
| Skill | Coverage |
|---|---|
designer-session |
Core graph authoring: nodes, connections, parameters, outputs, packages, resources, map export, SBSAR. |
designer-diagnostics |
Read-only readiness probe proving main-thread dispatch works. |
designer-effects |
Procedural effect recipes: blur, warp, levels, sharpen, edge detect, blend, mask, and ordered chains. |
designer-lighting |
Lighting-response maps: normal, ambient occlusion, curvature, thickness, emissive. |
designer-particles |
Seed-variation tiles and sprite-sheet atlas packing for downstream particle systems. |
designer-dynamics |
Iteration-count sweeps producing ordered accumulation passes. |
designer-animation |
Time-like parameter sweeps producing ordered frame sets. |
designer-plugins |
Read-only inventory of the node modules that back built-in plugins. |
Effect and lighting recipes are resolved against the live node-definition
inventory instead of hardcoded type URLs, because node type URLs differ between
Designer builds. Run the corresponding list_*_recipes tool first: a recipe that
resolves to nothing fails closed with RECIPE_UNAVAILABLE and reports the
candidates it tried.
Designer has no particle system, dynamics solver, or timeline. The
designer-particles, designer-dynamics, and designer-animation skills all
drive one shared engine that re-evaluates a deterministic graph after a typed
input changes, and each states that boundary in its SKILL.md.
Development
python -m pip install -e ".[dev]"
python -m pytest
ruff check src tests tools
python -m build
Releases use release-please. The release.yml workflow publishes through the
pypi environment using PyPI Trusted Publishing.
Reference-material reconstruction
designer-session.create_imported_pbr_material accepts either packed RMA/ARM maps
or separate roughness_path and metallic_path, alongside the required base-color
and normal maps. Separate AO is optional. height_path works with either mode;
packed and separate scalar maps cannot be mixed. Set embed_resources: true to
embed the source bitmaps in the editable .sbs instead of linking them.
Example tool arguments (replace the paths with existing source maps):
{
"package_path": "C:/materials/sample/material.sbs",
"output_dir": "C:/materials/sample/maps",
"base_color_path": "C:/sources/basecolor.png",
"normal_path": "C:/sources/normal.png",
"roughness_path": "C:/sources/roughness.png",
"metallic_path": "C:/sources/metallic.png",
"ambient_occlusion_path": "C:/sources/ao.png",
"height_path": "C:/sources/height.png",
"embed_resources": true,
"open_in_editor": false
}
This creates an editable bitmap/output graph, not a recovered procedural material. Use the existing node creation, connection and parameter tools to construct and iterate procedural structure when needed. Source images must already be PBR maps; a lit reference photograph is not directly a base-color map. A single image does not uniquely determine roughness, metallic response, illumination or physical height. Record these as estimates until checked against additional evidence.
For a Designer-to-Painter handoff, pass the returned texture_files to Painter's
create_textured_pbr_layer, mapping AmbientOcclusion to
ambient_occlusion_path and optional Height to height_path. Keep the normal
convention and color-management configuration consistent across both hosts.
The import helper writes PNG previews without a configurable bit-depth contract;
retain original high-precision height sources when precision matters.
Before accepting a result, reopen the saved .sbs and .spp, inspect graph
connections and layer channels, verify the exported maps, and compare actual host
renders under matched lighting, camera and scale. File existence and mocked SDK
tests do not verify the visual result. Use a fresh output directory per iteration.
See the reference-material capability matrix
for node inspection, connection guards, resource instancing, persistence/export
contracts and remaining live-host validation. Parameter exposure uses public graph inputs and property function graphs; unsupported
SDK variable readers return EXPOSE_API_UNAVAILABLE. Native PNG exports report
actual channel count and bit depth, and graph input edits are verified by readback.
Metadata
Release files for dcc-mcp-substance3d-designer 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dcc_mcp_substance3d_designer-0.8.0.tar.gz | 157.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dcc_mcp_substance3d_designer-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 311.6 kB
Release files / dcc_mcp_substance3d_designer-0.8.0.tar.gz
| Download URL | dcc_mcp_substance3d_designer-0.8.0.tar.gz |
|---|---|
| Size | 157.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
710916797a701a47936d44c0bf6b49e49825f5763954b92a281546e62bf274bf
|
|
BLAKE2b-256 checksum How to use checksums |
b2d409cbf9f920b30e3ead97fed1e8240981c304964625bd3fd1134f1c9c29ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 19, 2026.
Transparency logRelease files / dcc_mcp_substance3d_designer-0.8.0-py3-none-any.whl
| Download URL | dcc_mcp_substance3d_designer-0.8.0-py3-none-any.whl |
|---|---|
| Size | 154.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3def11a2ab56b1d2907fbbdb1045849d295ab3ce67295eca2e38d59ab9d63b15
|
|
BLAKE2b-256 checksum How to use checksums |
30eda2b9fe68c6b9f851e85160a1f5da1c6a53b2fb40a7aae40286f6a07056f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 19, 2026.
Transparency log