Skip to main content
Glama

set_physics_properties

Set a USD prim's PhysX simulation properties—mass, density, friction, restitution, and collision—while leaving omitted values unchanged.

Instructions

Set a prim's mass or density, friction or restitution, or make it a collider or turn its collision off, for PhysX; a value left out stays as it is.

collision=true makes a static collider, such as a floor something should land on, with no rigid body and no physics material: only a Cube, Sphere, Capsule, Cylinder, Cone, Mesh or Plane collides, so an Xform is refused, its error naming the shapes under it. A Mesh that moves with a rigid body, its own or an ancestor's, not kinematic, gets a convexHull approximation unless one is set, as PhysX can't simulate a triangle mesh there. collision=false turns physics:collisionEnabled off and keeps the API. Mass or density goes through MassAPI and makes the prim a rigid body (RigidBodyAPI) if it isn't one, so a static collider starts to fall when the simulation plays. Friction or restitution adds the Collision API if missing, and sets them on the prim's own physics material, a child named PhysMat (/World/Cube/PhysMat for /World/Cube), bound to the prim for physics only; delete_prim removes it with the prim. That material starts from the body's own: the physics material bound to it before, else the physics scene's default, else PhysX's (friction 0.5, restitution 0), so the one left out, and anything else the replaced material held, stays. A copy made with clone_prim takes its own with it. A clone that inherits from its source, as Isaac Sim's cloner makes them, follows the source's material until a call on the clone, and the answer names the prims a call changes so. An instance or an inactive prim can hold no material of its own, so friction or restitution on one is refused, as collision is on an inactive prim or one inside an instance. A prim on an older extension's shared /World/PhysicsMaterials/_PhysMat moves to its own, and the call that moves the last prim off it deletes it. A call with friction or restitution reads the whole stage, about 1 s per 100,000 prims. The answer gives each value set, collision on or off, the material and the APIs applied, the rigid body a collider moves with, and whether the older shared material was deleted or kept, and why. For the prim's look, use set_material; to make a new prim physical in one call, create_prim with enable_physics.

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": {
      "prim_path": "<prim_path>"
    },
    "name": "set_physics_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
massNoMass in kg (applies MassAPI); 0 unsets it, so density decides
densityNoDensity in kg/m^3 (applies MassAPI); 0 unsets it; a mass set wins over it
frictionNoFriction coefficient, set as both static and dynamic friction
collisionNotrue makes the prim a collider (the Collision API), with no rigid body, such as a floor; false turns its collision off and keeps the API
prim_pathYesFull USD path of the prim, e.g. "/World/Robot"
restitutionNoBounciness: 0 no bounce, 1 full bounce

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.1
    • addedInput schema / properties / collision
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "true makes the prim a collider (the Collision API), with no rigid body, such as a floor; false turns its collision off and keeps the API",
      +  "title": "Collision"
      +}
  2. Changed1 schema field changedv0.2.3
    • changedInput schema / properties / friction / description
      Previous value: -"Static and dynamic friction coefficient"New value: +"Friction coefficient, set as both static and dynamic friction"
  3. First observedv0.2.2

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only say it is a non-read-only, non-destructive, closed-world call; the description goes far beyond that. It discloses side effects the annotations hide: mass implicitly adds RigidBodyAPI so a static collider starts to fall, friction/restitution creates a PhysMat child bound to the prim, shared legacy /World/PhysicsMaterials materials are migrated and possibly deleted, and a call with friction/restitution reads the whole stage at roughly 1 s per 100,000 prims.

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

Conciseness3/5

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

The core action is front-loaded in the first clause, which is good, but the remainder is a dense wall of run-on clauses mixing material lifecycle, clone/inheritance rules, legacy migration, and performance cost without bullets or paragraph breaks. Nearly every sentence carries real information, yet the packing makes it hard to scan for the one rule an agent needs.

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 six-parameter mutation tool with an output schema, this covers everything an agent needs: which shapes collide, what APIs get applied, what the answer reports, cost of the call, and edge cases around instances, clones, and legacy materials. No material gaps remain.

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 schema already documents each parameter, but the description adds genuinely new semantics: a null/omitted value leaves the current value untouched, collision=true yields a static collider with no rigid body while mass/density promotes the prim to a rigid body, and a mesh on a non-kinematic body gets a convexHull approximation unless one is set. That is meaning beyond the field-level descriptions, though the mass-vs-density precedence is left mostly to 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?

The opening sentence names the exact verb and resources: setting a prim's mass/density, friction/restitution, or collision state for PhysX, and states that omitted values are left unchanged. It distinguishes itself from siblings by explicitly routing look-and-feel to set_material and first-time physical setup to create_prim with enable_physics.

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?

It gives explicit alternatives (set_material for appearance, create_prim + enable_physics for new prims) and states the refusal conditions: an Xform cannot be a collider, instances and inactive prims cannot hold their own material, and collision on an inactive or instanced prim is refused. That is a complete when-to-use / when-not-to-use map.

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