Control TouchDesigner with AI Agents
MCP server bridging AI agents to TouchDesigner - create, inspect, and script nodes via 12 tools and 3 guided prompts.
Why it matters
Enable AI agents to programmatically manage and control TouchDesigner projects. This asset allows for the creation, modification, and deletion of nodes, querying of properties, and execution of Python scripts within TouchDesigner.
Outcomes
What it gets done
Create, modify, and delete TouchDesigner nodes
Execute arbitrary Python scripts in TouchDesigner
Query node properties and project structure
Bridge AI models with TouchDesigner WebServer DAT
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/vb-touchdesigner | bash Capabilities
Tools your agent gets
Creates a new node in TouchDesigner
Deletes an existing node from TouchDesigner
Calls a Python method on a TouchDesigner node
Executes arbitrary Python script in TouchDesigner
Gets details of a TouchDesigner Python class or module
Gets a list of TouchDesigner Python classes
Gets information about the TouchDesigner server environment
Gets parameters of a specific TouchDesigner node
Overview
TouchDesigner MCP Server
This MCP server bridges AI models and TouchDesigner's WebServer DAT, exposing 12 tools for node creation/inspection/scripting and 3 guided prompts, with built-in connection-error diagnostics. Use it when an AI agent needs to inspect, modify, or script a live TouchDesigner project - always match MCP server and TouchDesigner-side API versions within the same MAJOR release.
What it does
TouchDesigner MCP bridges AI models and the TouchDesigner WebServer DAT, letting AI agents create, modify, and delete nodes, query node properties and project structure, and control TouchDesigner programmatically via Python scripts - effectively giving an assistant hands-on access to a live TouchDesigner project.
It exposes 12 tools: create_td_node and delete_td_node for node lifecycle management; exec_node_method for calling a Python method on a node and execute_python_script for running arbitrary Python inside TouchDesigner; get_module_help and get_td_class_details for retrieving Python help() documentation and class/module details; get_td_classes for listing available TouchDesigner Python classes; get_td_info for server environment information; get_td_node_errors for checking errors on a node and its children; get_td_node_parameters and update_td_node_parameters for reading and writing a node's parameters; and get_td_nodes for listing nodes under a parent path with optional filtering. Three prompts add higher-level guidance: "Search node" fuzzy-searches nodes by name, family, or type; "Node connection" gives instructions for wiring nodes together; and "Check node errors" recursively checks a node and its children for errors. Resources are not implemented.
The project takes compatibility seriously: the MCP server and the TouchDesigner-side API server use semantic versioning with explicit rules - matching MAJOR version and an API version at or above the minimum compatible version runs normally; a MINOR/PATCH mismatch within the same MAJOR version shows a warning but continues; and a MAJOR version mismatch or an API server below the minimum compatible version stops execution entirely until updated, since it signals breaking changes.
Connection troubleshooting is also built in: the TouchDesignerClient caches failed connection checks for 60 seconds to avoid spamming TouchDesigner with retries, and automatically clears the cache and re-verifies once the underlying issue is fixed. Guided error messages map specific error codes to fixes - ECONNREFUSED means TouchDesigner or its WebServer DAT (from mcp_webserver_base.tox) isn't running or the port (default 9981) is wrong; ETIMEDOUT points to a slow or blocked network requiring a TouchDesigner/WebServer DAT restart; and ENOTFOUND flags an invalid hostname, with 127.0.0.1 recommended unless explicitly changed.
When to use - and when NOT to
Use this connector when you want an AI agent to inspect, modify, or script a live TouchDesigner project - creating or deleting nodes, reading or updating parameters, running Python scripts, or diagnosing node errors - rather than manually clicking through the TouchDesigner UI. Always match MCP server and TouchDesigner-side API server versions within the same MAJOR release; a mismatch across MAJOR versions is a hard stop by design, not a bug to work around.
Capabilities
Accepts tool calls specifying node paths, Python scripts, or parameter updates. Returns node data, class/module documentation, error reports, or the results of executed Python scripts and method calls against the live TouchDesigner project, connecting through TouchDesigner's WebServer DAT component (mcp_webserver_base.tox) with structured error logging through ILogger for diagnosing connection failures via the MCP logs.
How to install
The project is distributed as the touchdesigner-mcp-server npm package, but the README does not give a literal install command - it points to a separate Installation Guide (docs/installation.md) for setup, and to the Latest Release notes for update procedures. Setup requires placing mcp_webserver_base.tox in the TouchDesigner project with its WebServer DAT running on the configured port (default 9981), and matching the MCP server and TouchDesigner-side API server versions within the same MAJOR release. If a version mismatch causes a compatibility error, download the latest touchdesigner-mcp-td.zip from the releases page, replace the existing touchdesigner-mcp-td folder, and re-import the .tox into the TouchDesigner project's mcp_webserver_base component. Developer-facing setup (local development, client configuration, project structure) is covered separately in the Developer Guide.
Who it's for
TouchDesigner artists and developers who want an AI agent to build, inspect, or debug TouchDesigner node networks programmatically, including running arbitrary Python scripts inside a live project.
Source README
TouchDesigner MCP
This is an implementation of an MCP (Model Context Protocol) server for TouchDesigner. Its goal is to enable AI agents to control and operate TouchDesigner projects.
Overview
TouchDesigner MCP acts as a bridge between AI models and the TouchDesigner WebServer DAT, enabling AI agents to:
- Create, modify, and delete nodes
- Query node properties and project structure
- Programmatically control TouchDesigner via Python scripts
Installation
Please refer to the Installation Guide.
If you are updating, please refer to the procedure in the Latest Release.
MCP Server Features
This server enables AI agents to perform operations in TouchDesigner using the Model Context Protocol (MCP).
Tools
Tools allow AI agents to perform actions in TouchDesigner.
| Tool Name | Description |
|---|---|
create_td_node |
Creates a new node. |
delete_td_node |
Deletes an existing node. |
exec_node_method |
Calls a Python method on a node. |
execute_python_script |
Executes an arbitrary Python script in TouchDesigner. |
get_module_help |
Gets Python help() documentation for TouchDesigner modules/classes. |
get_td_class_details |
Gets details of a TouchDesigner Python class or module. |
get_td_classes |
Gets a list of TouchDesigner Python classes. |
get_td_info |
Gets information about the TouchDesigner server environment. |
get_td_node_errors |
Checks for errors on a specified node and its children. |
get_td_node_parameters |
Gets the parameters of a specific node. |
get_td_nodes |
Gets nodes under a parent path, with optional filtering. |
update_td_node_parameters |
Updates the parameters of a specific node. |
Prompts
Prompts provide instructions for AI agents to perform specific actions in TouchDesigner.
| Prompt Name | Description |
|---|---|
Search node |
Fuzzy searches for nodes and retrieves information based on name, family, or type. |
Node connection |
Provides instructions to connect nodes within TouchDesigner. |
Check node errors |
Checks for errors on a specified node, and recursively for its children. |
Resources
Not implemented.
Developer Guide
Looking for local setup, client configuration, project structure, or release workflow notes?
See the Developer Guide for all developer-facing documentation.
Troubleshooting
Troubleshooting version compatibility
The MCP server uses semantic versioning for flexible compatibility checks
| MCP Server | API Server | Minimum compatible API version | Behavior | Status | Notes |
|---|---|---|---|---|---|
| 1.3.x | 1.3.0 | 1.3.0 | ✅ Works normally | Compatible | Recommended baseline configuration |
| 1.3.x | 1.4.0 | 1.3.0 | ⚠️ Warning shown, continues | Warning | Older MCP MINOR with newer API may lack new features |
| 1.4.0 | 1.3.x | 1.3.0 | ⚠️ Warning shown, continues | Warning | Newer MCP MINOR may have additional features |
| 1.3.2 | 1.3.1 | 1.3.2 | ❌ Execution stops | Error | API below minimum compatible version |
| 2.0.0 | 1.x.x | N/A | ❌ Execution stops | Error | Different MAJOR = breaking changes |
Compatibility Rules:
✅ Compatible: Same MAJOR version AND API version ≥ 1.3.0 (minimum compatible version)
⚠️ Warning: Different MINOR or PATCH versions within the same MAJOR version (shows warning but continues execution)
❌ Error: Different MAJOR versions OR API server < 1.3.0 (execution stops immediately, update required)
To resolve compatibility errors:
- Download the latest touchdesigner-mcp-td.zip from the releases page.
- Delete the existing
touchdesigner-mcp-tdfolder and replace it with the newly extracted contents. - Remove the old
mcp_webserver_basecomponent from your TouchDesigner project and import the.toxfrom the new folder. - Restart TouchDesigner and the AI agent running the MCP server (e.g., Claude Desktop).
For developers: When developing locally, run
npm run versionafter editingpackage.json(or simply usenpm version ...). This keeps the Python API (pyproject.toml+td/modules/utils/version.py), MCP bundle manifest, and registry metadata in sync so that the runtime compatibility check succeeds.
For a deeper look at how the MCP server enforces these rules, see Version Compatibility Verification.
Troubleshooting connection errors
TouchDesignerClientcaches failed connection checks for 60 seconds. Subsequent tool calls reuse the cached error to avoid spamming TouchDesigner and automatically retry after the TTL expires.- When the MCP server cannot reach TouchDesigner, you now get guided error messages with concrete fixes:
ECONNREFUSED/ "connect refused": start TouchDesigner, ensure the WebServer DAT frommcp_webserver_base.toxis running, and confirm the configured port (default9981).ETIMEDOUT/ "timeout": TouchDesigner is responding slowly or the network is blocked. Restart TouchDesigner/WebServer DAT or check your network connection.ENOTFOUND/getaddrinfo: the host name is invalid. Use127.0.0.1unless you explicitly changed it.
- The structured error text is also logged through
ILogger, so you can check the MCP logs to understand why a request stopped before hitting TouchDesigner. - Once the underlying issue is fixed, simply run the tool again-the client clears the cached error and re-verifies the connection automatically.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.
