Skip to main content
Glama

set_viewport_overlay

Toggle specific Blender viewport overlays, including wireframes, axes, cursor, origins, and stats, by setting an overlay name and its enabled state.

Instructions

Toggle a viewport overlay setting.

Args: overlay: Overlay property name. One of: show_wireframes, show_face_orientation, show_floor, show_axis_x, show_axis_y, show_axis_z, show_cursor, show_object_origins, show_relationship_lines, show_stats. enabled: Whether the overlay should be enabled.

Returns: Confirmation dict with the overlay name and state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
enabledYes
overlayYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.7.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / overlay / enum
      Added value: +[
      +  "show_axis_x",
      +  "show_axis_y",
      +  "show_axis_z",
      +  "show_cursor",
      +  "show_face_orientation",
      +  "show_floor",
      +  "show_object_origins",
      +  "show_relationship_lines",
      +  "show_stats",
      +  "show_wireframes"
      +]
  2. Changed1 schema field changedv1.2.2
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "title": "set_viewport_overlayDictOutput",
      +  "type": "object"
      +}
  3. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It says 'Toggle' and mentions a confirmation return, but does not disclose side effects, persistence, whether changes affect renders or saved files, or any permission/context requirements.

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 description is short, front-loaded, and structured with Args and Returns sections. The Returns section is somewhat redundant because an output schema exists, but it does not harm readability.

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

Completeness3/5

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

The output schema covers return values, and the description fully specifies the two required parameters. However, with no annotations, it should do more to explain when to use the tool and what the toggle affects beyond the viewport overlay setting itself.

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. It does so by enumerating all valid overlay values and explaining that 'enabled' controls whether the overlay is enabled, which gives the agent enough to call the tool correctly.

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

Purpose4/5

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

States a specific verb and resource: 'Toggle a viewport overlay setting.' The purpose is clear, but it does not differentiate this tool from adjacent siblings like set_viewport_shading or other viewport-setting tools.

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

Usage Guidelines2/5

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

No when-to-use guidance, no prerequisites, and no alternatives are mentioned. The agent must infer that this tool is for toggling viewport overlays rather than other viewport or scene settings.

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