Skip to main content
Glama

get_physics_constraint_info

Read-onlyIdempotent

Read a physics constraint actor's authored setup—wired bodies/bones, limits, drives, break thresholds, projection, collision flags—returning the serialized template, not live simulation state.

Instructions

Read the full authored configuration of a world APhysicsConstraintActor's UPhysicsConstraintComponent: identity + wired bodies/bones, linear/angular limits (with motion types), linear/angular drives (motors) with targets, breakable thresholds, projection, and collision/dominance flags. Read-only complement of spawn_physics_constraint / set_constraint_limits / set_physics_constraint_drives; returns the serialized template, not live simulation state (no motor torque/broken/force values, which are 0 outside PIE).

Returns: { constraint_actor_name: string, constraint_component: string, constraint_actor1?: string, constraint_actor2?: string, constraint_bone1: string, constraint_bone2: string, linear_limit: number, linear_x_motion: string, linear_y_motion: string, linear_z_motion: string, swing1_limit: number, swing1_motion: string, swing2_limit: number, swing2_motion: string, twist_limit: number, twist_motion: string, angular_drive_mode: string, angular_orientation_drive: bool, angular_velocity_drive: bool, angular_drive_spring: number, angular_drive_damping: number, angular_drive_force_limit: number, angular_orientation_target: [number], linear_position_drive: bool, linear_velocity_drive: bool, linear_drive_spring: number, linear_drive_damping: number, linear_drive_force_limit: number, linear_position_target: [number], linear_breakable: bool, linear_break_threshold: number, angular_breakable: bool, angular_break_threshold: number, projection_enabled: bool, projection_linear_alpha: number, projection_angular_alpha: number, projection_linear_tolerance: number, projection_angular_tolerance: number, parent_dominates: bool, disable_collision: bool, found: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
constraint_actor_nameYesLabel/name of the APhysicsConstraintActor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, non-destructive, and closed-world traits. The description adds substantial context beyond that: it explains exactly which configuration aspects are returned, that the result is a serialized template rather than runtime simulation state, and that certain values are zero outside PIE. No contradiction with annotations.

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 front-loaded with a clear purpose sentence, then a useful distinction from siblings, then a detailed Returns list. The Returns list is long but earns its place because no output schema exists; however, it is dense enough that it slightly exceeds what is usually ideal for a description.

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?

With no output schema, the description provides a complete field-level return structure. Combined with the annotations and input schema, an agent has everything needed to call the tool and interpret the result correctly, including the important caveat about zeroed runtime values outside PIE.

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

Parameters3/5

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

The schema has 100% description coverage for the single required parameter ('constraint_actor_name' labeled as 'Label/name of the APhysicsConstraintActor'). The description does not add further meaning, syntax, or lookup guidance for that parameter, so baseline 3 is appropriate.

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 uses a precise verb ('Read') and resource ('full authored configuration of a world APhysicsConstraintActor's UPhysicsConstraintComponent'), and explicitly distinguishes itself from the write-oriented siblings spawn_physics_constraint, set_constraint_limits, and set_physics_constraint_drives. An agent can identify its exact scope without opening the schema.

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 names the alternative mutation tools and states its use case as their read-only complement. It also sets a clear when-not boundary by explaining that it returns the serialized authored template rather than live simulation state (motor torque/broken/force values are zero outside PIE).

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