wow-api-mcp

wow-api-mcp

  

MCP server for World of Warcraft API data. Parses the ketho.wow-api VS Code extension's annotations and exposes structured WoW API data through queryable tools — including deprecated functions, replacements, parameter types, return types, game version compatibility, enums, events, and widget methods.

Built to give AI agents (Claude Code, Claude Desktop, etc.) accurate, structured WoW API data without relying on wiki template parsing.

Quick Start

1. Install the VS Code extension

The server reads WoW API data from the ketho.wow-api VS Code extension. Install it first:

code --install-extension ketho.wow-api

2. Add to your MCP client

Claude Code — add to your project's .mcp.json:

macOS / Linux: ``json { "mcpServers": { "wow-api": { "command": "npx", "args": ["wow-api-mcp"] } } } ``

Windows: ``json { "mcpServers": { "wow-api": { "command": "cmd", "args": ["/c", "npx", "wow-api-mcp"] } } } ``

3. Restart your MCP client

Restart Claude Code (or whichever client you're using) and the tools will be available.

Features

• Deprecated function tracking — know instantly if an API is deprecated, what replaced it, and which patch changed it
• Full function signatures — parameters with types, optional flags, defaults, and return values
• Game version awareness — see if a function exists in Mainline, Vanilla, or Mists
• Namespace browsing — explore all 260+ C_ namespaces
• Widget API — look up methods for any UI widget class (Frame, Button, etc.)
• Enum resolution — get actual values for any WoW enum
• Event payloads — see what parameters each frame event passes

Tools

| Tool | Description | |---|---| | lookup_api(name) | Look up a function by exact or partial name | | search_api(query) | Full-text search across API names and descriptions | | list_deprecated(filter?) | List deprecated functions with replacements | | get_namespace(name) | Get all functions in a C_ namespace (or "list" for all) | | get_widget_methods(widget_type) | Get widget class methods (or "list" for all) | | get_enum(name) | Look up enum values | | get_event(name) | Look up event payload parameters |

Usage Examples

> lookup_api("IsSpellKnown")

[DEPRECATED] IsSpellKnown
  Replaced by: C_SpellBook.IsSpellInSpellBook
  Replacement docs: https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellInSpellBook
  Parameters:
    spellID: number
    isPet: boolean
  Returns:
    isInSpellBook: boolean

> lookup_api("C_SpellBook.IsSpellKnown")

C_SpellBook.IsSpellKnown
  Description: Returns true if a player knows a spell...
  Wiki: https://warcraft.wiki.gg/wiki/API_C_SpellBook.IsSpellKnown
  Game versions: Mainline, Vanilla, Mists
  Parameters:
    spellID: number
    spellBank?: Enum.SpellBookSpellBank -- Default = Player
  Returns:
    isKnown: boolean

> list_deprecated("Spell")

9 deprecated function(s) matching "Spell":
IsSpellOverlayed -> C_SpellActivationOverlay.IsSpellOverlayed [patch 11.2.0]
IsPlayerSpell -> C_SpellBook.IsSpellKnown
IsSpellKnown -> C_SpellBook.IsSpellInSpellBook
...

> get_enum("SpellBookSpellBank")

Enum.SpellBookSpellBank:
  Player = 0
  Pet = 1

Data

Indexes the full WoW API from the extension's LuaLS annotations:

• 8,000+ functions with full signatures, parameters, return types, and wiki links
• 90+ deprecated functions with replacement function, replacement URL, and deprecation patch version
• 260 C_ namespaces (C_SpellBook, C_Item, C_Spell, etc.)
• 860+ widget types with methods (Frame, Button, ScriptRegion, etc.)
• 843 enums with values (Enum.SpellBookSpellBank, etc.)
• 1,716 events with payload parameters (ADDON_LOADED, PLAYER_LOGIN, etc.)
• 1,591 CVars
• Game version compatibility per function (Mainline, Vanilla, Mists)

Other MCP Clients

Claude Desktop

Add to your config file:

• Windows: %APPDATA%\Claude\claude_desktop_config.json
• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

macOS / Linux: ``json { "mcpServers": { "wow-api": { "command": "npx", "args": ["wow-api-mcp"] } } } ``

Windows: ``json { "mcpServers": { "wow-api": { "command": "cmd", "args": ["/c", "npx", "wow-api-mcp"] } } } ``

VS Code (Copilot / Other MCP Clients)

Add to your workspace .vscode/mcp.json:

macOS / Linux: ``json { "servers": { "wow-api": { "command": "npx", "args": ["wow-api-mcp"] } } } ``

Windows: ``json { "servers": { "wow-api": { "command": "cmd", "args": ["/c", "npx", "wow-api-mcp"] } } } ``

Configuration

Extension Discovery

The server auto-discovers the ketho.wow-api extension from these locations:

• ~/.vscode/extensions/ (VS Code)
• ~/.vscode-insiders/extensions/ (VS Code Insiders)
• ~/.vscode-oss/extensions/ (VS Code OSS / VSCodium)
• ~/.cursor/extensions/ (Cursor)

If your extension is installed elsewhere, set the WOW_API_EXT_PATH environment variable:

{
  "mcpServers": {
    "wow-api": {
      "command": "cmd",
      "args": ["/c", "npx", "wow-api-mcp"],
      "env": {
        "WOW_API_EXT_PATH": "/path/to/ketho.wow-api-0.22.1"
      }
    }
  }
}

Auto-allow Tools (Claude Code)

To skip permission prompts, add to .claude/settings.local.json:

{
  "permissions": {
    "allow": ["mcp__wow-api__*"]
  }
}

Updating

The server reads from the installed VS Code extension at startup. When the extension updates (typically with major WoW patches):

1. Update the extension in VS Code
2. Restart your MCP client

The server picks up the latest data automatically.

Development

To run from source:

git clone https://github.com/Wutname1/wow-api-mcp.git
cd wow-api-mcp
npm install
node src/index.mjs

License

MIT