Skip to main content
Glama

rename_ik_retarget_chain

Destructive

Rename a retarget chain in an IK Rig asset and save the change as one undo transaction. Returns the final unique name, plus renamed and saved status.

Instructions

Rename a retarget chain of an IK Rig asset through the IK Rig controller (one undo transaction) and save it. The engine makes the new name unique, so read new_name back; an unknown chain_name is not an error but returns renamed false, saved false and a note, with nothing saved. A failed save makes success false, with saved=false and save_error.

Returns: { asset_path: string, old_name: string, new_name: string, renamed: bool, saved: bool, save_error?: string, note?: string }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
new_nameYesRequested new name; the engine may add a suffix to keep it unique.
chain_nameYesCurrent name of the retarget chain, as get_ik_rig_info lists it.
ik_rig_pathYesIK Rig (UIKRigDefinition) asset path, e.g. "/Game/Retarget/IK_Hero".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.2.0
    • changedInput schema / properties / chain_name / description
      Previous value: -"Current name of the retarget chain"New value: +"Current name of the retarget chain, as get_ik_rig_info lists it."
    • 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 / new_name / description
      Previous value: -"New name to assign"New value: +"Requested new name; the engine may add a suffix to keep it unique."
  2. First observedv1.1.0

TDQS

A4.2/5.0
Behavior5/5

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

Although annotations already flag destructiveHint/idempotentHint, the description adds substantial behavioral context beyond them: it performs a single undo transaction, auto-uniquifies the name (requiring read-back), treats an unknown chain_name as a non-error returning renamed=false/saved=false plus a note with nothing saved, and surfaces save failures via success=false, saved=false, save_error. This is rich edge-case disclosure.

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-loaded with the core action, followed by error semantics and a Returns block. Mostly efficient, though phrasing like 'with saved=false and save_error' is slightly compressed. No redundancy worth removing.

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 correctly carries the return contract (asset_path, old_name, new_name, renamed, saved, save_error, note) and covers failure modes. For a destructive mutation tool with annotation coverage, nothing an agent needs to call it correctly 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 coverage is 100% and the new_name description already documents the engine suffix behavior, so the schema does the heavy lifting. The description reinforces the uniqueness/read-back point and the tolerance for unknown chain_name, but adds only marginal parameter-level detail 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?

States a specific verb+resource (rename a retarget chain of an IK Rig asset) and specifies it acts through the IK Rig controller. This is clearly distinguishable from siblings like rename_rig_element, rename_bone, and set_ik_retarget_chain_bones.

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 implies the usage context (renaming an existing chain, one undo transaction) but never explicitly states when to use this versus alternatives such as remove_ik_retarget_chain or set_ik_retarget_chain_bones. It gives preconditions implicitly (chain_name must be a known chain) without routing guidance.

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