touchdesigner-mcp-server/dist/gen/mcp/touchDesignerAPI.zod.d.ts

MCP server for TouchDesigner

/**
 * Generated by orval v8.19.0 🍺
 * Do not edit manually.
 * TouchDesigner API
 * OpenAPI schema for generating TouchDesigner API client code
 * OpenAPI spec version: 1.5.0
 */
import * as zod from 'zod';
/**
 * @summary Get nodes in the path
 */
export declare const getNodesQueryPatternDefault = "*";
export declare const getNodesQueryIncludePropertiesDefault = false;
export declare const GetNodesQueryParams: zod.ZodObject<{
    parentPath: zod.ZodString;
    pattern: zod.ZodDefault<zod.ZodString>;
    includeProperties: zod.ZodDefault<zod.ZodBoolean>;
}, zod.z.core.$strip>;
export declare const GetNodesResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        nodes: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
            id: zod.ZodNumber;
            opType: zod.ZodString;
            name: zod.ZodString;
            path: zod.ZodString;
            properties: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
        }, zod.z.core.$strip>>>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * @summary Create a new node
 */
export declare const CreateNodeBody: zod.ZodObject<{
    parentPath: zod.ZodString;
    nodeType: zod.ZodString;
    nodeName: zod.ZodOptional<zod.ZodString>;
}, zod.z.core.$strip>;
export declare const CreateNodeResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        result: zod.ZodOptional<zod.ZodObject<{
            id: zod.ZodNumber;
            opType: zod.ZodString;
            name: zod.ZodString;
            path: zod.ZodString;
            properties: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
        }, zod.z.core.$strip>>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * @summary Delete an existing node
 */
export declare const DeleteNodeQueryParams: zod.ZodObject<{
    nodePath: zod.ZodString;
}, zod.z.core.$strip>;
export declare const DeleteNodeResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        deleted: zod.ZodOptional<zod.ZodBoolean>;
        node: zod.ZodOptional<zod.ZodObject<{
            id: zod.ZodNumber;
            opType: zod.ZodString;
            name: zod.ZodString;
            path: zod.ZodString;
            properties: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
        }, zod.z.core.$strip>>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Retrieves detailed information about a specific node including its properties, parameters and connections
 * @summary Get node detail
 */
export declare const GetNodeDetailQueryParams: zod.ZodObject<{
    nodePath: zod.ZodString;
}, zod.z.core.$strip>;
export declare const GetNodeDetailResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        id: zod.ZodNumber;
        opType: zod.ZodString;
        name: zod.ZodString;
        path: zod.ZodString;
        properties: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * @summary Update node properties
 */
export declare const UpdateNodeBody: zod.ZodObject<{
    nodePath: zod.ZodString;
    properties: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
}, zod.z.core.$strip>;
export declare const UpdateNodeResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        path: zod.ZodOptional<zod.ZodString>;
        updated: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
        failed: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
            name: zod.ZodOptional<zod.ZodString>;
            reason: zod.ZodOptional<zod.ZodString>;
        }, zod.z.core.$strip>>>;
        message: zod.ZodOptional<zod.ZodString>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Collects TouchDesigner error messages for a node and its children
 * @summary Get node errors
 */
export declare const GetNodeErrorsQueryParams: zod.ZodObject<{
    nodePath: zod.ZodString;
}, zod.z.core.$strip>;
export declare const GetNodeErrorsResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodObject<{
        nodePath: zod.ZodString;
        nodeName: zod.ZodString;
        opType: zod.ZodString;
        errorCount: zod.ZodNumber;
        hasErrors: zod.ZodBoolean;
        errors: zod.ZodArray<zod.ZodObject<{
            nodePath: zod.ZodString;
            nodeName: zod.ZodString;
            opType: zod.ZodString;
            message: zod.ZodString;
        }, zod.z.core.$strip>>;
    }, zod.z.core.$strip>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Returns a list of Python classes, modules, and functions available in TouchDesigner
 * @summary Get a list of Python classes and modules
 */
export declare const GetTdPythonClassesResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        classes: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
            name: zod.ZodString;
            type: zod.ZodEnum<{
                object: "object";
                function: "function";
                class: "class";
                module: "module";
            }>;
            description: zod.ZodOptional<zod.ZodString>;
        }, zod.z.core.$strip>>>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Returns detailed information about a specific Python class, module, or function including methods, properties, and documentation
 * @summary Get details of a specific Python class or module
 */
export declare const GetTdPythonClassDetailsParams: zod.ZodObject<{
    className: zod.ZodString;
}, zod.z.core.$strip>;
export declare const GetTdPythonClassDetailsResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        name: zod.ZodString;
        type: zod.ZodEnum<{
            object: "object";
            function: "function";
            class: "class";
            module: "module";
        }>;
        description: zod.ZodOptional<zod.ZodString>;
        methods: zod.ZodArray<zod.ZodObject<{
            name: zod.ZodString;
            signature: zod.ZodOptional<zod.ZodString>;
            description: zod.ZodOptional<zod.ZodString>;
        }, zod.z.core.$strip>>;
        properties: zod.ZodArray<zod.ZodObject<{
            name: zod.ZodString;
            type: zod.ZodString;
            value: zod.ZodOptional<zod.ZodNullable<zod.ZodObject<{}, zod.z.core.$loose>>>;
        }, zod.z.core.$strip>>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Retrieve Python help() documentation for TouchDesigner modules, classes, or utilities like tdu.
 * @summary Get module/class Python help documentation
 */
export declare const GetModuleHelpQueryParams: zod.ZodObject<{
    moduleName: zod.ZodString;
}, zod.z.core.$strip>;
export declare const GetModuleHelpResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        moduleName: zod.ZodString;
        helpText: zod.ZodString;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Call a method on the node at the specified path (e.g., /project1).
 * This allows operations equivalent to TouchDesigner's Python API such as
 * `parent_comp = op('/project1')` and `parent_comp.create('textTOP', 'myText')`.
 * @summary Call a method of the specified node
 */
export declare const ExecNodeMethodBody: zod.ZodObject<{
    nodePath: zod.ZodString;
    method: zod.ZodString;
    args: zod.ZodOptional<zod.ZodArray<zod.ZodUnion<readonly [zod.ZodString, zod.ZodNumber, zod.ZodBoolean]>>>;
    kwargs: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
}, zod.z.core.$strip>;
export declare const ExecNodeMethodResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        result: zod.ZodUnknown;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Execute a Python script directly in TouchDesigner.
 * Multiline scripts and scripts containing comments are supported.
 * The script can optionally set a `result` variable to explicitly return a value.
 * This endpoint allows you to interact with TouchDesigner nodes programmatically.
 * @summary Execute python code on the server
 */
export declare const ExecPythonScriptBody: zod.ZodObject<{
    script: zod.ZodString;
}, zod.z.core.$strip>;
export declare const ExecPythonScriptResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        result: zod.ZodObject<{
            value: zod.ZodOptional<zod.ZodUnknown>;
        }, zod.z.core.$strip>;
        stdout: zod.ZodOptional<zod.ZodString>;
        stderr: zod.ZodOptional<zod.ZodString>;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;
/**
 * Returns information about the TouchDesigner
 * @summary Get TouchDesigner information
 */
export declare const GetTdInfoResponse: zod.ZodObject<{
    success: zod.ZodBoolean;
    data: zod.ZodNullable<zod.ZodObject<{
        mcpApiVersion: zod.ZodString;
        osName: zod.ZodString;
        osVersion: zod.ZodString;
        server: zod.ZodString;
        version: zod.ZodString;
    }, zod.z.core.$strip>>;
    error: zod.ZodNullable<zod.ZodString>;
}, zod.z.core.$strip>;