Skip to main content
Glama

draw_debug

Draw temporary debug lines, polylines, spheres, or point crosses in the viewport for a set duration to visualize positions and paths during simulation or scene inspection.

Instructions

Draw debug lines in the viewport, 2 pixels wide, for duration seconds: a line, a polyline, a sphere as three crossing lines, or a small cross per point.

    Isaac Sim draws with isaacsim.util.debug_draw, turned on at the first call. Its clear takes every line drawn
    with it, so when a drawing expires, lines other code drew with it go too. Other Kit apps draw with
    omni.debugdraw when they have it. A new stage drops the old one's drawings.

Input Schema

NameRequiredDescriptionDefault
endNoFor "line": its end [x, y, z]
sizeNoFor "points": how far each point's cross reaches, in stage units
colorNo[r, g, b] colour in 0-1; red when omitted
shapeYesWhat to draw: "lines" joins the points in order
startNoFor "line": its start [x, y, z]
centerNoFor "sphere": its centre [x, y, z]
pointsNoFor "points" and "lines": a list of [x, y, z]
radiusNoFor "sphere": its radius
durationNoHow long it shows, in seconds from the call, whether the simulation plays or not

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.2

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations, the description discloses critical behavior: drawings are 2 pixels wide, last for duration seconds, use isaacsim.util.debug_draw/omni.debugdraw depending on the app, and expiring a drawing clears all lines drawn through that debug draw, including other code's lines. It also warns that a new stage drops prior drawings.

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

Conciseness5/5

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

The description is front-loaded: the first sentence states the action and shape options, then it moves to backend and cleanup caveats. Every sentence carries useful information, with no filler.

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?

Given the rich schema, annotations, and output schema, the description covers the key ambiguities an agent would face: what is drawn, how long it persists, which backend is used, and the cross-code cleanup side effect. Return values need not be described because an output schema exists.

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 coverage is 100%, so the baseline is 3, but the description adds useful shape interpretation: line, polyline, sphere as three crossing lines, and points as small crosses. It does not explain every parameter, but it improves understanding of the required shape selector.

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 description states a specific verb and resource: 'Draw debug lines in the viewport,' and enumerates the exact shapes supported. This clearly distinguishes it from scene, camera, recording, and simulation siblings that do not draw transient debug geometry.

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?

Usage is implied by 'draw debug lines in the viewport,' but the description never states when to choose this over alternatives such as capture_viewport or viewport_light, nor when not to use it. The backend caveats are behavioral context rather than explicit usage routing.

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