dcc-mcp-touchdesigner
Typed, main-thread-safe TouchDesigner control for the DCC Model Context Protocol.
The adapter embeds the DCC-MCP HTTP runtime in TouchDesigner, registers the instance with the local gateway, and executes TouchDesigner API work through the documented td.run() scheduler. Agents can inspect and edit operator networks, parameters, Unicode DAT content, and root timeline state, then save projects and export TOP images without sending TouchDesigner objects to background threads.
Illustrative workflow visualization generated with OpenAI ImageGen from the retained source in docs/images/sources. It is not a TouchDesigner screenshot or host-validation artifact. The header uses an approved operator-network reference motif rather than an official host mark.
Part of the DCC-MCP host matrix
dcc-mcp-touchdesigner — TouchDesigner adapter with 19 typed operator graph, parameter, DAT, timeline, capture, and project tools dispatched on the main thread.
It is one of 38 host adapters in the DCC-MCP catalog. Every adapter speaks the same MCP protocol and builds on the same core runtime contract; each one exposes the tools its own host needs on top of that.
This block is generated from the catalog entry in
dcc-mcp-catalog.yml.
Re-run the generator after changing the catalog.
Install
TouchDesigner 2025 uses Python 3.11. Install this package into the interpreter that TouchDesigner will import, inspect the machine-readable plan, and apply the receipt-owned integration:
python -m pip install --upgrade dcc-mcp-touchdesigner
dcc-mcp-touchdesigner install --dry-run --json
dcc-mcp-touchdesigner install --yes --json
dcc-mcp-touchdesigner verify --json
TouchDesigner physically stores startup callbacks in a project Execute DAT, so
the installer returns one structured file_edit and exit code 50 until that
edit and a restart are complete. See install.md for supported
platforms, exact flags and exit codes, the TDPyEnvManager/Preferences manual
route, upgrade, uninstall, verification, and recovery.
Start in TouchDesigner
Run this from the Textport or an Execute DAT onStart() callback:
import dcc_mcp_touchdesigner
server = dcc_mcp_touchdesigner.start_server()
print(server.mcp_url)
start_server() is idempotent inside one TouchDesigner process. It loads the bundled skill by default, selects an OS-assigned loopback port, starts the main-thread pump, and advertises the instance to a running DCC-MCP gateway. Stop it explicitly during project teardown when needed:
dcc_mcp_touchdesigner.stop_server()
Typed tools
| Tool | Contract | Risk |
|---|---|---|
get_project_info |
Read redacted host/project identity, cook rate, real-time mode, and root count | Read-only |
list_operators |
List bounded direct/recursive operators with an optional family/type filter | Read-only |
inspect_operator / inspect_connections |
Read flags, cook diagnostics, and connector topology | Read-only |
get_op_parameters |
Read selected or bounded parameters from one operator | Read-only |
create_operator |
Create a documented operator type under an explicit COMP | Mutation |
connect_operators |
Connect an explicit output connector to an explicit input | Mutation |
disconnect_operator_input |
Disconnect one exact input without touching sibling connections | Idempotent mutation |
set_op_parameter |
Set one parameter and return its evaluated value | Idempotent mutation |
pulse_op_parameter |
Pulse one exact parameter with bounded frame/second duration | Mutation |
set_operator_flags |
Atomically update allowlisted flags with rollback | Idempotent mutation |
set_operator_layout |
Atomically set bounded Network Editor position/size fields with rollback | Idempotent mutation |
get_dat_content / set_dat_content |
Read/write bounded, language-independent Unicode Text/Table DAT content with SHA-256 concurrency | Read / mutation |
get_timeline_state / set_timeline_state |
Read or atomically update root frame/play/cook controls | Read / mutation |
capture_top |
Save one TOP to an explicit PNG path with size and SHA-256 metadata | File write |
save_project |
Save the current project to an explicit .toe path |
File write |
delete_operator |
Delete one explicitly addressed non-root operator | Destructive |
All 19 tools have JSON input/output contracts and are dispatched on TouchDesigner's main thread. File-writing tools require an explicit absolute path and reject accidental overwrite unless overwrite=true is supplied. Root deletion and executable-DAT mutation are always rejected. The catalog exposes no arbitrary Python or expression-evaluation tool.
Security controls
The public contract is typed-only: it has no arbitrary Python escape hatch. Recursive graph, parameter, connector, JSON, and DAT operations are bounded; DAT writes use optional SHA-256 optimistic concurrency and only target Text/Table DATs. DAT text is treated as arbitrary Unicode data rather than a finite language list: RTL text, combining marks, ZWJ sequences, and non-BMP characters are preserved without language detection or normalization. Operator and parameter identifiers still follow TouchDesigner's own naming rules. The adapter binds to loopback by default. Do not expose the per-instance port directly to an untrusted network. Use the DCC-MCP gateway when multiple instances or attributable agent sessions are required.
Runtime configuration
| Variable | Purpose |
|---|---|
DCC_MCP_TOUCHDESIGNER_SKILL_PATHS |
Additional skill directories |
DCC_MCP_TOUCHDESIGNER_METRICS |
Enable Prometheus /metrics |
DCC_MCP_TOUCHDESIGNER_ENABLE_GATEWAY_FAILOVER |
Enable gateway failover; on by default |
Development
py -3.11 -m pip install -e ".[dev]"
pytest
ruff check .
ruff format --check .
dcc-mcp-cli lint src/dcc_mcp_touchdesigner/skills/touchdesigner-scripting --warnings-as-errors
python -m build
python -m twine check dist/*
Unit and contract tests use a deterministic TouchDesigner API double. A release additionally requires a real TouchDesigner process, six readiness checks, discovery of all 19 typed tools, and a create/connect/layout/set/pulse/DAT/timeline/capture/save/delete chain through dcc-mcp-cli; simulation alone is not release evidence.
License
MIT
Metadata
Release files for dcc-mcp-touchdesigner 0.1.3
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_touchdesigner-0.1.3.tar.gz | 138.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dcc_mcp_touchdesigner-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 194.8 kB
Release files / dcc_mcp_touchdesigner-0.1.3.tar.gz
| Download URL | dcc_mcp_touchdesigner-0.1.3.tar.gz |
|---|---|
| Size | 138.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3adfc2a56facb425787b76e137471800182d60e877442ee652583307d736de34
|
|
BLAKE2b-256 checksum How to use checksums |
a3ff2813c198ab5d852009c638556b8bfd74303602105afb6fc538c8b13b75ef
|
| 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 Oct 11, 2026.
Transparency logRelease files / dcc_mcp_touchdesigner-0.1.3-py3-none-any.whl
| Download URL | dcc_mcp_touchdesigner-0.1.3-py3-none-any.whl |
|---|---|
| Size | 56.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c366603044570018d3004189d005191150235452cb5045e8e289b347118a5fbf
|
|
BLAKE2b-256 checksum How to use checksums |
396507c4465193d67068b05c56a656dddfb0b3111113afe200ed407abd6ee76e
|
| 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 Oct 11, 2026.
Transparency log