Skip to main content
Glama

set_ik_rig_retarget_root

Assign the retarget root bone on an IK Rig to align source and target characters during retargeting. Specify the IK rig asset and choose the pelvis or hips bone as the root.

Instructions

Set the retarget root bone on an IK Rig.

The retarget root is typically the pelvis/hips bone. It is used by the IK Retargeter to align the global position of source and target characters.

Args: ik_rig_name: Asset name (e.g. "IKR_MyCharacter") ik_rig_path: Content folder (e.g. "/Game/Animation/IKRigs") root_bone: Bone name to use as retarget root (e.g. "pelvis")

Returns: dict with keys: success, message

KB: see knowledge_base/05_ANIMATION_SYSTEM.md#overview Example: set_ik_rig_retarget_root(ik_rig_name="ExampleName", ik_rig_path="/Game/MCP_Test/Example", root_bone="Example")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
root_boneYes
ik_rig_nameYes
ik_rig_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior2/5

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

There are no annotations, so the description carries the full behavioral disclosure burden. It reveals the return type and provides an example, but it does not mention side effects, prerequisites, failure modes, or whether the operation overwrites an existing retarget root. For a mutation tool, this is a meaningful gap.

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 well structured with Purpose, Args, Returns, KB, and Example sections. Every section is functional and there is no filler, though the formatting is slightly longer than strictly necessary.

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?

For a simple three-parameter setter, the description covers all parameters, gives concrete examples, states the return shape, and points to the knowledge base. It is missing explicit preconditions and error behavior, but overall an agent can invoke the tool with reasonable confidence.

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

Parameters5/5

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

Schema description coverage is 0%, but the description fully compensates by documenting each parameter with both a human explanation and an example: ik_rig_name, ik_rig_path, and root_bone. This is exactly the semantic detail an agent needs that the bare schema lacks.

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 opens with a specific verb-resource pair: 'Set the retarget root bone on an IK Rig.' It also explains the purpose of the retarget root, distinguishing this tool from related IK Rig creation and retargeting tools by focusing specifically on the root-bone assignment.

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?

The description gives helpful context ('typically the pelvis/hips bone', 'used by the IK Retargeter to align the global position'), which implies when the tool is relevant. However, it does not explicitly state when to choose this tool over or against alternatives such as add_ik_rig_retarget_chain or create_ik_retargeter.

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