Skip to main content
Glama

draw_debug

Marks points, rays, and paths with temporary 2-pixel lines, polylines, spheres, or crosses in the Isaac Sim viewport for visual checks and viewport captures without altering the stage.

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.

Use it to mark points, rays or paths, such as a raycast's hit, for a capture or the user to see: on Isaac Sim 6.x the lines show in capture_viewport's image. Nothing is added to the stage. In Isaac Sim, when a drawing expires, lines other code drew with isaacsim.util.debug_draw go too. A new stage drops the old one's drawings.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "shape": "<shape>"
    },
    "name": "draw_debug"
  }
}

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.6/5.0
Behavior5/5

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

Goes well beyond annotations by disclosing a shared-state side effect: expired drawings also remove lines other code drew via isaacsim.util.debug_draw, and a new stage drops the previous stage's drawings. Also clarifies that nothing is added to the stage, which materially changes how an agent treats this versus create_prim.

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?

Front-loaded with the action and rendering contract, then usage, then caveats. Every sentence adds a distinct fact (shape rendering, integration with capture, stage non-persistence, side effects) with no repetition of the schema.

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?

With annotations present and an output schema, the description covers safety, persistence, lifetime and side effects well. The remaining gap is per-shape parameter requirements, which the description leaves entirely to the schema.

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 a 3; the description earns above that by explaining that a sphere renders as three crossing lines and each point as a cross, plus the fixed 2px width. It does not state which shape-specific params are mandatory per shape, which stays with the schema.

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?

Specific verb plus resource ("Draw debug lines in the viewport") with the exact rendering semantics (2px wide, `duration` seconds) and an enumeration of the four shapes. An agent knows exactly what the call produces, and no sibling tool competes for this job.

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

Usage Guidelines4/5

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

Explicitly states the use case ("mark points, rays or paths, such as a raycast's hit, for a capture or the user to see") and names the integration point (capture_viewport on Isaac Sim 6.x). No when-not-to-use or named alternative for persistent geometry, so short of a 5.

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