使用说明
TD_MCP Base - Plantilla para Proyectos MCP + TouchDesigner
🎯 Descripción
Base limpia del proyecto TD_MCP, diseñada para ser clonada y personalizada para nuevos proyectos de integración MCP con TouchDesigner. Esta base incluye toda la estructura, metodología y código necesario para iniciar proyectos rápidamente.
Arquitectura Base
Modelo IA <-> MCP Middleware <-> TouchEngine <-> TouchDesigner
Tecnologías Incluidas
- Python 3.8+
- TouchEngine SDK (configuración base)
- WebSocket para comunicación en tiempo real
- JSON para intercambio de datos
- Sistema MCP completo
Instalación
Prerrequisitos
- TouchDesigner instalado
- TouchEngine SDK (Windows/macOS)
- macOS: https://github.com/TouchDesigner/TouchEngine-macOS
- Windows: https://github.com/TouchDesigner/TouchEngine-Windows
- Python 3.8 o superior
Configuración del Entorno
# Crear entorno virtual
python -m venv venv
# Activar entorno virtual
# Windows:
venv\Scripts\activate
# macOS/Linux:
source venv/bin/activate
# Instalar dependencias
pip install -r requirements.txt
📚 Documentación
Documentación de la API
- API Documentation - Documentación completa de todas las herramientas MCP
- Developer Reference - Referencia técnica para desarrolladores
- Examples - Ejemplos prácticos de uso
- API Index - Índice completo de la documentación
Documentación del Proyecto
- Tutorial - Guía paso a paso para comenzar
- SDK Installation - Instalación del TouchEngine SDK
- Development Methodology - Metodología de desarrollo
- Bitácora - Log de desarrollo
- Roadmap - Plan de desarrollo
Deployment y Producción
- Deployment Guide - Guía completa de deployment
- Production Script - Script automatizado de producción
- Docker Configuration - Imagen optimizada para producción
- Kubernetes Config - Deployment en K8s
- Health Monitoring - Sistema de monitoreo
Uso Rápido
Inicio Rápido
# Configurar y ejecutar automáticamente
./iniciar.sh
# O manualmente:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python test_system.py
Primeros Pasos
- Ver Tutorial: docs/TUTORIAL.md - Guía completa paso a paso
- Ejecutar Ejemplos:
python ejemplos_basicos.py - Probar Sistema:
python tests/test_system.py - Iniciar Servidor:
python src/mcp_server.py
Cómo Usar el Tutorial
# Abrir el tutorial en tu editor
open docs/TUTORIAL.md
# O ver el contenido directamente
cat docs/TUTORIAL.md
El tutorial incluye:
- ✅ Configuración completa del entorno
- ✅ Instalación paso a paso
- ✅ Ejemplos prácticos de uso
- ✅ Troubleshooting detallado
- ✅ Comandos de inicio rápido
Comandos Principales
# Iniciar servidor MCP
python src/mcp_server.py
# Probar cliente
python src/test_client.py
# Ejecutar ejemplos
python ejemplos_basicos.py
# Ejecutar pruebas
python tests/test_system.py
Estructura del Proyecto
TD_MCP/
├── src/ # Código fuente
│ ├── mcp_server.py # Servidor MCP principal
│ ├── test_client.py # Cliente de prueba
│ ├── touchdesigner/ # Módulos específicos de TouchDesigner
│ ├── optimization/ # Módulos de optimización de rendimiento
│ └── utils/ # Utilidades y helpers
├── tests/ # Pruebas unitarias
│ ├── test_basic.py # Tests básicos (28 tests)
│ ├── test_optimization.py # Tests de optimización (21/25 tests)
│ ├── test_system.py # Pruebas del sistema
│ └── run_tests.py # Script de ejecución de tests
├── docs/ # Documentación
│ ├── api/ # Documentación de la API
│ │ ├── README.md # Documentación completa de API
│ │ ├── developer_reference.md # Referencia para desarrolladores
│ │ ├── examples.md # Ejemplos de uso
│ │ └── index.md # Índice de documentación
│ ├── TUTORIAL.md # Tutorial completo
│ └── sdk_installation.md # Instalación del SDK
├── examples/ # Ejemplos de uso
├── ejemplos_basicos.py # Ejemplos de uso
├── iniciar.sh # Script de inicio rápido
├── requirements.txt # Dependencias Python
├── METODOLOGIA_DESARROLLO.md # Metodología de desarrollo
├── BITACORA.md # Log de desarrollo
└── roadmap_v1.md # Plan de desarrollo
Desarrollo
Ver roadmap_v1.md para el plan de desarrollo detallado.
Contribución
Ver BITACORA.md para el log de desarrollo y cambios importantes.