项目简介
TouchDesigner MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,旨在通过标准化的方式,使AI代理(如Claude Desktop, Cursor, VSCode CopilotChat等MCP兼容客户端)能够与TouchDesigner实时视觉开发环境进行交互和控制。它作为一个桥梁,将AI的能力延伸到创意编程和媒体艺术领域。
主要功能点
- 工具 (Tools): 提供一系列预定义的工具,允许AI直接执行TouchDesigner中的操作。这些工具包括:
- 创建、删除和修改节点。
- 查询项目结构和节点属性。
- 直接在TouchDesigner中执行Python脚本。
- 获取TouchDesigner环境信息。
- Prompt模板 (Prompts): 定义了指导AI执行特定任务的对话模式。例如:
- 根据名称、类型或族群模糊搜索节点。
- 指导AI连接不同的节点。
- 检查指定节点(及其子节点)的错误信息。
- 资源 (Resources): (当前版本尚未实现)
安装步骤
- 安装Node.js: 确保您的系统中已安装Node.js。
- 安装MCP服务器包: 打开终端或命令提示符,运行以下命令安装服务器端程序:
(注:README中指示在仓库目录内安装,但为了全局使用,通常会全局安装或使用npx执行。此处的'-g'为全局安装示例)npm install touchdesigner-mcp-server -g - 设置TouchDesigner:
- 启动TouchDesigner。
- 将仓库目录中的 'td/mcp_webserver_base.tox' 组件导入到TouchDesigner项目的'/project1'下(例如,路径为'/project1/mcp_webserver_base')。
- 导入 'tox' 文件会触发自动加载所需的Python模块。
- 验证连接 (可选但推荐): 运行仓库目录中的测试命令 'npm run test' 来验证MCP服务器代码和与TouchDesigner的连接是否正常。
服务器配置(供MCP客户端使用)
配置您的AI代理(MCP客户端,如Claude Desktop)以连接到TouchDesigner MCP服务器。您需要在客户端的MCP服务器配置文件中添加以下信息:
{ "mcpServers": { "touchdesigner": { // 服务器名称,您可以自定义 "command": "node", // 用于启动服务器的可执行程序 "args": [ "/path/to/your/touchdesigner-mcp-server/dist/index.js", // <-- 替换为您实际安装的 touchdesigner-mcp-server 包中 index.js 文件的绝对路径 "--stdio" // 指定使用标准输入/输出作为传输协议 ], "transportType": "stdio" // 传输协议类型 } // ... 可能有其他MCP服务器配置 } }
将 '"args"' 中的路径替换为您系统中 'touchdesigner-mcp-server' 包内 'dist/index.js' 的实际绝对路径。保存客户端的配置文件后,重新启动AI代理。
基本使用方法
配置完成后,如果TouchDesigner正在运行且 'mcp_webserver_base.tox' 已成功加载并其内部的WebServer DAT处于活动状态,AI代理将能够发现并连接到TouchDesigner MCP服务器。
您现在可以通过与AI代理对话,利用服务器暴露的工具和Prompt模板,让AI控制和操作TouchDesigner项目。例如,您可以尝试让AI创建一个新的节点,查询某个节点的参数,或者执行一段Python脚本来改变场景。
例如,您可以对AI说:“在 '/project1' 下创建一个名为 'my_text_top' 的 'textTOP' 节点。”AI可能会调用 'create_td_node' 工具来执行此操作。
信息
分类
桌面与硬件