Skip to main content
Glama

capture_screenshot

Capture a Houdini viewport or pane tab image to disk for visual confirmation after changes, with optional settle time for Karma convergence.

Instructions

Capture a screenshot of the viewport or a specific pane tab.

The image is written to disk only; open output_path with your file reader to look at it. Prefer get_geometry_info, get_node_info or get_scene_summary unless visual confirmation is genuinely needed. A Scene Viewer capture names the network it shows (viewer_network); viewer_note says when that is a DOP network, drawn as the simulation's objects rather than the SOP display.

Args: output_path: Image file path. Default: a new PNG in the temp dir. pane_name: Pane tab name. settle_seconds: Wait this long before capturing, without blocking Houdini, so a Karma viewport can converge after a change. Use this instead of a shell sleep between calls. Capped at 120.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pane_nameNo
output_pathNo
settle_secondsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.24.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / output_path / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / output_path / default
      Added value: +null
    • removedInput schema / properties / output_path / type
      Removed value: -"string"
    • removedInput schema / required
      Removed value: -[
      -  "output_path"
      -]
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations, the description carries the load and does well: it discloses that the image is written to disk only and must be opened via a file reader, that settle_seconds is non-blocking and capped at 120, and how viewer_network/viewer_note resolve for Scene Viewer captures. It omits any note on permissions or side effects, but those are minimal for a capture tool.

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?

Purpose is front-loaded, followed by essential disk/reading context and an Args breakdown. Most sentences earn their place; the viewer_network/viewer_note detail is somewhat niche but genuinely informative for Scene Viewer use.

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

Completeness5/5

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

For a 3-parameter, no-output-schema tool with no annotations, the description covers purpose, alternatives, output handling, and all three parameters. Nothing an agent needs to call it correctly is missing.

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

Parameters5/5

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

Schema coverage is 0%, so the description must compensate, and it does: it defines output_path's default (a new PNG in the temp dir), pane_name's meaning, and gives rich guidance for settle_seconds including its non-blocking nature, the 120 cap, and the recommendation to use it instead of a shell sleep.

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?

States a specific verb (capture) and resource (screenshot of the viewport or a named pane tab), which cleanly separates it from siblings like render_viewport or capture_network_editor. An agent knows exactly what the tool produces without opening the 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?

Explicitly tells the agent to prefer get_geometry_info, get_node_info, or get_scene_summary unless visual confirmation is genuinely needed. This is a clear when-to-use and when-not-to-use signal naming concrete alternatives from the sibling set.

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