griptape-nodes 0.41.0__py3-none-any.whl → 0.43.0__py3-none-any.whl

griptape_nodes/retained_mode/events/parameter_events.py

@@ -20,6 +20,32 @@ from griptape_nodes.retained_mode.events.payload_registry import PayloadRegistry
 @dataclass
 @PayloadRegistry.register
 class AddParameterToNodeRequest(RequestPayload):
+    """Add a new parameter to a node.
+
+    Use when: Dynamically adding inputs/outputs to nodes, customizing node interfaces,
+    building configurable nodes. Supports type validation, tooltips, and mode restrictions.
+
+    Args:
+        node_name: Name of the node to add parameter to (None for current context)
+        parameter_name: Name of the new parameter (None for auto-generated)
+        default_value: Default value for the parameter
+        tooltip: General tooltip text or structured tooltip
+        tooltip_as_input: Tooltip when parameter is used as input
+        tooltip_as_property: Tooltip when parameter is used as property
+        tooltip_as_output: Tooltip when parameter is used as output
+        type: Parameter type string
+        input_types: List of allowed input types
+        output_type: Output type for the parameter
+        ui_options: UI configuration options
+        mode_allowed_input: Whether parameter can be used as input
+        mode_allowed_property: Whether parameter can be used as property
+        mode_allowed_output: Whether parameter can be used as output
+        parent_container_name: Name of parent container if nested
+        initial_setup: Skip setup work when loading from file
+
+    Results: AddParameterToNodeResultSuccess (with parameter name) | AddParameterToNodeResultFailure
+    """
+
     # If node name is None, use the Current Context
     node_name: str | None = None
     parameter_name: str | None = None
@@ -53,6 +79,14 @@ class AddParameterToNodeRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class AddParameterToNodeResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Parameter added successfully to node.
+
+    Args:
+        parameter_name: Name of the new parameter
+        type: Type of the parameter
+        node_name: Name of the node parameter was added to
+    """
+
     parameter_name: str
     type: str
     node_name: str
@@ -61,12 +95,24 @@ class AddParameterToNodeResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess
 @dataclass
 @PayloadRegistry.register
 class AddParameterToNodeResultFailure(ResultPayloadFailure):
-    pass
+    """Parameter addition failed. Common causes: node not found, invalid parameter name, type conflicts."""
 
 
 @dataclass
 @PayloadRegistry.register
 class RemoveParameterFromNodeRequest(RequestPayload):
+    """Remove a parameter from a node.
+
+    Use when: Cleaning up unused parameters, dynamically restructuring node interfaces,
+    removing deprecated parameters. Handles cleanup of connections and values.
+
+    Args:
+        parameter_name: Name of the parameter to remove
+        node_name: Name of the node to remove parameter from (None for current context)
+
+    Results: RemoveParameterFromNodeResultSuccess | RemoveParameterFromNodeResultFailure
+    """
+
     parameter_name: str
     # If node name is None, use the Current Context
     node_name: str | None = None
@@ -75,18 +121,34 @@ class RemoveParameterFromNodeRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class RemoveParameterFromNodeResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
-    pass
+    """Parameter removed successfully from node. Connections and values cleaned up."""
 
 
 @dataclass
 @PayloadRegistry.register
 class RemoveParameterFromNodeResultFailure(ResultPayloadFailure):
-    pass
+    """Parameter removal failed. Common causes: node not found, parameter not found, removal not allowed."""
 
 
 @dataclass
 @PayloadRegistry.register
 class SetParameterValueRequest(RequestPayload):
+    """Set the value of a parameter on a node.
+
+    Use when: Configuring node inputs, setting property values, loading saved workflows,
+    updating parameter values programmatically. Handles type validation and conversion.
+
+    Args:
+        parameter_name: Name of the parameter to set
+        value: Value to set for the parameter
+        node_name: Name of the node containing the parameter (None for current context)
+        data_type: Expected data type for validation (None for auto-detection)
+        initial_setup: Skip setup work when loading from file
+        is_output: Whether this is an output value (used when loading workflows)
+
+    Results: SetParameterValueResultSuccess (with finalized value) | SetParameterValueResultFailure
+    """
+
     parameter_name: str
     value: Any
     # If node name is None, use the Current Context
@@ -101,6 +163,13 @@ class SetParameterValueRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class SetParameterValueResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Parameter value set successfully. Value may have been processed or converted.
+
+    Args:
+        finalized_value: The actual value stored after processing
+        data_type: The determined data type of the value
+    """
+
     finalized_value: Any
     data_type: str
 
@@ -108,12 +177,28 @@ class SetParameterValueResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess)
 @dataclass
 @PayloadRegistry.register
 class SetParameterValueResultFailure(ResultPayloadFailure):
-    pass
+    """Parameter value setting failed.
+
+    Common causes: node not found, parameter not found,
+    type validation error, value conversion error.
+    """
 
 
 @dataclass
 @PayloadRegistry.register
 class GetParameterDetailsRequest(RequestPayload):
+    """Get detailed information about a parameter.
+
+    Use when: Inspecting parameter configuration, validating parameter properties,
+    building UIs that display parameter details, understanding parameter capabilities.
+
+    Args:
+        parameter_name: Name of the parameter to get details for
+        node_name: Name of the node containing the parameter (None for current context)
+
+    Results: GetParameterDetailsResultSuccess (with full details) | GetParameterDetailsResultFailure
+    """
+
     parameter_name: str
     # If node name is None, use the Current Context
     node_name: str | None = None
@@ -122,6 +207,21 @@ class GetParameterDetailsRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class GetParameterDetailsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Parameter details retrieved successfully.
+
+    Args:
+        element_id: Unique identifier for the parameter
+        type: Parameter type
+        input_types: Accepted input types
+        output_type: Output type when used as output
+        default_value: Default value if any
+        tooltip: General tooltip text
+        tooltip_as_input/property/output: Mode-specific tooltips
+        mode_allowed_input/property/output: Which modes are allowed
+        is_user_defined: Whether this is a user-defined parameter
+        ui_options: UI configuration options
+    """
+
     element_id: str
     type: str
     input_types: list[str]
@@ -141,12 +241,38 @@ class GetParameterDetailsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuc
 @dataclass
 @PayloadRegistry.register
 class GetParameterDetailsResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Parameter details retrieval failed. Common causes: node not found, parameter not found."""
 
 
 @dataclass
 @PayloadRegistry.register
 class AlterParameterDetailsRequest(RequestPayload):
+    """Alter the details and configuration of a parameter.
+
+    Use when: Modifying parameter types, updating tooltips, changing allowed modes,
+    configuring UI options, updating parameter constraints after creation.
+
+    Args:
+        parameter_name: Name of the parameter to alter
+        node_name: Name of the node containing the parameter (None for current context)
+        type: New parameter type
+        input_types: New list of accepted input types
+        output_type: New output type when used as output
+        default_value: New default value
+        tooltip: New general tooltip text
+        tooltip_as_input: New tooltip when used as input
+        tooltip_as_property: New tooltip when used as property
+        tooltip_as_output: New tooltip when used as output
+        mode_allowed_input: Whether parameter can be used as input
+        mode_allowed_property: Whether parameter can be used as property
+        mode_allowed_output: Whether parameter can be used as output
+        ui_options: New UI configuration options
+        traits: Set of parameter traits
+        initial_setup: Skip setup work when loading from file
+
+    Results: AlterParameterDetailsResultSuccess | AlterParameterDetailsResultFailure
+    """
+
     parameter_name: str
     # If node name is None, use the Current Context
     node_name: str | None = None
@@ -218,6 +344,18 @@ class AlterParameterDetailsResultFailure(ResultPayloadFailure):
 @dataclass
 @PayloadRegistry.register
 class GetParameterValueRequest(RequestPayload):
+    """Get the current value of a parameter.
+
+    Use when: Reading parameter values, debugging workflow state, displaying current values in UIs,
+    validating parameter states before execution.
+
+    Args:
+        parameter_name: Name of the parameter to get value for
+        node_name: Name of the node containing the parameter (None for current context)
+
+    Results: GetParameterValueResultSuccess (with value and type info) | GetParameterValueResultFailure
+    """
+
     parameter_name: str
     # If node name is None, use the Current Context
     node_name: str | None = None
@@ -226,6 +364,15 @@ class GetParameterValueRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class GetParameterValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Parameter value retrieved successfully.
+
+    Args:
+        input_types: Accepted input types
+        type: Current parameter type
+        output_type: Output type when used as output
+        value: Current parameter value
+    """
+
     input_types: list[str]
     type: str
     output_type: str
@@ -235,7 +382,7 @@ class GetParameterValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSucce
 @dataclass
 @PayloadRegistry.register
 class GetParameterValueResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Parameter value retrieval failed. Common causes: node not found, parameter not found."""
 
 
 @dataclass
@@ -250,6 +397,19 @@ class OnParameterValueChanged(WorkflowAlteredMixin, ResultPayloadSuccess):
 @dataclass
 @PayloadRegistry.register
 class GetCompatibleParametersRequest(RequestPayload):
+    """Get parameters that are compatible for connections.
+
+    Use when: Creating connections between nodes, validating connection compatibility,
+    building connection UIs, discovering available connection targets.
+
+    Args:
+        parameter_name: Name of the parameter to find compatible parameters for
+        is_output: Whether the parameter is an output parameter
+        node_name: Name of the node containing the parameter (None for current context)
+
+    Results: GetCompatibleParametersResultSuccess (with compatible parameters) | GetCompatibleParametersResultFailure
+    """
+
     parameter_name: str
     is_output: bool
     # If node name is None, use the Current Context
@@ -264,18 +424,36 @@ class ParameterAndMode(NamedTuple):
 @dataclass
 @PayloadRegistry.register
 class GetCompatibleParametersResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Compatible parameters retrieved successfully.
+
+    Args:
+        valid_parameters_by_node: Dictionary mapping node names to lists of compatible parameters
+    """
+
     valid_parameters_by_node: dict[str, list[ParameterAndMode]]
 
 
 @dataclass
 @PayloadRegistry.register
 class GetCompatibleParametersResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Compatible parameters retrieval failed. Common causes: node not found, parameter not found."""
 
 
 @dataclass
 @PayloadRegistry.register
 class GetNodeElementDetailsRequest(RequestPayload):
+    """Get detailed information about a node element.
+
+    Use when: Inspecting node structure, debugging element configuration,
+    building advanced UIs, understanding node composition.
+
+    Args:
+        node_name: Name of the node to get element details for (None for current context)
+        specific_element_id: ID of specific element to get details for (None for root)
+
+    Results: GetNodeElementDetailsResultSuccess (with element details) | GetNodeElementDetailsResultFailure
+    """
+
     # If node name is None, use the Current Context
     node_name: str | None = None
     specific_element_id: str | None = None  # Pass None to use the root
@@ -303,6 +481,20 @@ class AlterElementEvent(ExecutionPayload):
 @dataclass
 @PayloadRegistry.register
 class RenameParameterRequest(RequestPayload):
+    """Rename a parameter on a node.
+
+    Use when: Refactoring parameter names, improving parameter clarity, updating parameter
+    naming conventions. Handles updating connections and references.
+
+    Args:
+        parameter_name: Current name of the parameter
+        new_parameter_name: New name for the parameter
+        node_name: Name of the node containing the parameter (None for current context)
+        initial_setup: Skip setup work when loading from file
+
+    Results: RenameParameterResultSuccess (with old and new names) | RenameParameterResultFailure
+    """
+
     parameter_name: str
     new_parameter_name: str
     # If node name is None, use the Current Context
@@ -314,6 +506,14 @@ class RenameParameterRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class RenameParameterResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Parameter renamed successfully. Connections and references updated.
+
+    Args:
+        old_parameter_name: Previous parameter name
+        new_parameter_name: New parameter name
+        node_name: Name of the node containing the parameter
+    """
+
     old_parameter_name: str
     new_parameter_name: str
     node_name: str
@@ -322,7 +522,11 @@ class RenameParameterResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
 @dataclass
 @PayloadRegistry.register
 class RenameParameterResultFailure(ResultPayloadFailure):
-    pass
+    """Parameter rename failed.
+
+    Common causes: node not found, parameter not found,
+    name already exists, invalid new name.
+    """
 
 
 @dataclass

griptape_nodes/retained_mode/events/secrets_events.py

@@ -13,24 +13,53 @@ from griptape_nodes.retained_mode.events.payload_registry import PayloadRegistry
 @dataclass
 @PayloadRegistry.register
 class GetSecretValueRequest(RequestPayload):
+    """Get a secret value by key.
+
+    Use when: Retrieving API keys, database credentials, authentication tokens,
+    accessing sensitive configuration values, implementing secure storage.
+
+    Args:
+        key: Name of the secret key to retrieve
+
+    Results: GetSecretValueResultSuccess (with value) | GetSecretValueResultFailure (key not found)
+    """
+
     key: str
 
 
 @dataclass
 @PayloadRegistry.register
 class GetSecretValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Secret value retrieved successfully.
+
+    Args:
+        value: The secret value (handle with care - avoid logging)
+    """
+
     value: Any
 
 
 @dataclass
 @PayloadRegistry.register
 class GetSecretValueResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Secret value retrieval failed. Common causes: key not found, access denied, secrets store unavailable."""
 
 
 @dataclass
 @PayloadRegistry.register
 class SetSecretValueRequest(RequestPayload):
+    """Set a secret value by key.
+
+    Use when: Storing API keys, database credentials, authentication tokens,
+    configuring secure settings, implementing secret management.
+
+    Args:
+        key: Name of the secret key to set
+        value: Secret value to store (handle with care)
+
+    Results: SetSecretValueResultSuccess | SetSecretValueResultFailure (storage error)
+    """
+
     key: str
     value: Any
 
@@ -38,46 +67,69 @@ class SetSecretValueRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class SetSecretValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
-    pass
+    """Secret value set successfully. Value is now stored securely."""
 
 
 @dataclass
 @PayloadRegistry.register
 class SetSecretValueResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Secret value setting failed. Common causes: storage error, access denied, invalid key format."""
 
 
 @dataclass
 @PayloadRegistry.register
 class GetAllSecretValuesRequest(RequestPayload):
-    pass
+    """Get all secret values.
+
+    Use when: Backing up secrets, migrating configurations, implementing secret management UIs,
+    debugging secret issues. Use with caution - returns all sensitive data.
+
+    Results: GetAllSecretValuesResultSuccess (with values dict) | GetAllSecretValuesResultFailure (access error)
+    """
 
 
 @dataclass
 @PayloadRegistry.register
 class GetAllSecretValuesResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """All secret values retrieved successfully.
+
+    Args:
+        values: Dictionary of all secret key-value pairs (handle with extreme care)
+    """
+
     values: dict[str, Any]
 
 
 @dataclass
 @PayloadRegistry.register
 class GetAllSecretValuesResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Secret values retrieval failed. Common causes: access denied, secrets store unavailable."""
 
 
 @dataclass
 @PayloadRegistry.register
 class DeleteSecretValueRequest(RequestPayload):
+    """Delete a secret value by key.
+
+    Use when: Removing obsolete secrets, cleaning up configurations, implementing secret rotation,
+    revoking access credentials, managing secret lifecycle.
+
+    Args:
+        key: Name of the secret key to delete
+
+    Results: DeleteSecretValueResultSuccess | DeleteSecretValueResultFailure (key not found, deletion error)
+    """
+
     key: str
 
 
 @dataclass
 @PayloadRegistry.register
 class DeleteSecretValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
-    pass
+    """Secret value deleted successfully. Secret is no longer accessible."""
 
 
 @dataclass
 @PayloadRegistry.register
 class DeleteSecretValueResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Secret value deletion failed. Common causes: key not found, access denied, deletion not allowed."""

griptape_nodes/retained_mode/events/static_file_events.py

@@ -12,7 +12,12 @@ from griptape_nodes.retained_mode.events.payload_registry import PayloadRegistry
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileRequest(RequestPayload):
-    """Request to create a static file.
+    """Create a static file from content.
+
+    Use when: Generating files from workflow outputs, creating downloadable content,
+    storing processed data, implementing file export functionality.
+
+    Results: CreateStaticFileResultSuccess (with URL) | CreateStaticFileResultFailure (creation error)
 
     Args:
         content: Content of the file base64 encoded
@@ -26,22 +31,39 @@ class CreateStaticFileRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Static file created successfully.
+
+    Args:
+        url: URL where the static file can be accessed
+    """
+
     url: str
 
 
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Static file creation failed.
+
+    Args:
+        error: Detailed error message describing the failure
+    """
+
     error: str
 
 
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileUploadUrlRequest(RequestPayload):
-    """Request to create a presigned URL for uploading a static file via a HTTP PUT.
+    """Create a presigned URL for uploading a static file via HTTP PUT.
+
+    Use when: Implementing file upload functionality, allowing direct client uploads,
+    enabling large file transfers, implementing drag-and-drop uploads.
 
     Args:
         file_name: Name of the file to be uploaded
+
+    Results: CreateStaticFileUploadUrlResultSuccess (with URL and headers) | CreateStaticFileUploadUrlResultFailure (URL creation error)
     """
 
     file_name: str
@@ -50,6 +72,14 @@ class CreateStaticFileUploadUrlRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileUploadUrlResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Static file upload URL created successfully.
+
+    Args:
+        url: Presigned URL for uploading the file
+        headers: HTTP headers required for the upload request
+        method: HTTP method to use for upload (typically PUT)
+    """
+
     url: str
     headers: dict = field(default_factory=dict)
     method: str = "PUT"
@@ -58,16 +88,27 @@ class CreateStaticFileUploadUrlResultSuccess(WorkflowNotAlteredMixin, ResultPayl
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileUploadUrlResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Static file upload URL creation failed.
+
+    Args:
+        error: Detailed error message describing the failure
+    """
+
     error: str
 
 
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileDownloadUrlRequest(RequestPayload):
-    """Request to create a presigned URL for downloading a static file via a HTTP GET.
+    """Create a presigned URL for downloading a static file via HTTP GET.
+
+    Use when: Providing secure file access, implementing file sharing,
+    enabling temporary download links, controlling file access permissions.
 
     Args:
-        file_name: Name of the file to be uploaded
+        file_name: Name of the file to be downloaded
+
+    Results: CreateStaticFileDownloadUrlResultSuccess (with URL) | CreateStaticFileDownloadUrlResultFailure (URL creation error)
     """
 
     file_name: str
@@ -76,10 +117,22 @@ class CreateStaticFileDownloadUrlRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileDownloadUrlResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Static file download URL created successfully.
+
+    Args:
+        url: Presigned URL for downloading the file
+    """
+
     url: str
 
 
 @dataclass
 @PayloadRegistry.register
 class CreateStaticFileDownloadUrlResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Static file download URL creation failed.
+
+    Args:
+        error: Detailed error message describing the failure
+    """
+
     error: str

griptape_nodes/retained_mode/events/validation_events.py

@@ -13,6 +13,18 @@ from griptape_nodes.retained_mode.events.payload_registry import PayloadRegistry
 @dataclass
 @PayloadRegistry.register
 class ValidateFlowDependenciesRequest(RequestPayload):
+    """Validate that a flow has all required dependencies before execution.
+
+    Use when: Pre-flight checks before flow execution, preventing runtime failures,
+    debugging dependency issues, validating flow readiness.
+
+    Args:
+        flow_name: Name of the flow to validate dependencies for
+        flow_node_name: Name of the flow node to validate (None for default)
+
+    Results: ValidateFlowDependenciesResultSuccess (with validation status) | ValidateFlowDependenciesResultFailure (validation error)
+    """
+
     # Same inputs as StartFlow
     flow_name: str
     flow_node_name: str | None = None
@@ -21,20 +33,37 @@ class ValidateFlowDependenciesRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class ValidateFlowDependenciesResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Flow dependencies validated successfully.
+
+    Args:
+        validation_succeeded: True if all dependencies are satisfied, False if issues found
+        exceptions: List of dependency validation exceptions (empty if validation_succeeded=True)
+    """
+
     validation_succeeded: bool
     exceptions: list[Exception]
 
 
-# if it doesn't have a dependency we want
 @dataclass
 @PayloadRegistry.register
 class ValidateFlowDependenciesResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Flow dependency validation failed. Common causes: flow not found, validation system error, missing dependencies."""
 
 
 @dataclass
 @PayloadRegistry.register
 class ValidateNodeDependenciesRequest(RequestPayload):
+    """Validate that a node has all required dependencies before execution.
+
+    Use when: Pre-flight checks before node execution, preventing runtime failures,
+    debugging node dependency issues, validating node readiness.
+
+    Args:
+        node_name: Name of the node to validate dependencies for
+
+    Results: ValidateNodeDependenciesResultSuccess (with validation status) | ValidateNodeDependenciesResultFailure (validation error)
+    """
+
     # Same inputs as StartFlow
     node_name: str
 
@@ -42,12 +71,18 @@ class ValidateNodeDependenciesRequest(RequestPayload):
 @dataclass
 @PayloadRegistry.register
 class ValidateNodeDependenciesResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Node dependencies validated successfully.
+
+    Args:
+        validation_succeeded: True if all dependencies are satisfied, False if issues found
+        exceptions: List of dependency validation exceptions (empty if validation_succeeded=True)
+    """
+
     validation_succeeded: bool
     exceptions: list[Exception]
 
 
-# if it doesn't have a dependency we want
 @dataclass
 @PayloadRegistry.register
 class ValidateNodeDependenciesResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
-    pass
+    """Node dependency validation failed. Common causes: node not found, validation system error, missing dependencies."""