Skip to main content
Glama

add_ik_rig_retarget_chain

Add a retarget chain to an IK Rig asset to map a bone range for motion transfer between skeletons.

Instructions

Add a named retarget chain to an existing IK Rig asset.

Retarget chains map a contiguous range of bones (e.g. "Spine" from pelvis → chest, or "LeftArm" from shoulder → hand) so the IK Retargeter knows how to transfer motion from source to target.

Call this after create_ik_rig when auto_generate_chains=False, or to add extra chains the auto-generator missed.

Args: ik_rig_name: Asset name (e.g. "IKR_MyCharacter") ik_rig_path: Content folder (e.g. "/Game/Animation/IKRigs") chain_name: Logical name for the chain (e.g. "Spine", "LeftArm") start_bone: Root bone of the chain (e.g. "spine_01") end_bone: Leaf bone of the chain (e.g. "spine_05") ik_goal_name: Optional IK goal name to attach to the chain end bone

Returns: dict with keys: success, chain_name, message

KB: see knowledge_base/05_ANIMATION_SYSTEM.md#overview Example: add_ik_rig_retarget_chain(ik_rig_name="ExampleName", ik_rig_path="/Game/MCP_Test/Example", chain_name="ExampleName", start_bone="Example", end_bone="Example")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
end_boneYes
chain_nameYes
start_boneYes
ik_rig_nameYes
ik_rig_pathYes
ik_goal_nameNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It mentions the operation (adds a chain) and returns a dict with success/chain_name/message, and notes a prerequisite (call after create_ik_rig). However, it does not disclose potential side effects (e.g., overwriting existing chains), required permissions, or error behavior beyond the message field. This is a moderate gap given the absence of 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 well-structured with sections for purpose, usage, args, returns, KB reference, and example. It is longer than minimal but every part serves a purpose—no redundancy. The use of headers and examples aids readability, though it could be slightly more concise by trimming the retarget chain explanation.

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?

The description covers the main operational aspects: what it does, when to use it, parameter meanings, return format, a knowledge base reference, and a full example. It lacks explicit error-handling details or behavior on duplicate chains, but given the tool's moderate complexity and the presence of an output schema, it is sufficiently complete for an agent to call it correctly.

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?

The schema has zero description coverage, so the description fully compensates by providing detailed explanations for every parameter with concrete examples (e.g., ik_rig_name="IKR_MyCharacter", start_bone="spine_01"). It also clarifies the optional ik_goal_name. This adds substantial meaning beyond 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 description clearly states the tool adds a named retarget chain to an existing IK Rig asset. It explains what retarget chains do (map bone ranges for motion transfer) and distinguishes it from siblings like create_ik_rig and set_ik_rig_retarget_root by specifying its exact role. The purpose is specific and unambiguous.

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?

The description explicitly states when to call it: after create_ik_rig when auto_generate_chains=False, or to add extra chains the auto-generator missed. This provides clear usage context. However, it does not explicitly mention when not to use it or alternative tools for related tasks, though the conditions imply the appropriate scenario.

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