npm - touchdesigner-mcp-server - Versions diffs - 0.2.1 → 0.2.3 - Mend

touchdesigner-mcp-server 0.2.1 → 0.2.3

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.

Files changed (9) hide show

package/README.ja.md +109 -80
package/README.md +156 -120
package/dist/gen/endpoints/TouchDesignerAPI.js +1 -125
package/dist/gen/mcp/touchDesignerAPI.zod.js +1 -1
package/dist/server/touchDesignerServer.js +1 -1
package/package.json +1 -2
package/td/modules/td_server/openapi_server/openapi/openapi.yaml +1 -1
package/dist/mock/index.js +0 -5
package/dist/mock/node.js +0 -3

package/README.ja.md CHANGED Viewed

@@ -4,20 +4,100 @@ TouchDesignerのためのMCP(Model Context Protocol) サーバー実装です。
 ## 概要
-![スクリーンショット 2025-04-14 21 45 47](https://github.com/user-attachments/assets/b7130ebe-406c-4e05-9efc-5d493eb800cb)
+![demo](https://github.com/user-attachments/assets/333b7db8-ebcb-4ac2-812e-c2174fa4bb2b)
 TouchDesigner MCPは、AIモデルとTouchDesigner WebServer DAT 間のブリッジとして機能し、AIエージェントが以下のことが可能になります
 - ノードの作成、変更、削除
 - ノードプロパティやプロジェクト構造の照会
 - PythonスクリプトによるTouchDesignerのプログラム的制御
-## 前提条件
+## 利用方法
-- Node.js（最新のLTSバージョンを推奨）
-- TouchDesigner（最新の安定版を推奨）
-- Docker（Pythonサーバーコードの生成に必要）
+*Node.js がインストールされていることが前提となります*
-## MCPサーバーコードのビルド
+### 1. touchdesigner-mcp-server パッケージのインストール
+`npm install touchdesigner-mcp-server`
+### 2. TouchDesignerとの接続
+#### mcp_webserver_base.tox を TouchDesigner に配置
+TouchDesignerを起動し、`td/mcp_webserver_base.tox` コンポーネントをTouchDesignerプロジェクト直下にimportします。
+例: `/project1/mcp_webserver_base` となるように配置
+tox のimport により `td/import_modules.py` スクリプトが動作し、APIサーバのコントローラなどのモジュールがロードされます。
+![import](https://github.com/user-attachments/assets/46c97e13-4a26-4437-84d3-3a306e56462b)
+#### APIサーバの動作確認
+`npm run test` を実行することでMCPサーバーコードのユニットテストと TouchDesigner への接続テストが実行されます。
+このテストでは `td/modules` ディレクトリ内のPythonモジュールが `mcp_webserver_base` コンポーネントからアクセス可能であることを確認します。
+TouchDesigner のメニューから Textportを起動すると通信のログを確認することができます。
+### 3. TouchDesigner MCP Server の設定
+TouchDesignerが起動した状態で、AIエージェント（Claude Desktop,Cursor, VSCode CopilotChatなど）をMCPサーバーに接続するように設定します。
+*例 Claude Desktop*
+```json
+{
+  "mcpServers": {
+    "touchdesigner": {
+      "args": [
+        "/path/to/your/touchdesigner-mcp-server/dist/index.js", // <-- touchdesigner-mcp-server/dist/index.js への絶対パスに置き換えてください
+        "--stdio"
+      ],
+      "command": "node",
+      "transportType": "stdio"
+    }
+  }
+}
+```
+MCPサーバーが認識されていればセットアップは完了です。
+起動時にエラーが表示される場合はTouchDesignerを先に起動してから再度エージェントを起動してください。
+TouchDesigner で APIサーバーが実行されていれば、エージェントは提供された TouchDesigner ツールを通じてTouchDesignerを使用できます。
+## MCPサーバーの機能
+このサーバーは、Model Context Protocol (MCP) を通じてTouchDesigner への操作、および各種実装ドキュメントへの参照を可能にします。
+### ツール (Tools)
+ツールは、AIエージェントがTouchDesignerでアクションを実行できるようにします。
+| ツール名                    | 説明                                           |
+| :-------------------------- | :--------------------------------------------- |
+| `create_td_node`            | 新しいノードを作成します。                     |
+| `delete_td_node`            | 既存のノードを削除します。                     |
+| `exec_node_method`| ノードに対しPythonメソッドを呼び出します。       |
+| `execute_python_script`     | TD内で任意のPythonスクリプトを実行します。     |
+| `get_td_class_details`      | TD Pythonクラス/モジュールの詳細情報を取得します。 |
+| `get_td_classes`            | TouchDesigner Pythonクラスのリストを取得します。 |
+| `get_td_info`           | TDサーバー環境に関する情報を取得します。       |
+| `get_td_node_parameters`    | 特定ノードのパラメータを取得します。           |
+| `get_td_nodes`              | 親パス内のノードを取得します（オプションでフィルタリング）。 |
+| `update_td_node_parameters` | 特定ノードのパラメータを更新します。           |
+### プロンプト (Prompts)
+プロンプトは、AIエージェントがTouchDesignerで特定のアクションを実行するための指示を提供します。
+| プロンプト名                | 説明                                           |
+| :-------------------------- | :--------------------------------------------- |
+| `Search node`               | ノードをファジー検索し、指定されたノード名、ファミリー、タイプに基づいて情報を取得します。 |
+| `Node connection`          | TouchDesigner内でノード同士を接続するための指示を提供します。 |
+| `Check node errors`               | 指定されたノードのエラーをチェックします。子ノードがあれば再帰的にチェックします。           |
+### リソース (Resources)
+未実装
+## 開発者向け
+### MCPサーバーコードのビルド
 1. リポジトリのクローン
 ```bash
@@ -39,22 +119,23 @@ cp dotenv .env
 npm run build
 ```
-## 使い方
 ### TouchDesignerのセットアップ
-1.  **コード生成:**
-[MCPサーバーコードのビルド](#MCPサーバーコードのビルド) を参考に、プロジェクトルートで `npm run build` を実行します。これにより以下のコードが生成されます。
+#### 1.  **コード生成:**
+`npm run build` を実行します。これにより以下のコードが生成されます。
 - MCPサーバコード
 - TouchDesigner WebSever DAT向けのAPIサーバーコード
-2.  **TouchDesigner に MCPサーバー向けWebServerをインポートする:**
+#### 2.  **TouchDesigner に MCPサーバー向けWebServerをインポートする:**
 TouchDesignerを起動し、`td/mcp_webserver_base.tox` コンポーネントをTouchDesignerプロジェクト直下にimportします。
 tox のimport により `td/import_modules.py` スクリプトが動作し、APIサーバのコントローラなどのモジュールがロードされます。
-3.  **APIサーバの動作確認:**
+#### 3.  **APIサーバの動作確認:**
 `td/modules` ディレクトリ内のPythonモジュールが `mcp_webserver_base` コンポーネントからアクセス可能であることを確認します。
 `npm run test` を実行することでMCPサーバーコードのユニットテストと TouchDesigner への結合テストが実行されます。
-TOuchDesigner のメニューから Textportを起動すると通信のログを確認することができます。
+TouchDesigner のメニューから Textportを起動すると通信のログを確認することができます。
+`npm run dev` で @modelcontextprotocol/inspector させデバッグすることができます。
 *TIPS*
 `mcp_webserver_base.tox` には、MCPサーバーとTouchDesignerを連携させるように設定された WebServer DAT が含まれています。
@@ -68,23 +149,23 @@ TOuchDesigner のメニューから Textportを起動すると通信のログを
 TouchDesignerが起動した状態で、AIエージェント（Cursor, Claude Desktop, VSCode CopilotChatなど）をMCPサーバーに接続するように設定します。
+#### 例. Claude Desktop
 ```json
-// 設定例（例：VS Code settings.json の Copilot Chat 用）
-"github.copilot.advanced": {
-    "touchdesigner": {
-        "command": "node",
-        "args": [
-            "/path/to/your/touchdesigner-mcp/dist/index.js", // <-- npm run buildによって生成された dist/index.js への絶対パスに置き換えてください
-            "--stdio"
-        ],
-        "transportType": "stdio"
+{
+  "mcpServers": {
+    "dev_touchdesigner": {
+      "args": [
+        "/path/to/your/touchdesigner-mcp/dist/index.js", // <-- ビルド後の /dist/index.js への絶対パスに置き換えてください
+        "--stdio"
+      ],
+      "command": "node",
+      "transportType": "stdio"
     }
+  }
 }
 ```
-TouchDesigner で APIサーバーが実行されていれば、エージェントは提供された TouchDesigner ツールを通じてTouchDesignerを使用できます。
-## セットアップ後のプロジェクト構造概要
+### セットアップ後のプロジェクト構造概要
 ```
 ├── src/                       # MCPサーバー ソースコード
@@ -118,58 +199,6 @@ TouchDesigner で APIサーバーが実行されていれば、エージェン
 └── orval.config.ts             # Orval 設定 (TSクライアント生成)
 ```
-## MCPサーバーの機能
-このサーバーは、Model Context Protocol (MCP) を通じてTouchDesigner への操作、および各種実装ドキュメントへの参照を可能にします。
-### ツール (Tools)
-ツールは、AIエージェントがTouchDesignerでアクションを実行できるようにします。
-| ツール名                    | 説明                                           |
-| :-------------------------- | :--------------------------------------------- |
-| `create_td_node`            | 新しいノードを作成します。                     |
-| `delete_td_node`            | 既存のノードを削除します。                     |
-| `exec_node_method`| ノードに対しPythonメソッドを呼び出します。       |
-| `execute_python_script`     | TD内で任意のPythonスクリプトを実行します。     |
-| `get_td_class_details`      | TD Pythonクラス/モジュールの詳細情報を取得します。 |
-| `get_td_classes`            | TouchDesigner Pythonクラスのリストを取得します。 |
-| `get_td_info`           | TDサーバー環境に関する情報を取得します。       |
-| `get_td_node_parameters`    | 特定ノードのパラメータを取得します。           |
-| `get_td_nodes`              | 親パス内のノードを取得します（オプションでフィルタリング）。 |
-| `update_td_node_parameters` | 特定ノードのパラメータを更新します。           |
-### プロンプト (Prompts)
-プロンプトは、AIエージェントがTouchDesignerで特定のアクションを実行するための指示を提供します。
-| プロンプト名                | 説明                                           |
-| :-------------------------- | :--------------------------------------------- |
-| `Search node`               | ノードをファジー検索し、指定されたノード名、ファミリー、タイプに基づいて情報を取得します。 |
-| `Node connection`          | TouchDesigner内でノード同士を接続するための指示を提供します。 |
-| `Check node errors`               | 指定されたノードのエラーをチェックします。子ノードがあれば再帰的にチェックします。           |
-### リソース (Resources)
-未実装
-## 開発
-### 開発環境のセットアップ
-```bash
-# 依存関係のインストール
-npm install
-# リンターと型チェッカーの実行
-npm run lint
-# テストの実行
-npm test
-# デバッグ用にMCP Inspectorを使用してサーバーを起動
-npm run dev
-```
 ### APIコード生成ワークフロー
@@ -192,9 +221,9 @@ npm run dev
 ビルドプロセス (`npm run build`) は、必要なすべての生成ステップ (`npm run gen`) を実行し、その後にTypeScriptコンパイル (`tsc`) を行います。
-## 貢献
+## 開発で貢献
-貢献は歓迎します！貢献方法は以下の通りです：
+ぜひ一緒に改善しましょう！
 1. リポジトリをフォーク
 2. 機能ブランチを作成（`git checkout -b feature/amazing-feature`）
@@ -204,7 +233,7 @@ npm run dev
 6. ブランチにプッシュ（`git push origin feature/amazing-feature`）
 7. プルリクエストを開く
-プロジェクトのコーディング標準に従い、適切なテストを含めてください。
+実装の変更時は必ず適切なテストを含めてください。
 ## ライセンス

package/README.md CHANGED Viewed

@@ -1,91 +1,175 @@
 # TouchDesigner MCP
-TouchDesigner MCP is an implementation of the Model Context Protocol (MCP) server for TouchDesigner, aiming to enable AI agents to control and interact with TouchDesigner projects.
+This is an implementation of an MCP (Model Context Protocol) server for TouchDesigner. The goal is to enable AI agents to control and operate TouchDesigner projects.
 ## Overview
-![スクリーンショット 2025-04-14 21 45 47](https://github.com/user-attachments/assets/b7130ebe-406c-4e05-9efc-5d493eb800cb)
+![demo](https://github.com/user-attachments/assets/333b7db8-ebcb-4ac2-812e-c2174fa4bb2b)
-TouchDesigner MCP acts as a bridge between AI models and the TouchDesigner WebServer DAT, allowing AI agents to:
+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 using Python scripts
+- Programmatically control TouchDesigner via Python scripts
-## Prerequisites
+## Usage
+*Requires Node.js to be installed*
+### 1. Install the touchdesigner-mcp-server package
+`npm install touchdesigner-mcp-server`
+### 2. Connect to TouchDesigner
+#### Place mcp_webserver_base.tox in TouchDesigner
+Start TouchDesigner and import the `td/mcp_webserver_base.tox` component directly under your TouchDesigner project.
+Example: Place it as `/project1/mcp_webserver_base`
+Importing the tox will trigger the `td/import_modules.py` script, which loads modules such as API server controllers.
+![import](https://github.com/user-attachments/assets/46c97e13-4a26-4437-84d3-3a306e56462b)
+#### 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.
+### 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.
+*Example: Claude Desktop*
+```json
+{
+  "mcpServers": {
+    "touchdesigner": {
+      "args": [
+        "/path/to/your/touchdesigner-mcp-server/dist/index.js", // <-- Replace with the absolute path to touchdesigner-mcp-server/dist/index.js
+        "--stdio"
+      ],
+      "command": "node",
+      "transportType": "stdio"
+    }
+  }
+}
+```
+If the MCP server is recognized, setup is complete.
+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.
+## MCP Server Features
+This server enables operations on TouchDesigner via the Model Context Protocol (MCP) and provides references to various implementation documents.
+### Tools
+Tools allow AI agents to perform actions in TouchDesigner.
+| Tool Name                | Description                                                        |
+| :---------------------- | :----------------------------------------------------------------- |
+| `create_td_node`        | Create a new node.                                                 |
+| `delete_td_node`        | Delete an existing node.                                           |
+| `exec_node_method`      | Call a Python method on a node.                                    |
+| `execute_python_script` | Execute an arbitrary Python script in TD.                          |
+| `get_td_class_details`  | Get details of a TD Python class/module.                           |
+| `get_td_classes`        | Get a list of TouchDesigner Python classes.                        |
+| `get_td_info`           | Get information about the TD server environment.                   |
+| `get_td_node_parameters`| Get parameters of a specific node.                                 |
+| `get_td_nodes`          | Get nodes under a parent path (optionally filtered).               |
+| `update_td_node_parameters` | Update parameters of a specific node.                        |
+### Prompts
+Prompts provide instructions for AI agents to perform specific actions in TouchDesigner.
+| Prompt Name         | Description                                                                 |
+| :------------------| :-------------------------------------------------------------------------- |
+| `Search node`      | Fuzzy search for nodes and retrieve information based on name, family, type. |
+| `Node connection`  | Provide instructions to connect nodes within TouchDesigner.                 |
+| `Check node errors`| Check errors for a specified node, recursively for child nodes if any.      |
+### Resources
-- Node.js (latest LTS version recommended)
-- TouchDesigner (latest stable version recommended)
-- Docker (Required for generating Python server code)
+Not implemented
-## Building the MCP Server Code
-1. Clone the repository:
+## For Developers
+### Building the MCP Server Code
+1. Clone the repository
 ```bash
 git clone https://github.com/8beeeaaat/touchdesigner-mcp.git
 ```
-2. Install dependencies:
+2. Install dependencies
 ```bash
 cd touchdesigner-mcp
 npm install
 ```
-3. Set up environment configuration and build:
-```bash
-# Copy the template and adjust TD_WEB_SERVER_URL if needed
+3. Set up environment file and build
+```
+# Copy the template and adjust TD_WEB_SERVER_URL as needed
 cp dotenv .env
-# Build the project (Generates API clients/servers and compiles MCP resources)
-# Ensure Docker daemon is running before executing this command
+# Build the project (generates API client/server schemas and compiles MCP resources)
+# Make sure the Docker daemon is running before executing this command
 npm run build
 ```
-## Usage
-### Setting Up TouchDesigner
+### TouchDesigner Setup
-1.  **Generate Code:**
-Refer to [Building the MCP Server Code](#building-the-mcp-server-code) and run `npm run build` in the project root. This generates:
+#### 1. **Code Generation:**
+Run `npm run build` to generate the following code:
 - MCP server code
-- API server code for the TouchDesigner WebServer DAT
+- API server code for TouchDesigner WebServer DAT
+#### 2. **Import the WebServer for MCP server into TouchDesigner:**
+Start TouchDesigner and import the `td/mcp_webserver_base.tox` component directly under your project.
+Importing the tox will trigger the `td/import_modules.py` script, which loads modules such as API server controllers.
-2.  **Import MCP WebServer into TouchDesigner:**
-Launch TouchDesigner and import the `td/mcp_webserver_base.tox` component into your TouchDesigner project. The import triggers the `td/import_modules.py` script, which loads modules such as API server controllers.
+#### 3. **Verify API server operation:**
+Ensure that the Python modules in the `td/modules` directory are accessible from the `mcp_webserver_base` component.
+Run `npm run test` to execute unit and integration tests for the MCP server code and TouchDesigner connection.
+You can check communication logs by opening the Textport from the TouchDesigner menu.
-3.  **Verify API Server:**
-Ensure that the Python modules in the `td/modules` directory are accessible from the `mcp_webserver_base` component. Run `npm run test` to execute unit tests for the MCP server code and integration tests with TouchDesigner. You can view communication logs by opening the Textport from the TouchDesigner menu.
+You can debug with @modelcontextprotocol/inspector using `npm run dev`.
 *TIPS*
-The `mcp_webserver_base.tox` includes a WebServer DAT configured to integrate the MCP server with TouchDesigner. Ensure this DAT is active and running on the port specified in the `.env` file's `TD_WEB_SERVER_URL` (default: `9981`). To change the port:
-1. Update `TD_WEB_SERVER_PORT` in the `.env` file.
-2. Rebuild the project with `npm run build`.
-3. Update the port in the WebServer DAT and restart it.
+`mcp_webserver_base.tox` includes a WebServer DAT configured to link the MCP server and TouchDesigner.
+Ensure this DAT is active and running on the port specified by `TD_WEB_SERVER_URL` in your `.env` file (default: `9981`).
+To change the port:
+1. Change `TD_WEB_SERVER_PORT` in `.env`
+2. Re-run `npm run build`
+3. Change the port in mcp_webserver_base (WebServer DAT) and restart the DAT
-### Connecting to an MCP-Compatible AI Agent
+### Connecting with MCP-compatible AI Agents
-With TouchDesigner running, configure an AI agent (e.g., Cursor, Claude Desktop, VSCode CopilotChat) to connect to the MCP server.
+With TouchDesigner running, configure your AI agent (Cursor, Claude Desktop, VSCode CopilotChat, etc.) to connect to the MCP server.
+#### Example: Claude Desktop
 ```json
-// Example configuration (e.g., in VS Code settings.json for Copilot Chat)
-"github.copilot.advanced": {
-    "touchdesigner": {
-        "command": "node",
-        "args": [
-            "/path/to/your/touchdesigner-mcp/dist/index.js", // <-- Replace with the absolute path generated by npm run build
-            "--stdio"
-        ],
-        "transportType": "stdio"
+{
+  "mcpServers": {
+    "dev_touchdesigner": {
+      "args": [
+        "/path/to/your/touchdesigner-mcp/dist/index.js", // <-- Replace with the absolute path to /dist/index.js after build
+        "--stdio"
+      ],
+      "command": "node",
+      "transportType": "stdio"
     }
+  }
 }
 ```
-Once the API server is running in TouchDesigner, the agent can use the provided TouchDesigner tools.
-## Project Structure Overview
+### Project Structure After Setup
 ```
 ├── src/                       # MCP server source code
-│   ├── api/                  # OpenAPI specification for TD WebServer
+│   ├── api/                  # OpenAPI spec for TD WebServer
 │   ├── core/                 # Core utilities (logger, error handling)
 │   ├── features/             # MCP feature implementations
 │   │   ├── prompts/         # Prompt handlers
@@ -93,10 +177,10 @@ Once the API server is running in TouchDesigner, the agent can use the provided
 │   │   └── tools/           # Tool handlers (e.g., tdTools.ts)
 │   ├── gen/                  # Code generated from OpenAPI schema for MCP server
 │   ├── server/               # MCP server logic (connections, main server class)
-│   ├── tdClient/             # Client for TD connection API
-│   ├── index.ts              # Main entry point for the Node.js server
+│   ├── tdClient/             # TD connection API client
+│   ├── index.ts              # Main entry point for Node.js server
 │   └── ...
-├── td/                        # TouchDesigner-related files
+├── td/                        # TouchDesigner related files
 │   ├── modules/              # Python modules for TouchDesigner
 │   │   ├── mcp/              # Core logic for handling MCP requests in TD
 │   │   │   ├── controllers/ # API request controllers (api_controller.py, generated_handlers.py)
@@ -104,100 +188,52 @@ Once the API server is running in TouchDesigner, the agent can use the provided
 │   │   ├── td_server/        # Python model code generated from OpenAPI schema
 │   │   └── utils/            # Shared Python utilities
 │   ├── templates/             # Mustache templates for Python code generation
-│   ├── genHandlers.js         # Node.js script for generating Python handlers
-│   ├── import_modules.py      # Helper script for importing API server modules into TD
+│   ├── genHandlers.js         # Node.js script for generating generated_handlers.py
+│   ├── import_modules.py      # Helper script to import API server modules into TD
 │   └── mcp_webserver_base.tox # Main TouchDesigner component
 ├── tests/                      # Test code
 │   ├── integration/
 │   └── unit/
-├── .env                        # Local environment variables (gitignored)
+├── .env                        # Local environment variables (git ignored)
 ├── dotenv                      # Template for .env
-└── orval.config.ts             # Orval configuration (TS client generation)
+└── orval.config.ts             # Orval config (TS client generation)
 ```
-## MCP Server Features
-This server enables operations on TouchDesigner via the Model Context Protocol (MCP) and provides access to various tools.
-### Tools
-| Tool Name                   | Description                                           |
-| :-------------------------- | :--------------------------------------------------- |
-| `create_td_node`            | Creates a new node.                                  |
-| `delete_td_node`            | Deletes an existing node.                            |
-| `exec_node_method`          | Calls a Python method on a node.                     |
-| `execute_python_script`     | Executes an arbitrary Python script in TD.           |
-| `get_td_class_details`      | Retrieves details of TD Python classes/modules.      |
-| `get_td_classes`            | Lists TouchDesigner Python classes.                 |
-| `get_td_info`               | Retrieves information about the TD server environment. |
-| `get_td_node_parameters`    | Retrieves parameters of a specific node.             |
-| `get_td_nodes`              | Retrieves nodes within a parent path (optional filtering). |
-| `update_td_node_parameters` | Updates parameters of a specific node.               |
-### Prompts
-Prompts allow AI agents to perform specific actions in TouchDesigner.
-| Prompt Name                 | Description                                           |
-| :-------------------------- | :--------------------------------------------------- |
-| `Search node`               | Performs a fuzzy search for nodes based on name, family, or type. |
-| `Node connection`           | Provides instructions for connecting nodes in TouchDesigner. |
-| `Check node errors`         | Checks for errors in specified nodes, recursively if child nodes exist. |
-### Resources
-Not implemented.
-## Development
-### Setting Up the Development Environment
-```bash
-# Install dependencies
-npm install
-# Run linters and type checkers
-npm run lint
-# Run tests
-npm test
-# Start the server with MCP Inspector for debugging
-npm run dev
-```
 ### API Code Generation Workflow
 This project uses OpenAPI-based code generation tools (Orval / openapi-generator-cli):
-**API Definition:** The API contract between the Node.js MCP server and the Python server running in TouchDesigner is defined in `src/api/index.yml`.
+**API Definition:** The API contract between the Node.js MCP server and the Python server running inside TouchDesigner is defined in `src/api/index.yml`.
-1.  **Python Server Generation (`npm run gen:webserver`):**
-    *   Uses Docker to run `openapi-generator-cli`.
+1.  **Python server generation (`npm run gen:webserver`):**
+    *   Uses `openapi-generator-cli` via Docker.
     *   Reads `src/api/index.yml`.
-    *   Generates Python server skeleton (`td/modules/td_server/`) for the WebServer DAT in TouchDesigner.
+    *   Generates a Python server skeleton (`td/modules/td_server/`) based on the API definition. This code runs inside TouchDesigner via WebServer DAT.
     *   **Requires Docker to be installed and running.**
-2.  **Python Handler Generation (`npm run gen:handlers`):**
+2.  **Python handler generation (`npm run gen:handlers`):**
     *   Uses a custom Node.js script (`td/genHandlers.js`) and Mustache templates (`td/templates/`).
+    *   Reads the generated Python server code or OpenAPI spec.
     *   Generates handler implementations (`td/modules/mcp/controllers/generated_handlers.py`) that connect to business logic in `td/modules/mcp/services/api_service.py`.
-3.  **TypeScript Client Generation (`npm run gen:mcp`):**
-    *   Uses `Orval` to generate a TypeScript client (`src/tdClient/`) for the Node.js server to communicate with the Python server.
+3.  **TypeScript client generation (`npm run gen:mcp`):**
+    *   Uses `Orval` to generate API client code and Zod schemas for tool validation from the schema YAML bundled by `openapi-generator-cli`.
+    *   Generates a typed TypeScript client (`src/tdClient/`) used by the Node.js server to make requests to the WebServer DAT.
-The build process (`npm run build`) executes all generation steps (`npm run gen`) and compiles TypeScript (`tsc`).
+The build process (`npm run build`) runs all necessary generation steps (`npm run gen`), followed by TypeScript compilation (`tsc`).
 ## Contributing
-Contributions are welcome! Follow these steps:
+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 the branch (`git push origin feature/amazing-feature`).
-7. Open a Pull Request.
+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
-Ensure your code follows the project's coding standards and includes appropriate tests.
+Please always include appropriate tests when making implementation changes.
 ## License

package/dist/gen/endpoints/TouchDesignerAPI.js CHANGED Viewed

@@ -3,10 +3,8 @@
  * Do not edit manually.
  * TouchDesigner API
  * OpenAPI schema for generating TouchDesigner API client code
- * OpenAPI spec version: 0.2.1
+ * OpenAPI spec version: 0.2.3
  */
-import { faker } from '@faker-js/faker';
-import { HttpResponse, delay, http } from 'msw';
 import { customInstance } from '../../api/customInstance.js';
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TdNodeFamilyType = {
@@ -126,125 +124,3 @@ export const getTdInfo = (options) => {
     return customInstance({ url: `http://localhost:9981/api/td/server/td`, method: 'GET'
     }, options);
 };
-export const getDeleteNodeResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { deleted: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), node: faker.helpers.arrayElement([{ id: faker.number.int({ min: undefined, max: undefined }), opType: faker.string.alpha(20), name: faker.string.alpha(20), path: faker.string.alpha(20), properties: {} }, undefined]) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getGetNodesResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { nodes: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.number.int({ min: undefined, max: undefined }), opType: faker.string.alpha(20), name: faker.string.alpha(20), path: faker.string.alpha(20), properties: {} })), undefined]) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getCreateNodeResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { result: faker.helpers.arrayElement([{ id: faker.number.int({ min: undefined, max: undefined }), opType: faker.string.alpha(20), name: faker.string.alpha(20), path: faker.string.alpha(20), properties: {} }, undefined]) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getGetNodeDetailResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { id: faker.number.int({ min: undefined, max: undefined }), opType: faker.string.alpha(20), name: faker.string.alpha(20), path: faker.string.alpha(20), properties: {} }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getUpdateNodeResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { path: faker.helpers.arrayElement([faker.string.alpha(20), undefined]), updated: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.string.alpha(20))), undefined]), failed: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.helpers.arrayElement([faker.string.alpha(20), undefined]), reason: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) })), undefined]), message: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getGetTdPythonClassesResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { classes: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.string.alpha(20), type: faker.helpers.arrayElement(['class', 'module', 'function', 'object']), description: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) })), undefined]) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getGetTdPythonClassDetailsResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { name: faker.string.alpha(20), type: faker.helpers.arrayElement(['class', 'module', 'function', 'object']), description: faker.helpers.arrayElement([faker.string.alpha(20), undefined]), methods: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.string.alpha(20), signature: faker.helpers.arrayElement([faker.string.alpha(20), undefined]), description: faker.helpers.arrayElement([faker.string.alpha(20), undefined]) })), properties: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.string.alpha(20), type: faker.string.alpha(20), value: faker.helpers.arrayElement([{}, undefined]) })) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getExecNodeMethodResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { result: {} }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getExecPythonScriptResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { result: { value: faker.helpers.arrayElement([{}, undefined]) } }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getGetTdInfoResponseMock = (overrideResponse = {}) => ({ success: faker.datatype.boolean(), data: { server: faker.string.alpha(20), version: faker.string.alpha(20), osName: faker.string.alpha(20), osVersion: faker.string.alpha(20) }, error: faker.helpers.arrayElement([faker.string.alpha(20), null]), ...overrideResponse });
-export const getDeleteNodeMockHandler = (overrideResponse) => {
-    return http.delete('*/api/nodes', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getDeleteNodeResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getGetNodesMockHandler = (overrideResponse) => {
-    return http.get('*/api/nodes', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getGetNodesResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getCreateNodeMockHandler = (overrideResponse) => {
-    return http.post('*/api/nodes', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getCreateNodeResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getGetNodeDetailMockHandler = (overrideResponse) => {
-    return http.get('*/api/nodes/detail', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getGetNodeDetailResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getUpdateNodeMockHandler = (overrideResponse) => {
-    return http.patch('*/api/nodes/detail', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getUpdateNodeResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getGetTdPythonClassesMockHandler = (overrideResponse) => {
-    return http.get('*/api/td/classes', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getGetTdPythonClassesResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getGetTdPythonClassDetailsMockHandler = (overrideResponse) => {
-    return http.get('*/api/td/classes/:className', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getGetTdPythonClassDetailsResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getExecNodeMethodMockHandler = (overrideResponse) => {
-    return http.post('*/api/td/nodes/exec', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getExecNodeMethodResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getExecPythonScriptMockHandler = (overrideResponse) => {
-    return http.post('*/api/td/server/exec', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getExecPythonScriptResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getGetTdInfoMockHandler = (overrideResponse) => {
-    return http.get('*/api/td/server/td', async (info) => {
-        await delay(1000);
-        return new HttpResponse(JSON.stringify(overrideResponse !== undefined
-            ? (typeof overrideResponse === "function" ? await overrideResponse(info) : overrideResponse)
-            : getGetTdInfoResponseMock()), { status: 200,
-            headers: { 'Content-Type': 'application/json' }
-        });
-    });
-};
-export const getTouchDesignerAPIMock = () => [
-    getDeleteNodeMockHandler(),
-    getGetNodesMockHandler(),
-    getCreateNodeMockHandler(),
-    getGetNodeDetailMockHandler(),
-    getUpdateNodeMockHandler(),
-    getGetTdPythonClassesMockHandler(),
-    getGetTdPythonClassDetailsMockHandler(),
-    getExecNodeMethodMockHandler(),
-    getExecPythonScriptMockHandler(),
-    getGetTdInfoMockHandler()
-];

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

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

package/dist/server/touchDesignerServer.js CHANGED Viewed

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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "touchdesigner-mcp-server",
-	"version": "0.2.1",
+	"version": "0.2.3",
 	"description": "MCP server for TouchDesigner",
 	"repository": {
 		"type": "git",
@@ -28,7 +28,6 @@
 	},
 	"devDependencies": {
 		"@biomejs/biome": "1.9.4",
-		"@faker-js/faker": "^9.7.0",
 		"@types/jsdom": "^21.1.7",
 		"@types/node": "^22.15.2",
 		"@vitest/coverage-v8": "^3.1.2",

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

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

package/dist/mock/index.js DELETED Viewed

@@ -1,5 +0,0 @@
-async function initMocks() {
-    const { node } = await import("./node.js");
-    node.listen();
-}
-export { initMocks };

package/dist/mock/node.js DELETED Viewed

@@ -1,3 +0,0 @@
-import { setupServer } from "msw/node";
-import { getTouchDesignerAPIMock } from "../gen/endpoints/TouchDesignerAPI.js";
-export const node = setupServer(...getTouchDesignerAPIMock());