Sandbox
@8beeeaaat/touchdesigner-mcp

MCP server for TouchDesigner project control

This server sits between an agent and TouchDesigner’s WebServer DAT. Through MCP tools and prompts, the agent can manage nodes, inspect parameters, run Python, and check errors inside a project.

522 stars55 forksTypeScriptUpdated 8d ago
World's First! AI Agent Creates Particle System on TouchDesigner via MCP server
8-beeeaaat!!!2.9k views • 1 year ago
Who it's for

Builders who want Claude Code, Codex, Cursor, or any MCP-capable agent to work inside TouchDesigner.

What it delivers

You can let your agent edit and inspect TouchDesigner projects instead of doing every change by hand.

What it does

Node operations

Creates and deletes TouchDesigner nodes, and lists nodes under a path with optional filtering.

Project inspection

Reads node parameters, node errors, class details, module help, and server info.

Python execution

Runs Python scripts and node methods inside TouchDesigner.

Image capture

Captures the current output of a TOP node as an image.

Agent prompts

Includes prompts for node search, node connection, and error checking.

Compatibility checks

Compares the MCP server and TouchDesigner component API versions and explains when updates are needed.

README

TouchDesigner MCP

Version Downloads

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.

English / 日本語

Overview

demo clip

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 NameDescription
create_td_nodeCreates a new node.
delete_td_nodeDeletes an existing node.
describe_td_toolsGenerates a manifest of the available TouchDesigner tools.
exec_node_methodCalls a Python method on a node.
execute_python_scriptExecutes an arbitrary Python script in TouchDesigner.
get_td_class_detailsGets details of a TouchDesigner Python class or module.
get_td_classesGets a list of TouchDesigner Python classes.
get_td_infoGets information about the TouchDesigner server environment.
get_td_module_helpGets Python help() documentation for TouchDesigner modules/classes.
get_td_node_errorsChecks for errors on a specified node and its children.
get_td_node_parametersGets the parameters of a specific node.
get_td_nodesGets nodes under a parent path, with optional filtering.
get_top_imageCaptures the current output of a TOP node as an image.
update_td_node_parametersUpdates the parameters of a specific node.

Prompts

Prompts provide instructions for AI agents to perform specific actions in TouchDesigner.

Prompt NameDescription
Search nodeFuzzy searches for nodes and retrieves information based on name, family, or type.
Node connectionProvides instructions to connect nodes within TouchDesigner.
Check node errorsChecks 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 and the TouchDesigner component are versioned on two independent axes: the npm package version and the API version (the contract between the MCP server and the .tox component). Each release declares the API version it ships with (expectedApiVersion) and the minimum it supports (minApiVersion, currently 1.3.0). The connected component's API version is compared against those two values — the npm package version itself never gates compatibility, so updating the MCP server alone never invalidates a supported component.

API Server (component)ConditionBehaviorStatus
= expected API versionMatches the shipped .tox✅ Works silentlyCompatible
≥ minimum, < expectedOlder component⚠️ "Update Recommended" notice appended to responses, continuesWarning
> expected, same MAJORNewer component⚠️ Warning to update the MCP server, continuesWarning
MAJOR above expectedNewer API generation❌ Execution stops — update the MCP serverError
< minimum (or missing)Too old❌ Execution stops — update the componentError
  • To resolve compatibility errors:

    1. Download the latest touchdesigner-mcp-td.zip from the releases page.
    2. Delete the existing touchdesigner-mcp-td folder and replace it with the newly extracted contents.
    3. Remove the old mcp_webserver_base component from your TouchDesigner project and import the .tox from the new folder.
    4. Restart TouchDesigner and the AI agent running the MCP server (e.g., Claude Desktop).
  • For developers: When developing locally, run npm run version after editing package.json (or simply use npm version ...). This keeps the Python API (pyproject.toml + td/modules/utils/version.py), mcpCompatibility.expectedApiVersion, 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

  • TouchDesignerClient caches 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 from mcp_webserver_base.tox is running, and confirm the configured port (default 9981).
    • 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. Use 127.0.0.1 unless 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.

Contributing

We welcome your contributions!

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/amazing-feature).
  3. Make your changes.
  4. Add tests and ensure everything works (npm test).
  5. Commit your changes (git commit -m 'Add some amazing feature').
  6. Push to your branch (git push origin feature/amazing-feature).
  7. Open a pull request.

Please always include appropriate tests when making implementation changes.

License

MIT

Files in the repo

Repository payload33 top-level entries
  • .agents
  • .claude
  • .codex
  • .github
  • assets
  • docker
  • docs
  • mcpb
  • scripts
  • src
  • td
  • tests
  • .gitignore
  • .node-version
  • .prettierignore
  • .prettierrc.json
  • AGENTS.md
  • biome.json
  • CHANGELOG.md
  • CLAUDE.md
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • Makefile
  • orval.config.ts
  • package-lock.json
  • package.json
  • pyproject.toml
  • README.ja.md
  • README.md
  • server.json
  • tsconfig.json
  • vitest.config.ts

Discussion (0)

Ask about usage, or say what you built with it

Sign in to join the discussion.

No comments yet. Be the first to say what this is good for.

More connectors

High-performance code intelligence MCP server. Indexes codebases into a persistent knowledge graph — average repo in milliseconds. 158 languages, sub-ms queries, 99% fewer tokens. Single static binary, zero dependencies.

43k

Universal provider proxy for OpenAI Codex & Claude Code — use any LLM (Claude, Gemini, Grok, DeepSeek, Ollama…) with Codex CLI, App, SDK, and Claude Code

14k
okf-memory/
okf-agent-memory

Git-native persistent memory for AI coding agents. Implements Google OKF v0.2 with sub-300µs in-memory BM25 search, embedded MCP server, and progressive disclosure. Slashes token bloat by 80% with zero external databases or dependencies. Built in pure Go.

547
tirth8205/
code-review-graph

Local-first code intelligence graph for MCP and CLI. Builds a persistent map of your codebase so AI coding tools read only what matters, with benchmarked context reductions on reviews and large-repo workflows.

31k
2akouwu/
reverify

Stop your AI from making things up — it proposes, deterministic tools decide, every claim checked against ground truth with evidence. Grounded facts and context survive resets. Reverse engineering is the proving ground. MCP server + CLI.

1.1k
t8y2/dbxConnectors

20 MB lightweight cross-platform database client for 90+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 90+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP Server。

19k