Skip to main content
Glama

create_ik_rig

Creates an IK Rig asset for a skeletal mesh, defining retarget chains required for IK Retargeting. Use this to prepare source and target skeletons for animation retargeting.

Instructions

Create an IK Rig asset for a Skeletal Mesh.

IK Rigs define retarget chains (bone chains like Spine, LeftArm, RightLeg) and are required by the IK Retargeter. This tool uses the UE5 Python API (unreal.IKRigController) via exec_python.

Typical workflow:

  1. create_ik_rig for source skeleton (e.g. Mannequin)

  2. create_ik_rig for target skeleton (e.g. your custom character)

  3. create_ik_retargeter linking source → target

  4. batch_retarget_animations to export retargeted animations

Args: ik_rig_name: Asset name, e.g. "IKR_Mannequin" skeletal_mesh_path: Full content path, e.g. "/Game/Characters/Mannequin/SK_Mannequin" path: Destination content-browser folder auto_generate_chains: If True, calls apply_auto_generated_retarget_definition to auto-detect spine / limb chains (recommended for humanoid skeletons). Set False for custom chain setup.

Returns: dict with keys: success, asset_path, message

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNo/Game/Animation/IKRigs
ik_rig_nameYes
skeletal_mesh_pathYes
auto_generate_chainsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the behavioral burden. It discloses that creation uses unreal.IKRigController via exec_python, that auto_generate_chains triggers apply_auto_generated_retarget_definition, and that the return value is a dict with success, asset_path, and message. It does not cover overwrite behavior, error conditions, or validation failures, but it provides meaningful behavioral detail beyond the raw operation.

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: an opening summary, a compact workflow list, an Args section, Returns, KB pointer, and an example. It is longer than a minimal description but each section adds useful context, and the most important information is front-loaded. A few sentences, such as the KB reference, are optional but not wasteful.

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 tool's role, workflow position, all parameters, return shape, and an example, which is strong for a 4-parameter asset-creation tool. It lacks explicit information about failure modes, prerequisites like the skeletal mesh existing, and overwrite semantics, but these are relatively minor given the workflow and examples provided.

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?

Despite 0% schema description coverage, the description compensates fully by explaining every parameter: ik_rig_name with an example value, skeletal_mesh_path with a full content path example, path as the destination folder, and auto_generate_chains with behavioral meaning and a recommendation. This goes well beyond the bare schema property names and gives an agent enough semantic context to invoke the tool correctly.

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 identifies the tool's purpose: it creates an IK Rig asset for a Skeletal Mesh and explains that IK Rigs define retarget chains required by the IK Retargeter. It distinguishes this tool from siblings like create_ik_retargeter and add_ik_rig_retarget_chain by focusing on asset creation rather than retargeting or chain editing.

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 provides a numbered typical workflow showing when to call this tool for source and target skeletons, followed by create_ik_retargeter and batch_retarget_animations. It also gives conditional guidance on auto_generate_chains for humanoid skeletons versus custom setup. It does not explicitly state when not to use the tool, but the workflow strongly implies the correct context.

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