touchdesigner-mcp-server 0.2.10 → 0.2.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,112 +17,116 @@ TouchDesigner MCP acts as a bridge between AI models and the TouchDesigner WebSe
|
|
|
17
17
|
|
|
18
18
|
*Requires Docker or Node.js to be installed*
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
<details>
|
|
21
|
+
<summary>Method 1: Using Docker Image (Recommended)</summary>
|
|
21
22
|
|
|
22
|
-
[](https://www.youtube.com/watch?v=BRWoIEVb0TU)
|
|
23
|
+
[](https://www.youtube.com/watch?v=BRWoIEVb0TU)
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
git clone https://github.com/8beeeaaat/touchdesigner-mcp.git
|
|
27
|
-
cd touchdesigner-mcp
|
|
28
|
-
```
|
|
25
|
+
#### 1. Clone the repository:
|
|
26
|
+
```bash
|
|
27
|
+
git clone https://github.com/8beeeaaat/touchdesigner-mcp.git
|
|
28
|
+
cd touchdesigner-mcp
|
|
29
|
+
```
|
|
29
30
|
|
|
30
|
-
|
|
31
|
-
Copy the template file and adjust the TD_WEB_SERVER_HOST and TD_WEB_SERVER_PORT as needed before building the Docker image.
|
|
31
|
+
#### 2. Set up the environment file and build:
|
|
32
|
+
Copy the template file and adjust the TD_WEB_SERVER_HOST and TD_WEB_SERVER_PORT as needed before building the Docker image.
|
|
32
33
|
|
|
33
|
-
```bash
|
|
34
|
-
cp dotenv .env
|
|
35
|
-
make build
|
|
36
|
-
```
|
|
34
|
+
```bash
|
|
35
|
+
cp dotenv .env
|
|
36
|
+
make build
|
|
37
|
+
```
|
|
37
38
|
|
|
38
|
-
|
|
39
|
+
#### 3. Install the API Server in Your TouchDesigner Project:
|
|
39
40
|
|
|
40
|
-
Start TouchDesigner and import the `td/mcp_webserver_base.tox` component directly under the TouchDesigner project you want to control.
|
|
41
|
-
Example: Place it as `/project1/mcp_webserver_base`
|
|
41
|
+
Start TouchDesigner and import the `td/mcp_webserver_base.tox` component directly under the TouchDesigner project you want to control.
|
|
42
|
+
Example: Place it as `/project1/mcp_webserver_base`
|
|
42
43
|
|
|
43
|
-
Importing the tox will trigger the `td/import_modules.py` script, which loads modules such as API server controllers.
|
|
44
|
+
Importing the tox will trigger the `td/import_modules.py` script, which loads modules such as API server controllers.
|
|
44
45
|
|
|
45
|
-
|
|
46
|
+
|
|
46
47
|
|
|
47
|
-
You can check boot logs by opening the Textport from the TouchDesigner menu.
|
|
48
|
+
You can check boot logs by opening the Textport from the TouchDesigner menu.
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
|
|
50
51
|
|
|
51
|
-
|
|
52
|
+
#### 4. Start the MCP server container
|
|
52
53
|
|
|
53
|
-
```bash
|
|
54
|
-
docker-compose up -d
|
|
55
|
-
```
|
|
54
|
+
```bash
|
|
55
|
+
docker-compose up -d
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
#### 5. Configure your AI agent to use the Docker container:
|
|
56
59
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
{
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
]
|
|
60
|
+
*Example for Claude Desktop*
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"mcpServers": {
|
|
64
|
+
"touchdesigner": {
|
|
65
|
+
"command": "docker",
|
|
66
|
+
"args": [
|
|
67
|
+
"compose",
|
|
68
|
+
"-f",
|
|
69
|
+
"/path/to/your/touchdesigner-mcp/docker-compose.yml",
|
|
70
|
+
"exec",
|
|
71
|
+
"-i",
|
|
72
|
+
"touchdesigner-mcp-server",
|
|
73
|
+
"node",
|
|
74
|
+
"dist/index.js",
|
|
75
|
+
"--stdio"
|
|
76
|
+
]
|
|
77
|
+
}
|
|
76
78
|
}
|
|
77
79
|
}
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
+
```
|
|
80
81
|
|
|
81
|
-
*On Windows systems, include the drive letter like C: e.g. `C:\\path\\to\\your\\touchdesigner-mcp\\docker-compose.yml`*
|
|
82
|
+
*On Windows systems, include the drive letter like C: e.g. `C:\\path\\to\\your\\touchdesigner-mcp\\docker-compose.yml`*
|
|
83
|
+
</details>
|
|
82
84
|
|
|
83
|
-
|
|
85
|
+
<details>
|
|
86
|
+
<summary>Method 2: Using the NPM Package</summary>
|
|
84
87
|
|
|
85
|
-
To use the pre-built JS directly from Node.js:
|
|
88
|
+
To use the pre-built JS directly from Node.js:
|
|
86
89
|
|
|
87
|
-
[](https://www.youtube.com/watch?v=jFaUP1fYum0)
|
|
90
|
+
[](https://www.youtube.com/watch?v=jFaUP1fYum0)
|
|
88
91
|
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
mkdir some && cd ./some # If you need a new directory
|
|
92
|
-
npm install touchdesigner-mcp-server
|
|
93
|
-
```
|
|
92
|
+
#### 1. Install the package
|
|
93
|
+
```bash
|
|
94
|
+
mkdir some && cd ./some # If you need a new directory
|
|
95
|
+
npm install touchdesigner-mcp-server
|
|
96
|
+
```
|
|
94
97
|
|
|
95
|
-
|
|
98
|
+
#### 2. Install the API Server in Your TouchDesigner Project:
|
|
96
99
|
|
|
97
|
-
Start TouchDesigner and import the `some/node_modules/touchdesigner-mcp-server/td/mcp_webserver_base.tox` component directly under the TouchDesigner project you want to control.
|
|
98
|
-
Example: Place it as `/project1/mcp_webserver_base`
|
|
100
|
+
Start TouchDesigner and import the `some/node_modules/touchdesigner-mcp-server/td/mcp_webserver_base.tox` component directly under the TouchDesigner project you want to control.
|
|
101
|
+
Example: Place it as `/project1/mcp_webserver_base`
|
|
99
102
|
|
|
100
|
-
Importing the tox will trigger the `some/node_modules/touchdesigner-mcp-server/td/import_modules.py` script, which loads modules such as API server controllers.
|
|
103
|
+
Importing the tox will trigger the `some/node_modules/touchdesigner-mcp-server/td/import_modules.py` script, which loads modules such as API server controllers.
|
|
101
104
|
|
|
102
|
-
|
|
105
|
+
|
|
103
106
|
|
|
104
|
-
You can check boot logs by opening the Textport from the TouchDesigner menu.
|
|
107
|
+
You can check boot logs by opening the Textport from the TouchDesigner menu.
|
|
105
108
|
|
|
106
|
-
|
|
109
|
+
|
|
107
110
|
|
|
108
|
-
|
|
111
|
+
#### 3. Configure your AI agent:
|
|
109
112
|
|
|
110
|
-
*Example for Claude Desktop*
|
|
111
|
-
```json
|
|
112
|
-
{
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
113
|
+
*Example for Claude Desktop*
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"mcpServers": {
|
|
117
|
+
"touchdesigner": {
|
|
118
|
+
"args": [
|
|
119
|
+
"/path/to/your/node_modules/touchdesigner-mcp-server/dist/index.js", // <-- Replace with the absolute path to node_modules/touchdesigner-mcp-server/dist/index.js
|
|
120
|
+
"--stdio"
|
|
121
|
+
],
|
|
122
|
+
"command": "node"
|
|
123
|
+
}
|
|
120
124
|
}
|
|
121
125
|
}
|
|
122
|
-
|
|
123
|
-
```
|
|
126
|
+
```
|
|
124
127
|
|
|
125
|
-
*On Windows systems, include the drive letter like C: e.g. `C:\\path\\to\\your\\node_modules\\touchdesigner-mcp-server\\dist\\index.js`*
|
|
128
|
+
*On Windows systems, include the drive letter like C: e.g. `C:\\path\\to\\your\\node_modules\\touchdesigner-mcp-server\\dist\\index.js`*
|
|
129
|
+
</details>
|
|
126
130
|
|
|
127
131
|
### 3. Verify Connection
|
|
128
132
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* TouchDesigner API
|
|
5
5
|
* OpenAPI schema for generating TouchDesigner API client code
|
|
6
|
-
* OpenAPI spec version: 0.2.
|
|
6
|
+
* OpenAPI spec version: 0.2.11
|
|
7
7
|
*/
|
|
8
8
|
import { customInstance } from '../../api/customInstance.js';
|
|
9
9
|
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "touchdesigner-mcp-server",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.11",
|
|
4
4
|
"description": "MCP server for TouchDesigner",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"type": "module",
|
|
44
44
|
"main": "src/index.ts",
|
|
45
45
|
"bin": {
|
|
46
|
-
"mcp-server": "dist/index.js"
|
|
46
|
+
"touchdesigner-mcp-server": "dist/index.js"
|
|
47
47
|
},
|
|
48
48
|
"scripts": {
|
|
49
49
|
"build": "run-s build:*",
|