Skip to main content
Glama

get_cook_status

Check whether a Houdini node actually recooked after a parameter change, whether it is time dependent or ended in error, and if the hip has unsaved changes.

Instructions

Whether a node has cooked, how often, and whether it is time dependent.

cook_count is the node's cook counter and needs_to_cook whether it is dirty (its next read cooks it): compare them around a parameter change. Nodes that never cook (/obj, OBJ containers, VOPs) always report needs_to_cook True; a generator TOP reports False with no cooks.

Note the shape of the limitation: every command runs on Houdini's main thread, so a long cook blocks the bridge and cannot be polled while it runs. This answers the after-the-fact question instead -- did it really recook, is it time dependent, did it end in error -- plus whether the hip has unsaved changes. For asynchronous work use a ROP's background execution and get_render_progress.

Args: node_path: Node to report on.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_cook_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
node_pathNo/obj

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.24.1
    • addedInput schema / additionalProperties
      Added value: +false
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does so: it discloses the main-thread blocking limitation, that a long cook cannot be polled, and the non-obvious reporting semantics for never-cooking nodes (/obj, OBJ containers, VOPs report True) and generator TOPs (False with no cooks). It also flags that unsaved-hip state is included, which an agent would not otherwise know.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Core answer is front-loaded and the concrete semantics precede the caveat. The 'Note the shape of the limitation' framing and the em-dash aside are slightly discursive, but the length is justified by the non-obvious behavior it conveys.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description must sketch the return: it names cook count, dirty flag, time dependence, error outcome, and unsaved-changes state, which is enough to call and interpret. It stops short of naming exact field names or return structure, a minor gap for a read tool of this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single parameter, so the description only offers the thin gloss 'Node to report on'. It does not clarify path format, whether absolute vs relative paths are accepted, or what the /obj default implies beyond the schema literal.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence names the exact resource and the three facts reported (has it cooked, cook count, time dependence), and later sentences pin down `cook_count` vs `needs_to_cook` specifically. It also distinguishes itself from the async alternative (get_render_progress), so an agent can tell it apart from siblings without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states the intended question explicitly ('did it really recook, is it time dependent, did it end in error') and states the exclusion: not for polling a running cook, use a ROP's background execution plus get_render_progress instead. Both when-to-use and when-not-to-use are covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools