Skip to main content
Glama

set_viewport_display

Configure Houdini viewport display settings—shading mode, environment background, reference grid, particle point size, and color scheme—in one call, with each value returned.

Instructions

Set how the viewport draws: shading, environment background, grid, particle point size, colour scheme. Any of them in one call; each is read back in the reply.

Args: display_mode: One of 'wireframe', 'shaded', 'smooth', 'smooth_wire', 'hidden_line', 'flat', 'flat_wire', 'matcap', 'matcap_wire'. pane_name: Pane tab name. environment_background: False hides an environment (dome) light's map behind the scene, True shows it. Set on every view of the viewer; the reply reads it back per view. reference_plane: False hides the reference plane (the grid), True shows it. point_size: Diameter in pixels of particles drawn as points, on every view of the viewer. color_scheme: 'dark', 'darkgrey', 'grey' or 'light', on every view.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pane_nameNo
point_sizeNo
color_schemeNo
display_modeNo
reference_planeNo
environment_backgroundNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv2.24.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / color_scheme
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Color Scheme"
      +}
    • addedInput schema / properties / display_mode / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / display_mode / default
      Added value: +null
    • removedInput schema / properties / display_mode / type
      Removed value: -"string"
    • addedInput schema / properties / environment_background
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Environment Background"
      +}
    • addedInput schema / properties / point_size
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Point Size"
      +}
    • addedInput schema / properties / reference_plane
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Reference Plane"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "display_mode"
      -]
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/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 add real behavioral context: each setting 'is read back in the reply', and environment_background, point_size and color_scheme are applied 'on every view of the viewer' while pane_name scopes the pane — a meaningful global-vs-pane distinction an agent could not infer from the schema. It still omits what happens when a parameter is left at its null default (unchanged vs reset) and whether the change is undoable, so it falls short of full transparency.

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?

The lead sentence front-loads the purpose before the Args block, and the per-parameter notes are compact. The structure is slightly verbose in places (the repeated 'on every view of the viewer' phrasing) but every line conveys actionable information.

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?

For a six-parameter mutation tool with no annotations and no output schema, the description supplies the enum vocabularies, the scope of each setting and the read-back behavior. The remaining gap is the semantics of omitted/null parameters and the pane_name resolution rule; with those covered this would be complete.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate, and it largely does: all six parameters are explained, and the allowed string values for display_mode ('wireframe', 'shaded', 'smooth', etc.) and color_scheme ('dark', 'darkgrey', 'grey', 'light') are supplied even though the schema declares no enums. pane_name is the weak spot — 'Pane tab name' is thin and gives no default or lookup hint.

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 opening sentence states a specific verb (set) plus resource (viewport display) and enumerates the five aspects it controls: shading, environment background, grid, point size, colour scheme. This cleanly separates it from siblings such as set_viewport_camera, set_viewport_renderer and set_viewport_direction without requiring the agent to open any schema.

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

Usage Guidelines3/5

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

'Any of them in one call' implies the batching/partial-update usage pattern, which is useful. However there is no guidance on when to prefer this tool over the adjacent set_viewport_renderer, set_viewport_camera or set_viewport_direction, and no stated preconditions (e.g. a viewport must exist). Usage is implied rather than spelled out.

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