equip

Puts an item from the pack on a party member, or takes one off, the way the inventory screen does, so the game’s rules apply (requirements, which items fit which slot).

action is one of:

  • equip (default): puts item in slot. Whatever the slot held goes back to the pack. Returns what the slot held before and holds after, and whether it worked (equipped). If it did not, the answer says whether the game thinks the creature can use the item (canUse), with its requirements and restrictions where known.
  • unequip: takes item off and puts it in the pack. Returns whether it came off (unequipped).

It acts on the party member selected in the interface. If id names another, that one is selected for the call and control is handed back afterwards (selectedFirst).

Arguments

Name Type Required What
action "equip" | "unequip"   What to do. Default: equip.
item string yes The item, by its id from inventory or equipment.
slot any   For equip: the slot, by name (main, offhand, ring1, ring2, …) or number. Default: the first slot the item fits.
id string   The party member, by creature id. Default: the one selected in the interface.

Call it as equip over MCP, or POST /api/tool/equip with the arguments as JSON.