API Key Scopes#

GW2 MCP Server tools that access account-specific data require a Guild Wars 2 API key with specific permission scopes. This page lists the scopes required by each authenticated tool and describes each available scope.

Tool Scope Requirements#

Every authenticated tool requires the account scope plus zero or more additional scopes. Tools not listed here do not require an API key.

ToolRequired Scopes
get_accountaccount
get_account_dailiesaccount, progression
get_account_progressaccount, progression
get_account_unlocksaccount, unlocks
get_bankaccount, inventories
get_charactersaccount, characters
get_guild_detailsaccount, guilds
get_inventoryaccount, inventories
get_materialsaccount, inventories
get_token_infoany valid key
get_tp_deliveryaccount, tradingpost
get_tp_transactionsaccount, tradingpost
get_walletaccount, wallet
get_wizards_vault_listingsaccount, progression
get_wizards_vault_objectivesaccount, progression

If the API key is missing a required scope, the GW2 API returns an authorization error.

Available Scopes#

ScopeDescription
accountBasic account information. Required by all authenticated tools.
charactersCharacter names, equipment, builds, and crafting disciplines.
guildsGuild detail endpoints: log, members, ranks, stash, storage, treasury, teams, upgrades. Requires guild leader permissions on the key’s account.
inventoriesBank vault, material storage, and shared inventory slots.
progressionAchievements, masteries, mastery points, luck, daily completions, and Wizard’s Vault objectives and listings.
tradingpostTrading Post delivery box and transaction history (current and past 90 days).
unlocksAccount unlocks: skins, dyes, minis, titles, recipes, finishers, outfits, gliders, mail carriers, novelties, emotes, mount skins, mount types, skiffs, and jade bots.
walletCurrency balances (gold, karma, gems, etc.).

Key Management#

API keys are created and managed at Guild Wars 2 API Key Management .

The API key is configured via the GW2_API_KEY environment variable. See Configuration for details on setting environment variables.

See Also#