nuke-python-scripting

nuke-python-scripting

Version: 1.0.1 Last Updated: 2025-12-03 Dependencies: Nuke (Foundry), NukeMCPLogger

---

Overview

Python scripting patterns for Nuke compositing automation using the NukeMCPLogger pattern for structured output capture. All scripts follow Article I (general purpose - work on any project).

Critical Pattern: NukeMCPLogger provides dual-output logging (MCP response + persistent file) since Nuke MCP bridge doesn't capture print statements.

---

Quick Start

NukeMCPLogger Basic Usage

from nuke_mcp_logger import NukeMCPLogger
import nuke

# Create logger
log = NukeMCPLogger(session_name="MyTask")

try:
    log.info("Starting operation...")

    # Create node
    grade_node = nuke.createNode("Grade")
    log.increment_stat("nodes_created")
    log.success(f"Created node: {grade_node.name()}")

except Exception as e:
    log.error("Operation failed", e)

# Return to MCP
result = log.get_results()

Expected Output:

{
    "status": "success",
    "session": "MyTask",
    "logs": ["Starting operation...", "Created node: Grade1"],
    "errors": [],
    "warnings": [],
    "stats": {"nodes_created": 1},
    "timestamp": "2025-12-03T..."
}

---

Standard Workflows

Workflow 1: General Purpose Node Creation

Use When: Creating any type of Nuke node in any project

def create_node_general(node_type: str, name: str = None):
    """
    Create any Nuke node - works for ALL projects (Article I).

    Args:
        node_type: Nuke node class (Read, Grade, Merge2, etc.)
        name: Optional custom name

    Returns:
        dict: Logger results with success/error status
    """
    import nuke
    from nuke_mcp_logger import NukeMCPLogger

    log = NukeMCPLogger(session_name="CreateNode")

    try:
        node = nuke.createNode(node_type)

        if name:
            node.setName(name)

        log.set_stat("node_type", node_type)
        log.set_stat("node_name", node.name())
        log.success(f"Created {node_type}: {node.name()}")

        return log.get_results()

    except Exception as e:
        log.error(f"Failed to create {node_type}", e)
        return log.get_results()

# Usage
result = create_node_general("Grade", "ShotGrade")
result = create_node_general("Merge2")