Integrations
Required for code generation during development, used to generate API client/server schemas for the TouchDesigner integration.
Required runtime environment for the TouchDesigner MCP server, enabling the bridge between AI models and TouchDesigner.
Used within TouchDesigner for scripting and controlling nodes, allowing AI agents to execute Python code to manipulate TouchDesigner projects.
TouchDesigner MCP
Esta es una implementación de un servidor MCP (Protocolo de Contexto de Modelo) para TouchDesigner. El objetivo es permitir que los agentes de IA controlen y operen proyectos de TouchDesigner.
Descripción general
TouchDesigner MCP actúa como un puente entre los modelos de IA y TouchDesigner WebServer DAT, lo que permite a los agentes de IA:
- Crear, modificar y eliminar nodos
- Consultar propiedades del nodo y estructura del proyecto
- Controlar TouchDesigner programáticamente mediante scripts de Python
Uso
Requiere que Node.js esté instalado
1. Instale el paquete touchdesigner-mcp-server
mkdir some && cd ./some
(Si es necesario) npm install touchdesigner-mcp-server
2. Conéctese a TouchDesigner
Coloque mcp_webserver_base.tox en TouchDesigner
Inicie TouchDesigner e importe el componente td/mcp_webserver_base.tox
directamente en su proyecto de TouchDesigner. Ejemplo: Colóquelo como /project1/mcp_webserver_base
Al importar el tox se activará el script td/import_modules.py
, que carga módulos como los controladores del servidor API.
Puede comprobar los registros de arranque abriendo Textport desde el menú TouchDesigner.
3. Configurar el servidor MCP de TouchDesigner
Con TouchDesigner en ejecución, configure su agente de IA (Claude Desktop, Cursor, VSCode CopilotChat, etc.) para conectarse al servidor MCP.
Ejemplo: Claude Desktop
En el sistema Windows, incluya la letra de la unidad, como C:, por ejemplo, C:\\path\\to\\your\\node_modules\\touchdesigner-mcp-server\\dist\\index.js
Si se reconoce el servidor MCP, la configuración está completa. Si no se reconoce, reinicie el agente. Si se produce un error al iniciar, intente reiniciar el agente después de iniciar TouchDesigner. Si el servidor API se ejecuta en TouchDesigner, el agente puede usar TouchDesigner mediante las herramientas proporcionadas.
Características del servidor MCP
Este servidor permite operaciones en TouchDesigner a través del Protocolo de contexto de modelo (MCP) y proporciona referencias a varios documentos de implementación.
Herramientas
Las herramientas permiten que los agentes de IA realicen acciones en TouchDesigner.
Nombre de la herramienta | Descripción |
---|---|
create_td_node | Crear un nuevo nodo. |
delete_td_node | Eliminar un nodo existente. |
exec_node_method | Llamar a un método Python en un nodo. |
execute_python_script | Ejecutar un script de Python arbitrario en TD. |
get_td_class_details | Obtenga detalles de una clase/módulo de Python de TD. |
get_td_classes | Obtenga una lista de clases de Python de TouchDesigner. |
get_td_info | Obtenga información sobre el entorno del servidor TD. |
get_td_node_parameters | Obtener parámetros de un nodo específico. |
get_td_nodes | Obtener nodos bajo una ruta principal (opcionalmente filtrada). |
update_td_node_parameters | Actualizar los parámetros de un nodo específico. |
Indicaciones
Las indicaciones proporcionan instrucciones para que los agentes de IA realicen acciones específicas en TouchDesigner.
Nombre del aviso | Descripción |
---|---|
Search node | Búsqueda difusa de nodos y recuperación de información según nombre, familia y tipo. |
Node connection | Proporciona instrucciones para conectar nodos dentro de TouchDesigner. |
Check node errors | Comprueba los errores de un nodo específico y, de forma recursiva, de los nodos secundarios si los hay. |
Recursos
No implementado
Para desarrolladores
Construyendo el código del servidor MCP
- Clonar el repositorio
- Instalar dependencias
- Configurar el archivo de entorno y compilarlo
Configuración de TouchDesigner
1. Generación de código:
Ejecute npm run build
para generar el siguiente código:
- Código del servidor MCP
- Código de servidor API para TouchDesigner WebServer DAT
2. Importe el servidor web para el servidor MCP en TouchDesigner:
Inicie TouchDesigner e importe el componente td/mcp_webserver_base.tox
directamente en su proyecto. Al importar el componente tox, se activará el script td/import_modules.py
, que carga módulos como los controladores del servidor API.
3. Verificar el funcionamiento del servidor API:
Asegúrese de que los módulos de Python en el directorio td/modules
sean accesibles desde el componente mcp_webserver_base
. Ejecute npm run test
para ejecutar pruebas unitarias y de integración para el código del servidor MCP y la conexión a TouchDesigner. Puede consultar los registros de comunicación abriendo Textport desde el menú de TouchDesigner.
Puede depurar con @modelcontextprotocol/inspector usando npm run dev
.
CONSEJOS: mcp_webserver_base.tox
incluye un archivo DAT de servidor web configurado para vincular el servidor MCP con TouchDesigner. Asegúrese de que este archivo DAT esté activo y ejecutándose en el puerto especificado por TD_WEB_SERVER_URL
en su archivo .env
(predeterminado: 9981
). Para cambiar el puerto:
- Cambiar
TD_WEB_SERVER_PORT
en.env
- Vuelva a ejecutar
npm run build
- Cambie el puerto en mcp_webserver_base (WebServer DAT) y reinicie el DAT
Conexión con agentes de IA compatibles con MCP
Con TouchDesigner en ejecución, configure su agente de IA (Cursor, Claude Desktop, VSCode CopilotChat, etc.) para conectarse al servidor MCP.
Ejemplo: Claude Desktop
En el sistema Windows, incluya la letra de la unidad, como C:, por ejemplo C:\\path\\to\\your\\touchdesigner-mcp\\dist\\index.js
Estructura del proyecto después de la configuración
Flujo de trabajo de generación de código API
Este proyecto utiliza herramientas de generación de código basadas en OpenAPI (Orval / openapi-generator-cli):
Definición de API: El contrato de API entre el servidor MCP Node.js y el servidor Python que se ejecuta dentro de TouchDesigner se define en src/api/index.yml
.
- Generación del servidor Python (
npm run gen:webserver
):- Utiliza
openapi-generator-cli
a través de Docker. - Lee
src/api/index.yml
. - Genera un esqueleto de servidor Python (
td/modules/td_server/
) basado en la definición de la API. Este código se ejecuta dentro de TouchDesigner mediante el DAT del servidor web. - Requiere que Docker esté instalado y en ejecución.
- Utiliza
- Generación de controladores de Python (
npm run gen:handlers
):- Utiliza un script Node.js personalizado (
td/genHandlers.js
) y plantillas Mustache (td/templates/
). - Lee el código del servidor Python generado o la especificación OpenAPI.
- Genera implementaciones de controladores (
td/modules/mcp/controllers/generated_handlers.py
) que se conectan a la lógica empresarial entd/modules/mcp/services/api_service.py
.
- Utiliza un script Node.js personalizado (
- Generación de cliente TypeScript (
npm run gen:mcp
):- Utiliza
Orval
para generar código de cliente API y esquemas Zod para la validación de herramientas a partir del esquema YAML incluido enopenapi-generator-cli
. - Genera un cliente TypeScript tipificado (
src/tdClient/
) utilizado por el servidor Node.js para realizar solicitudes al DAT del servidor web.
- Utiliza
El proceso de compilación ( npm run build
) ejecuta todos los pasos de generación necesarios ( npm run gen
), seguido de la compilación de TypeScript ( tsc
).
Contribuyendo
¡Agradecemos sus contribuciones!
- Bifurcar el repositorio
- Crear una rama de características (
git checkout -b feature/amazing-feature
) - Realiza tus cambios
- Agregue pruebas y asegúrese de que todo funcione (
npm test
) - Confirme sus cambios (
git commit -m 'Add some amazing feature'
) - Subir a su rama (
git push origin feature/amazing-feature
) - Abrir una solicitud de extracción
Incluya siempre pruebas adecuadas al realizar cambios de implementación.
Licencia
Instituto Tecnológico de Massachusetts (MIT)
This server cannot be installed
local-only server
The server can only run on the client's local machine because it depends on local resources.
Un servidor de protocolo de contexto de modelo que permite a los agentes de IA controlar y operar proyectos de TouchDesigner mediante la creación, modificación y consulta de nodos y estructuras de proyectos.
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol server that allows AI assistants to interact with Appwrite's API, providing tools to manage databases, users, functions, teams, and other resources within Appwrite projects.Last updated -8436PythonMIT License
- -securityAlicense-qualityA Model Context Protocol server that enables AI agents to interact with ClickUp workspaces, allowing task creation, management, and workspace organization through natural language commands.Last updated -203MIT License
- -securityAlicense-qualityA Model Context Protocol server that enables AI assistants to interact with Fingertip's site management capabilities, allowing them to list, view details of, and create websites.Last updated -1TypeScriptMIT License
- -security-license-qualityA Model Context Protocol server implementation that enables AI assistants to interact with Linear project management systems, allowing them to create, retrieve, and modify data related to issues, projects, teams, and users.Last updated -202TypeScript