Tools reference

All 173 tools XIV MCP offers your assistant, by module, with what each one does.

Your assistant picks these tools on its own; you never call them yourself. This list shows what it can use, so you know what to ask for and which setting a tool follows.

Reads tools only look. They follow the Reading setting of their module (Allow, Ask or Deny).
Changes tools act in the game or edit something. They follow the Changes setting.
The chips under each module show its default settings. You change them in /xivmcp → Modules, see Modules and permissions.

This page is generated from XIV MCP's own code on every build, so it always matches the version the documentation was built from.

The same list is in the game: /xivmcp → Info → Tools, with a filter, and with the tools of third-party plugins you enabled.

The Tools page of the Info tab: a filter field and a table of tools with access, source and what each does — /xivmcp → Info → Tools.

Core modules

Game data

Your character, inventory, quests, collections, surroundings and game data.

Reading: Allow

Tool	Kind	What it does
`get_game_status`	Reads	Checks whether you are logged in, where you are and what you are doing.
`get_character`	Reads	Looks at your character: job, level, stats, position and status effects.
`get_class_jobs`	Reads	Lists the levels and experience of all your classes and jobs.
`get_inventory`	Reads	Looks at your bags, armoury, saddlebags, crystals and other containers.
`search_inventory`	Reads	Finds where you keep an item and how many you have, including your retainers.
`get_equipment`	Reads	Looks at the gear you are wearing, with its materia, dyes and glamours.
`get_currencies`	Reads	Checks your gil, tomestones, scrips, seals and other currencies.
`list_unlock_categories`	Reads	Lists the kinds of unlocks it can check, such as mounts, emotes or recipes.
`check_unlocks`	Reads	Checks which achievements, mounts, minions, recipes and more you have unlocked.
`get_active_quests`	Reads	Lists the quests in your journal and how far along you are.
`check_quests`	Reads	Checks whether particular quests are done or accepted.
`get_party`	Reads	Looks at your party and alliance members.
`get_targets`	Reads	Checks what you and your target are targeting and casting.
`get_nearby_objects`	Reads	Lists the players, NPCs and objects around you.
`get_fates`	Reads	Lists the FATEs in your current zone.
`get_aetherytes`	Reads	Lists the aetherytes you have attuned to, with their teleport costs.
`get_companions`	Reads	Checks your chocobo companion, pet and trust members.
`get_submersibles`	Reads	Checks your free company submersibles and airships: routes, return times and loot.
`list_game_sheets`	Reads	Lists the game data tables, such as items, quests and actions.
`search_game_data`	Reads	Finds entries in the game data, such as an item or a quest by name.
`get_game_data_row`	Reads	Looks at one entry of the game data in full.
`inspect_window`	Reads	Looks at what an open game window shows.
`get_collections`	Reads	Checks how many mounts, minions, orchestrion rolls and other collectibles you own.
`get_armoire`	Reads	Looks at what is stored in your armoire.
`get_glamour_dresser`	Reads	Looks at the items in your glamour dresser.
`get_job_actions`	Reads	Lists the actions of a job, with their levels and cooldowns.
`get_hotbars`	Reads	Looks at what is on your hotbars.
`list_gearsets`	Reads	Lists your saved gear sets.
`get_cache_status`	Reads	Checks how recently XIV MCP saw your retainers, chests and submersibles.
`wait_for_cache_refresh`	Reads	Waits up to 10 minutes for you to open a retainer or chest, so XIV MCP sees it again.
`run_self_test`	Reads	Checks that XIV MCP and its connected plugins work. Changes nothing.
`plan_craft`	Reads	Checks what a crafting project needs: crafting order, missing materials and where to get them.
`list_plugins`	Reads	Lists your installed Dalamud plugins.
`get_position`	Reads	Looks at where you are: zone, area, map coordinates and the flag on your map.
`get_weather_forecast`	Reads	Checks the weather forecast of a zone and when a weather comes next.

Windows, NPCs, walking and travel, logins, gearsets and leaving duties.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`list_windows`	Reads	Lists the main menu windows it can open, such as the armoury or currencies.
`get_menu`	Reads	Looks at the choices of the menu or dialogue that is open.
`get_automation_status`	Reads	Checks which automation plugins XIV MCP pauses or waits for.
`get_navigation_status`	Reads	Checks whether your character is walking or travelling somewhere.
`list_characters`	Reads	Lists the characters XIV MCP has seen on your worlds and accounts.
`open_window`	Changes	Opens a game window, such as your armoury or currencies.
`close_window`	Changes	Closes an open game window.
`recover_game_state`	Changes	Frees your character from a stuck conversation or window, pressing Escape if needed.
`interact_with_object`	Changes	Talks to an NPC or uses an object near you, such as a summoning bell.
`run_autoretainer`	Changes	Opens a summoning bell and lets AutoRetainer handle your retainers.
`select_menu_option`	Changes	Clicks a choice in an open menu or dialogue. It can confirm purchases or discards.
`load_game_data`	Changes	Has the game send your achievements or your titles, without opening their windows.
`navigate_to`	Changes	Gets you to a bell, your house, an inn or a named place, or shows the way. Teleports cost gil.
`stop_navigation`	Changes	Stops your character from walking or travelling.
`switch_character`	Changes	Logs out and logs in as another of your characters, on any world.
`refresh_character_list`	Changes	Logs out and back in, so XIV MCP learns your list of characters.
`switch_gearset`	Changes	Changes your job by equipping one of your saved gear sets, never during combat.
`leave_duty`	Changes	Leaves the duty you are in, once the current fight is over.
`abandon_quest`	Changes	Abandons a quest in your journal. Its progress is lost.
`place_waymark_preset`	Changes	Places a saved set of waymarks in your current duty, outside of combat.
`set_map_flag`	Changes	Places the flag on your map at a spot in any zone, and can open the map.
`clear_map_flag`	Changes	Removes the flag from your map.
`start_route`	Changes	Plans a route as a background job: flags each stop on your map once you reach the one before.
`visit_world`	Changes	Takes your character to another world or data center, or tells you how to get there.
`show_xivmcp_window`	Changes	Opens the XIV MCP window on a tab, for example to show you a job or a plugin.

Items & retainers

Moving items and gil, retainers, ventures, submersibles, collectables and the FC chest.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_retainers`	Reads	Lists your retainers with their jobs, gil and current ventures.
`get_retainer_inventories`	Reads	Looks at what your retainers are holding and selling.
`get_fc_chest`	Reads	Looks at what is in your free company chest.
`find_ventures`	Reads	Finds which venture brings back an item and which retainer can go.
`sort_inventory`	Changes	Sorts your bags, armoury, saddlebag or a retainer inventory with the game's own sorting.
`move_items`	Changes	Moves items between your bags, armoury, saddlebag, retainers and chest, one at a time.
`open_retainer`	Changes	Calls a retainer at the summoning bell.
`close_retainer`	Changes	Dismisses the retainer you are talking to.
`transfer_retainer_items`	Changes	Moves stacks of items between your retainers and your bags.
`refresh_retainer_inventories`	Changes	Calls each retainer once at a summoning bell next to you, so XIV MCP knows what they hold.
`assign_venture`	Changes	Sends a retainer on a venture. Costs venture tokens.
`recall_venture`	Changes	Calls a retainer back from a running venture, only after you approve it.
`turn_in_collectables`	Changes	Takes you to an appraiser and hands in your collectables for scrips, stopping before the scrip cap.
`move_gil`	Changes	Moves gil between you and a retainer or the free company chest.
`repair_submersible`	Changes	Repairs a submersible's parts with Magitek Repair Materials.
`collect_submersible`	Changes	Collects what returned submersibles found, and shows their new rank and sectors.
`deploy_submersible`	Changes	Sends submersibles on a voyage, on their last route or a new one. Uses Ceruleum Tanks.
`recall_submersible`	Changes	Recalls a submersible from its voyage; the Ceruleum Tanks used are not refunded.
`dye_item`	Changes	Dyes a piece of your gear in a color, using a dye from your bags.
`equip_items`	Changes	Puts on pieces of gear from your bags or armoury chest.
`retrieve_glamour_item`	Changes	Takes an item out of your glamour dresser or armoire into your bags.

Market & purchases

Buying from vendors and selling on the market board.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_market_listings`	Reads	Looks at what your retainers are selling and whether someone sells cheaper.
`get_sales`	Reads	Lists the sales your retainers made while XIV MCP was running.
`list_approvals`	Reads	Lists the spending approvals you have given.
`buy_item`	Changes	Buys an item from a vendor. Purchases not paid in gil ask you first.
`buy_from_market_board`	Changes	Buys an item on the market board, the cheapest offers first, up to your price limit.
`request_spending_approval`	Changes	Asks you to allow spending up to an amount of one currency, so later purchases need no more asking.
`revoke_approval`	Changes	Withdraws a spending approval you have given.
`sell_item`	Changes	Lists an item through a retainer, just below the cheapest offer. Prices far too low are refused.
`sell_to_vendor`	Changes	Sells items from your bags to a merchant for gil, while the shop is open.
`reprice_listings`	Changes	Undercuts cheaper offers on your listings. Cuts of more than 30 percent are skipped.
`get_sale_history`	Changes	Calls a retainer at the summoning bell to look at their recent sales.

UI editing

Macros and waymark presets.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_macros`	Reads	Looks at your macros.
`list_waymark_presets`	Reads	Lists your saved waymark presets.
`get_waymark_preset`	Reads	Looks at where a waymark preset places its markers.
`set_macro`	Changes	Writes or changes a macro. The old macro is backed up first.
`clear_macro`	Changes	Deletes a macro. It is backed up first.
`set_waymark_preset`	Changes	Saves a waymark preset to one of your preset slots, replacing what was there.

Online lookups

Item sources, market prices and fishing data from the web.

Reading: Deny

Tool	Kind	What it does
`get_item_sources`	Reads	Finds online where an item comes from: crafting, vendors, drops or gathering.
`get_market_prices`	Reads	Checks current market board prices online.
`find_fish`	Reads	Finds online where, when and with which bait a fish bites, and how to catch it.
`get_fashion_report`	Reads	Looks at this week's Fashion Report: theme, hints, ready-made sets and which items you have.

Plugin management

Other plugins and their settings, which may contain secrets.

Reading: Deny Changes: Deny

Tool	Kind	What it does
`list_plugin_config_files`	Reads	Lists the settings files of another plugin.
`get_plugin_config`	Reads	Looks at the settings of another plugin, including any passwords or keys stored there.
`set_plugin_enabled`	Changes	Turns another plugin on or off.
`reload_plugin`	Changes	Restarts another plugin.
`set_plugin_config`	Changes	Changes the settings of another plugin. The old settings are backed up first.

Background jobs

Background jobs; each step is checked against its own group.

Reading: Allow Changes: Allow

Tool	Kind	What it does
`list_jobs`	Reads	Lists your background jobs and how far they have got.
`get_job`	Reads	Looks at the steps and log of one background job.
`start_job`	Changes	Starts a background job: tasks that run one after another, each following your settings here.
`update_job`	Changes	Retries, skips or changes the steps of a background job.
`pause_job`	Changes	Pauses a background job.
`resume_job`	Changes	Continues a paused background job.
`cancel_job`	Changes	Stops a background job.
`wait`	Reads	Waits a while, as a step of a background job.
`wait_until_arrived`	Reads	Waits until you reach a spot on the map, as a step of a background job.

Trading

Trading items and gil with other players. Every trade asks you in game, with what both sides hold.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_trade`	Reads	Looks at the trade window: who you trade with and what each side offers.
`trade_with_player`	Changes	Trades items and gil with a player next to you. Every trade asks you first.
`cancel_trade`	Changes	Cancels the open trade. Nothing changes hands.

Screen

Screenshots of your game, which can show chat, names and anything else on screen.

Reading: Ask

Tool	Kind	What it does
`take_screenshot`	Reads	Looks at your screen: takes a screenshot of the game or of the XIV MCP window.

These modules drive one other plugin each. They are only offered while that plugin is loaded, and they have their own settings, independent of the core modules. A tool that changes something lists the capabilities it uses.

AutoDuty

Runs and loops dungeons until a loop count, item or currency target is reached.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`list_duties`	Reads	Lists the duties that can be run for you, with their levels and modes.
`get_duty_status`	Reads	Checks whether a dungeon run is going on and how far it has got.
`stop_duty`	Changes (`combat`)	Stops the dungeon run once the current fight is over.
`run_duty`	Changes (`combat`, `move_character`, `game_ui`)	Runs a dungeon with NPC allies or a party, as often as needed. Your character can be defeated.
`farm_duty_item`	Changes (`combat`, `move_character`, `game_ui`, `network`)	Runs a dungeon that drops an item until you have as many as you want.

Artisan

Crafts and crafting lists, and Raphael solutions prepared ahead of time.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_crafting_lists`	Reads	Lists your crafting lists.
`set_crafting_list`	Changes (`edit_settings`)	Creates or changes a crafting list. The old lists are backed up first.
`delete_crafting_list`	Changes (`edit_settings`)	Deletes a crafting list. The old lists are backed up first.
`craft_item`	Changes (`game_ui`)	Crafts an item a number of times, using your materials.
`crafting_control`	Changes (`game_ui`)	Starts, pauses or stops a crafting list.
`run_crafting_list`	Changes (`game_ui`)	Crafts a whole crafting list, using your materials.
`prepare_craft_plan`	Changes (`edit_settings`)	Writes a crafting list for a project and works out each craft in advance. Crafts nothing yet.

GatherBuddy Reborn

Auto-gathering and its gather lists.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_gather_lists`	Reads	Lists your gathering lists.
`set_gather_list`	Changes (`edit_settings`)	Creates or changes a gathering list. The old lists are backed up first.
`delete_gather_list`	Changes (`edit_settings`)	Deletes a gathering list. The old lists are backed up first.
`set_auto_gather`	Changes (`move_character`, `game_ui`)	Turns automatic gathering on or off. While it is on, your character moves and gathers on its own.
`gather_until`	Changes (`move_character`, `game_ui`, `edit_settings`)	Gathers until you have the amounts you need, moving your character from node to node.

Item Vendor Location

Which NPCs sell an item and where they stand.

Reading: Allow

Tool	Kind	What it does
`find_vendors`	Reads	Finds which NPCs sell an item and where they stand.

FCCH

Free company chest deposits and withdrawals.

Changes: Deny

Tool	Kind	What it does
`fc_chest_transfer`	Changes (`move_items`, `game_ui`)	Puts items into the free company chest or takes them out.

Gold Saucer

Triple Triad and the Cactpot lotteries with Saucy; your cards, opponents and decks also with TriadBuddy.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`list_triad_npcs`	Reads	Lists Triple Triad opponents with where they stand, their rules and which of their cards you have.
`list_triad_cards`	Reads	Lists Triple Triad cards you have or are missing, and who gives them.
`get_triad_decks`	Reads	Looks at your saved Triple Triad decks.
`set_triad_deck`	Changes (`edit_settings`)	Saves five of your Triple Triad cards as one of your decks.
`get_saucy_stats`	Reads	Checks how many Triple Triad matches were played, won and lost, and the cards and MGP won.
`build_triad_deck`	Changes (`edit_settings`, `game_ui`)	Builds the best deck against a Triple Triad opponent and saves it as your fifth deck.
`play_triple_triad`	Changes (`move_character`, `game_ui`, `spend_currency`)	Goes to a Triple Triad opponent and plays a number of matches, or until a card drops.
`farm_triad_cards`	Changes (`move_character`, `game_ui`, `spend_currency`)	Collects missing Triple Triad cards from one opponent, or from opponent to opponent.
`play_mini_cactpot`	Changes (`move_character`, `game_ui`, `spend_currency`, `edit_settings`)	Goes to the Mini Cactpot broker and plays your tickets for today.
`play_jumbo_cactpot`	Changes (`move_character`, `game_ui`, `spend_currency`, `edit_settings`)	Collects your Jumbo Cactpot prizes and buys this week's tickets with your numbers or random ones.
`stop_saucy`	Changes (`game_ui`)	Stops Triple Triad and travel that are running at the Gold Saucer.
`present_fashion_report`	Changes (`move_character`, `move_items`, `game_ui`, `discard_items`)	Puts on your Fashion Report outfit and presents it to the Masked Rose for judging.
`complete_fashion_report`	Changes (`move_character`, `move_items`, `game_ui`, `spend_gil`, `network`, `discard_items`)	Gets, dyes and puts on this week's easy Fashion Report set, then presents it for judging.

Custom Deliveries

Custom deliveries with Satisfier: this week's requests, and delivering them by crafting, gathering or fishing.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_custom_deliveries`	Reads	Lists this week's custom deliveries: each client's requests, rank and deliveries left.
`deliver_custom_delivery`	Changes (`move_character`, `game_ui`, `spend_gil`)	Delivers one client's request by crafting, gathering or fishing it, with Satisfier.
`do_custom_deliveries`	Changes (`move_character`, `game_ui`, `spend_gil`)	Does this week's custom deliveries for all clients, one after another, as a job.
`stop_custom_delivery`	Changes (`game_ui`)	Stops the custom delivery Satisfier is doing.

Ocean fishing

Ocean fishing voyages: the schedule and routes, boarding at the ferry docks, and a job that fishes voyages with AutoHook until a target.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_ocean_fishing_schedule`	Reads	Lists the next ocean fishing voyages, their stops and the fish worth going for.
`get_ocean_fishing_status`	Reads	Checks the voyage you are on: the stop, time left, spectral current, missions and points.
`board_ocean_fishing`	Changes (`move_character`, `game_ui`)	Goes to the ferry docks in Limsa Lominsa and boards the voyage while boarding is open.
`set_ocean_fishing_alarm`	Changes (`edit_settings`)	Turns the Distant Seas departure alarm on or off.
`import_ocean_presets`	Changes (`edit_settings`, `network`)	Imports AutoHook's ocean fishing presets for a goal: points, legends, achievements or levelling.
`go_ocean_fishing`	Changes (`move_character`, `game_ui`, `spend_gil`, `edit_settings`)	Fishes ocean voyages with AutoHook until your target: voyages, points or a fish.
`fish_ocean_voyages`	Changes (`move_character`, `game_ui`, `edit_settings`)	Boards and fishes voyages one after another, as a step of an ocean fishing job.

AutoHook

Fishing with AutoHook: presets built for the fish you are after, fishing until it is caught, and a job that does it all.

Changes: Deny

Tool	Kind	What it does
`set_autohook_preset`	Changes (`edit_settings`)	Sets up automatic hooking for the fish you are after.
`fish_until`	Changes (`game_ui`, `edit_settings`)	Fishes until you have caught a fish, waiting for its time and weather.
`catch_fish`	Changes (`move_character`, `game_ui`, `spend_gil`, `edit_settings`)	Catches a fish for you: travels there, buys bait, waits for its window and fishes.
`stop_fishing`	Changes (`game_ui`)	Stops fishing and reels in your line.

Questionable

Quests with Questionable: a quest with the quests it needs first, the day's allied society quests, and the main scenario.

Reading: Allow Changes: Deny

Tool	Kind	What it does
`get_questing_status`	Reads	Looks at which quest is being done for you, and at your allied society reputation.
`complete_quest`	Changes (`combat`, `move_character`, `game_ui`, `edit_settings`)	Does a quest for you, together with the quests it needs first.
`do_tribe_dailies`	Changes (`combat`, `move_character`, `game_ui`, `edit_settings`)	Does the day's allied society quests for you, rank-up quests included.
`do_quests`	Changes (`combat`, `move_character`, `game_ui`, `edit_settings`)	Does quests for you until they are done.
`start_main_scenario`	Changes (`combat`, `move_character`, `game_ui`)	Starts doing the main scenario quests for you.
`stop_questing`	Changes (`game_ui`)	Stops doing quests for you, once a fight is over.

Tools from other plugins

Plugins you install can add their own tools. They appear in /xivmcp → Third-party plugins once you enable them, not in this list. See Third-party plugins.

Tools reference

Core modules

Game data

Game & navigation

Items & retainers

Market & purchases

UI editing

Online lookups

Plugin management

Background jobs

Trading

Screen

Integrations

AutoDuty

Artisan

GatherBuddy Reborn

Item Vendor Location

FCCH

Gold Saucer

Custom Deliveries

Ocean fishing

AutoHook

Questionable

Tools from other plugins

On this page

Tools reference

Core modulesCopy Anchor Link

Game dataCopy Anchor Link

Game & navigationCopy Anchor Link

Items & retainersCopy Anchor Link

Market & purchasesCopy Anchor Link

UI editingCopy Anchor Link

Online lookupsCopy Anchor Link

Plugin managementCopy Anchor Link

Background jobsCopy Anchor Link

TradingCopy Anchor Link

ScreenCopy Anchor Link

IntegrationsCopy Anchor Link

AutoDutyCopy Anchor Link

ArtisanCopy Anchor Link

GatherBuddy RebornCopy Anchor Link

Item Vendor LocationCopy Anchor Link

FCCHCopy Anchor Link

Gold SaucerCopy Anchor Link

Custom DeliveriesCopy Anchor Link

Ocean fishingCopy Anchor Link

AutoHookCopy Anchor Link

QuestionableCopy Anchor Link

Tools from other pluginsCopy Anchor Link

On this page

Core modules

Game data

Game & navigation

Items & retainers

Market & purchases

UI editing

Online lookups

Plugin management

Background jobs

Trading

Screen

Integrations

AutoDuty

Artisan

GatherBuddy Reborn

Item Vendor Location

FCCH

Gold Saucer

Custom Deliveries

Ocean fishing

AutoHook

Questionable

Tools from other plugins