Skip to content

tops

tops

MCP tool wrappers for Houdini PDG/TOPs operations.

Each tool delegates to the corresponding handler running inside Houdini via the HTTP bridge.

Functions:

Name Description
cancel_top_cook

Cancel active cooking on a TOP network.
cook_top_node

Cook a TOP node to execute its work items.
dirty_work_items

Dirty work items on a TOP node so they can be regenerated.
generate_static_items

Generate static work items on a TOP node without cooking.
get_failed_work_items

List the work items that failed on a TOP node, with the tail of each log.
get_pdg_graph

Get the PDG dependency graph structure for a TOP network.
get_top_logs

Cook logs for a TOP node, or the scheduler log of one work item.
get_top_network_info

Get an overview of a TOP network.
get_top_scheduler_info

Get information about TOP scheduler nodes in a network.
get_work_item_info

Get detailed information about a specific work item.
get_work_item_states

Get work item state counts for a TOP node.
pause_top_cook

Pause cooking on a TOP network.

Functions:

cancel_top_cook async 

cancel_top_cook(ctx: Context, node_path: str) -> dict

Cancel active cooking on a TOP network.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node or TOPnet path.

 required

cook_top_node async 

cook_top_node(
    ctx: Context,
    node_path: str,
    block: bool = True,
    generate_only: bool = False,
) -> dict

Cook a TOP node to execute its work items.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required
block
bool

Wait for cooking to complete.

 True
generate_only
bool

Only generate work items, do not cook.

 False

dirty_work_items async 

dirty_work_items(
    ctx: Context, node_path: str, remove_outputs: bool = False
) -> dict

Dirty work items on a TOP node so they can be regenerated.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required
remove_outputs
bool

Also remove output files from disk.

 False

generate_static_items async 

generate_static_items(ctx: Context, node_path: str) -> dict

Generate static work items on a TOP node without cooking.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required

get_failed_work_items async 

get_failed_work_items(ctx: Context, node_path: str, limit: int = 10) -> dict

List the work items that failed on a TOP node, with the tail of each log.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required
limit
int

Maximum items returned.

 10

get_pdg_graph async 

get_pdg_graph(ctx: Context, node_path: str) -> dict

Get the PDG dependency graph structure for a TOP network.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOPnet or TOP node path.

 required

get_top_logs async 

get_top_logs(
    ctx: Context,
    node_path: str,
    work_item_index: int | None = None,
    tail: int = 4000,
) -> dict

Cook logs for a TOP node, or the scheduler log of one work item.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required
work_item_index
int | None

Work item index; omit for the node's own errors and warnings.

 None
tail
int

Maximum characters of log text, taken from the end.

 4000

get_top_network_info async 

get_top_network_info(ctx: Context, node_path: str) -> dict

Get an overview of a TOP network.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOPnet or TOP node path.

 required

get_top_scheduler_info async 

get_top_scheduler_info(ctx: Context, node_path: str) -> dict

Get information about TOP scheduler nodes in a network.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP scheduler or TOPnet path.

 required

get_work_item_info async 

get_work_item_info(ctx: Context, node_path: str, work_item_index: int) -> dict

Get detailed information about a specific work item.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required
work_item_index
int

Work item index within the node.

 required

get_work_item_states async 

get_work_item_states(ctx: Context, node_path: str) -> dict

Get work item state counts for a TOP node.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node path.

 required

pause_top_cook async 

pause_top_cook(ctx: Context, node_path: str) -> dict

Pause cooking on a TOP network.

Parameters:

Name Type Description Default
ctx
Context

MCP context.

 required
node_path
str

TOP node or TOPnet path.

 required