Skip to main content
Glama

add_ik_retarget_chain

Add a retarget bone chain between two skeleton bones in an IK Rig asset, optionally attach an IK goal, and save the updated rig.

Instructions

Add a retarget bone chain from start_bone to end_bone, optionally tied to an IK goal, to an IK Rig asset and save it. Both bones must exist in the skeleton of the rig; the chain name is made unique, so read chain_name back. A failed save makes success false, with saved=false and save_error.

Returns: { asset_path: string, chain_name: string, start_bone: string, end_bone: string, goal_name: string, chain_count: int, saved: bool, save_error?: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
end_boneYesLast bone of the chain; must exist in the skeleton of the rig.
goal_nameNoIK goal to attach the chain to (default none); not checked against the goals of the rig.
chain_nameYesName for the new retarget chain (uniquified by the engine)
start_boneYesFirst bone of the chain; must exist in the skeleton of the rig.
ik_rig_pathYesIK Rig (UIKRigDefinition) asset path, e.g. "/Game/Retarget/IK_Hero".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / end_bone / description
      Previous value: -"Last bone in the chain"New value: +"Last bone of the chain; must exist in the skeleton of the rig."
    • changedInput schema / properties / goal_name / description
      Previous value: -"Optional IK goal to attach the chain to"New value: +"IK goal to attach the chain to (default none); not checked against the goals of the rig."
    • changedInput schema / properties / ik_rig_path / description
      Previous value: -"Path to the UIKRigDefinition asset"New value: +"IK Rig (UIKRigDefinition) asset path, e.g. \"/Game/Retarget/IK_Hero\"."
    • changedInput schema / properties / start_bone / description
      Previous value: -"First bone in the chain"New value: +"First bone of the chain; must exist in the skeleton of the rig."
  2. First observedv1.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (non-destructive, non-idempotent, not open-world), and the description adds real behavioral detail: the chain name is engine-uniquified so chain_name must be read back, and a failed save yields success=false with saved=false and save_error. That is meaningful context an agent cannot derive from the annotations alone.

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?

Front-loads the core action and constraint, then a compact return-shape block. Most sentences earn their place; the returns block is justified because no output schema exists. Slightly verbose but well-structured.

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 no output schema, the description appropriately documents the return fields and error semantics, and covers the uniqueness/save behavior. Combined with annotations and a fully documented schema, an agent has enough to call it correctly; only explicit alternative-tool guidance is missing.

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?

Schema description coverage is 100%, so each parameter is already documented in the schema. The description restates the start_bone/end_bone skeleton constraint and notes the goal is optional, adding little beyond the schema, so the baseline of 3 applies.

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?

States a specific verb (Add) and resource (retarget bone chain from start_bone to end_bone) targeting an IK Rig asset, which distinguishes it clearly from siblings like add_ik_goal, add_ik_solver, and set_ik_retarget_chain_bones. The optional IK goal tie-in further narrows the scope.

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?

Gives a clear precondition (both bones must exist in the rig skeleton) and states the tool saves the asset, which tells the agent this is a mutating creation step. It does not explicitly contrast against alternatives like rename_ik_retarget_chain or set_ik_retarget_chain_bones, so it stops short of full when/when-not routing.

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