Touchdesigner

🚀 タッチデザイナー MCP サーバー開発ガイド

このガイドは、タッチデザイナー MCP サーバーの開発に関する手順や情報を提供します。開発者はこのガイドを参考に、サーバーのセットアップ、コード生成、テスト、デプロイなどの作業を行うことができます。

🚀 クイックスタート

インストール

依存関係のインストール

npm を使用して依存関係をインストールします。

npm install

プロジェクトの起動

開発モード

npm run dev

このコマンドで、MCP サーバーと Inspector ツールが起動します。

本番環境

npm start

📦 インストール

依存関係のインストール

npm install

プロジェクトの起動

開発モード

npm run dev

このコマンドで、MCP サーバーと Inspector ツールが起動します。

本番環境

npm start

📚 ドキュメント

プロジェクト構造

├── src/                       # MCP サーバーソースコード
│   ├── api/                  # OpenAPI 規範ファイル（TD WebServer インターフェースを定義）
│   ├── core/                 # コアツール（ログ記録、エラー処理）
│   ├── features/             # MCP 機能実装モジュール
│   │   ├── prompts/         # プロンプトハンドラー
│   │   ├── resources/       # リソースハンドラー
│   │   └── tools/           # ツールハンドラー（例: tdTools.ts）
│   ├── gen/                  # OpenAPI スキームに基づいて生成されたコード
│   ├── server/               # MCP サーバーロジック（接続処理、メインサーバークラス）
│   ├── tdClient/             # TouchDesigner 接続 API クライアント
│   ├── index.ts              # Node.js サーバーエントリポイント
│   └── ...
├── td/                        # TouchDesigner 関連ファイル
│   ├── modules/              # TouchDesigner プラグインモジュール
│   │   ├── mcp/              # ハンドラーコアロジック
│   │   │   ├── controllers/ # API リクエストコントローラー（api_controller.py、generated_handlers.py）
│   │   │   └── services/    # ビジネスロジック実装（api_service.py）
│   │   ├── td_server/        # OpenAPI スキームに基づいて生成された Python サーバーコード
│   │   └── utils/            # 共有 Python ツール関数
│   ├── templates/             # Mustache テンプレートファイル（ハンドラーコード生成用）
│   ├── genHandlers.js         # Node.js スクリプト、generated_handlers.py 生成用
│   ├── import_modules.py      # 補助スクリプト、TouchDesigner で API サーバーモジュールをインポートするため
│   └── mcp_webserver_base.tox # メイン TouchDesigner コンポーネントファイル
├── tests/                      # テストコード
│   ├── integration/
│   └── unit/
├── .env                        # ローカル環境変数設定（Git で無視される）
├── dotenv                      # .env ファイルテンプレート
└── orval.config.ts             # Orval 設定ファイル（TypeScript クライアント生成用）

API コード生成フロー

このプロジェクトでは、OpenAPI ベースのコード生成ツール（Orval / openapi-generator-cli）を使用しています。

API 定義：Node.js MCP サーバーと TouchDesigner で動作する Python サーバー間の API インターフェース定義ファイルは src/api/index.yml にあります。

1. Python サーバーコード生成 (npm run gen:webserver)

   • Docker 内の openapi-generator-cli ツールを使用します。
   • src/api/index.yml ファイルの内容を読み込みます。
   • OpenAPI 定義に基づいて Python サーバーコードフレームワークを生成します（td/modules/td_server/ に配置）。このコードは TouchDesigner 内の WebServer DAT で実行されます。
   • Docker 環境が必要です。

2. Python ハンドラーコード生成 (npm run gen:handlers)

   • Node.js スクリプト genHandlers.js を使用してハンドラーコードを生成します（td/modules/mcp/ に配置）。

3. テストケース生成 (npm run gen:test)

   • 自動的にインターフェーステストケースを生成し、API の動作が期待通りかどうかを後で検証しやすくします。

プロジェクト初期化

環境設定

.env ファイルを作成して編集します。

touch .env

.env ファイルに以下の内容を追加します。

NODE_ENV=development
MCP_PORT=8080
TOUCHDesigner_PATH=/path/to/TouchDesigner

使用方法

MCP サーバーの実行

npm start

Inspector ツールの起動

Inspector は、MCP サーバーの実行状態をデバッグおよび監視するためのツールで、以下のコマンドで起動できます。

npm run inspector

貢献ガイド

コード提出規範

CONTRIBUTING.md ファイルの規範に従ってコードを提出してください。

問題報告

問題が発生した場合は、GitHub で issue を提出するか、プロジェクトを fork して pull request を提出して問題を解決してください。

開発フロー

1. 環境構築

   • Node.js と npm をインストールします。
   • このリポジトリをクローンし、依存関係をインストールします。

     git clone https://github.com/yourusername/touchdesigner-mcp.git
     cd touchdesigner-mcp
     npm install
     

2. 開発とデバッグ

   • npm run dev を使用して開発環境を起動します。
   • コードを変更した後は、単体テストと統合テストを通過して機能を検証してください。

3. ビルドとデプロイ

   • 本番環境用のビルドファイルを生成します。

     npm run build
     

   • ビルド後のファイルをターゲットサーバーまたは環境にデプロイします。

📄 ライセンス

MIT License

Copyright (c) 年份 作者姓名

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.