touchdesigner-mcp-server 0.2.6 → 0.2.8

package/README.ja.md

@@ -6,7 +6,7 @@ TouchDesignerのためのMCP(Model Context Protocol) サーバー実装です。
 
 ## 概要
 
-![demo](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/nodes_list.png)
+[![demo clip](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/particle_on_youtube.png)](https://youtu.be/V2znaqGU7f4?si=6HDFbcBHCFPdttkM&t=635)
 
 TouchDesigner MCPは、AIモデルとTouchDesigner WebServer DAT 間のブリッジとして機能し、AIエージェントが以下のことが可能になります
 - ノードの作成、変更、削除
@@ -17,8 +17,11 @@ TouchDesigner MCPは、AIモデルとTouchDesigner WebServer DAT 間のブリッ
 
 *Node.js がインストールされていることが前提となります*
 
+[![tutorial](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/tutorial.png)](https://www.youtube.com/watch?v=jFaUP1fYum0)
+
 ### 1. touchdesigner-mcp-server パッケージのインストール
 
+`mkdir some && cd ./some` *（必要に応じて作成）*
 `npm install touchdesigner-mcp-server`
 
 ### 2. TouchDesignerとの接続
@@ -32,10 +35,9 @@ tox のimport により `td/import_modules.py` スクリプトが動作し、API
 
 ![import](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/import.png)
 
-#### APIサーバの動作確認
-`npm run test` を実行することでMCPサーバーコードのユニットテストと TouchDesigner への接続テストが実行されます。
-このテストでは `td/modules` ディレクトリ内のPythonモジュールが `mcp_webserver_base` コンポーネントからアクセス可能であることを確認します。
-TouchDesigner のメニューから Textportを起動すると通信のログを確認することができます。
+TouchDesigner のメニューから Textportを起動してサーバーの起動ログを確認することができます。
+
+![import](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/textport.png)
 
 ### 3. TouchDesigner MCP Server の設定
 TouchDesignerが起動した状態で、AIエージェント（Claude Desktop,Cursor, VSCode CopilotChatなど）をMCPサーバーに接続するように設定します。
@@ -46,7 +48,7 @@ TouchDesignerが起動した状態で、AIエージェント（Claude Desktop,Cu
   "mcpServers": {
     "touchdesigner": {
       "args": [
-        "/path/to/your/touchdesigner-mcp-server/dist/index.js", // <-- touchdesigner-mcp-server/dist/index.js への絶対パスに置き換えてください
+        "/path/to/your/node_modules/touchdesigner-mcp-server/dist/index.js", // <-- node_modules/touchdesigner-mcp-server/dist/index.js への絶対パスに置き換えてください
         "--stdio"
       ],
       "command": "node",
@@ -56,10 +58,14 @@ TouchDesignerが起動した状態で、AIエージェント（Claude Desktop,Cu
 }
 ```
 
+*Windows環境では C:\\ の様にドライブレターを含めてください。 例. `C:\\path\\to\\your\\node_modules\\touchdesigner-mcp-server\\dist\\index.js`*
+
 MCPサーバーが認識されていればセットアップは完了です。
+認識されない場合はAIエージェントを再起動するなどしてください。
 起動時にエラーが表示される場合はTouchDesignerを先に起動してから再度エージェントを起動してください。
 TouchDesigner で APIサーバーが実行されていれば、エージェントは提供された TouchDesigner ツールを通じてTouchDesignerを使用できます。
 
+![demo](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/nodes_list.png)
 
 ## MCPサーバーの機能
 
@@ -167,6 +173,8 @@ TouchDesignerが起動した状態で、AIエージェント（Cursor, Claude De
 }
 ```
 
+*Windows環境では C:\\ の様にドライブレターを含めてください。 例. `C:\\path\\to\\your\\touchdesigner-mcp\\dist\\index.js`*
+
 ### セットアップ後のプロジェクト構造概要
 
 ```

package/README.md

@@ -6,7 +6,7 @@ This is an implementation of an MCP (Model Context Protocol) server for TouchDes
 
 ## Overview
 
-![demo](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/nodes_list.png)
+[![demo clip](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/particle_on_youtube.png)](https://youtu.be/V2znaqGU7f4?si=6HDFbcBHCFPdttkM&t=635)
 
 TouchDesigner MCP acts as a bridge between AI models and the TouchDesigner WebServer DAT, enabling AI agents to:
 - Create, modify, and delete nodes
@@ -17,8 +17,11 @@ TouchDesigner MCP acts as a bridge between AI models and the TouchDesigner WebSe
 
 *Requires Node.js to be installed*
 
+[![tutorial](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/tutorial.png)](https://www.youtube.com/watch?v=jFaUP1fYum0)
+
 ### 1. Install the touchdesigner-mcp-server package
 
+`mkdir some && cd ./some` *(If you need)*
 `npm install touchdesigner-mcp-server`
 
 ### 2. Connect to TouchDesigner
@@ -32,10 +35,9 @@ Importing the tox will trigger the `td/import_modules.py` script, which loads mo
 
 ![import](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/import.png)
 
-#### Verify API server operation
-Run `npm run test` to execute unit tests for the MCP server code and connection tests to TouchDesigner.
-This test ensures that the Python modules in the `td/modules` directory are accessible from the `mcp_webserver_base` component.
-You can check communication logs by opening the Textport from the TouchDesigner menu.
+You can check boot logs by opening the Textport from the TouchDesigner menu.
+
+![import](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/textport.png)
 
 ### 3. Configure the TouchDesigner MCP Server
 With TouchDesigner running, configure your AI agent (Claude Desktop, Cursor, VSCode CopilotChat, etc.) to connect to the MCP server.
@@ -46,7 +48,7 @@ With TouchDesigner running, configure your AI agent (Claude Desktop, Cursor, VSC
   "mcpServers": {
     "touchdesigner": {
       "args": [
-        "/path/to/your/touchdesigner-mcp-server/dist/index.js", // <-- Replace with the absolute path to touchdesigner-mcp-server/dist/index.js
+        "/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
         "--stdio"
       ],
       "command": "node",
@@ -56,10 +58,15 @@ With TouchDesigner running, configure your AI agent (Claude Desktop, Cursor, VSC
 }
 ```
 
+*On Windows system, please include the drive letter such as C: e.g. `C:\\path\\to\\your\\node_modules\\touchdesigner-mcp-server\\dist\\index.js`*
+
 If the MCP server is recognized, setup is complete.
+Restart the agent, if not recognized.
 If you see an error at startup, try launching the agent again after starting TouchDesigner.
 If the API server is running in TouchDesigner, the agent can use TouchDesigner via the provided tools.
 
+![demo](https://github.com/8beeeaaat/touchdesigner-mcp/blob/main/assets/nodes_list.png)
+
 
 ## MCP Server Features
 
@@ -167,6 +174,8 @@ With TouchDesigner running, configure your AI agent (Cursor, Claude Desktop, VSC
 }
 ```
 
+*On Windows system, please include the drive letter such as C: e.g. `C:\\path\\to\\your\\touchdesigner-mcp\\dist\\index.js`*
+
 ### Project Structure After Setup
 
 ```

package/dist/gen/endpoints/TouchDesignerAPI.js

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * TouchDesigner API
  * OpenAPI schema for generating TouchDesigner API client code
- * OpenAPI spec version: 0.2.6
+ * OpenAPI spec version: 0.2.8
  */
 import { customInstance } from '../../api/customInstance.js';
 // eslint-disable-next-line @typescript-eslint/no-redeclare

package/dist/gen/mcp/touchDesignerAPI.zod.js

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * TouchDesigner API
  * OpenAPI schema for generating TouchDesigner API client code
- * OpenAPI spec version: 0.2.6
+ * OpenAPI spec version: 0.2.8
  */
 import { z as zod } from 'zod';
 /**

package/dist/server/touchDesignerServer.js

@@ -18,7 +18,7 @@ export class TouchDesignerServer {
     constructor() {
         this.server = new McpServer({
             name: "TouchDesigner",
-            version: "0.2.6",
+            version: "0.2.8",
         }, {
             capabilities: {
                 prompts: {},

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "touchdesigner-mcp-server",
-	"version": "0.2.6",
+	"version": "0.2.8",
 	"description": "MCP server for TouchDesigner",
 	"repository": {
 		"type": "git",
@@ -29,7 +29,7 @@
 	"devDependencies": {
 		"@biomejs/biome": "1.9.4",
 		"@types/jsdom": "^21.1.7",
-		"@types/node": "^22.15.2",
+		"@types/node": "^22.15.3",
 		"@vitest/coverage-v8": "^3.1.2",
 		"msw": "^2.7.5",
 		"mustache": "^4.2.0",

package/td/modules/td_server/openapi_server/openapi/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.0
 info:
   description: OpenAPI schema for generating TouchDesigner API client code
   title: TouchDesigner API
-  version: 0.2.6
+  version: 0.2.8
 servers:
 - url: "{baseUrl}"
   variables: