Hated WoW MCP
The Hated WoW MCP server equips AI assistants with real-time knowledge of the WoW in-game Lua API, Blizzard's UI source, and game art/file data for accurate addon development. It provides:
API Reference: Search functions, events, enums, structures, and their signatures; compare availability across retail/classic clients; view data sync stats.
Blizzard UI Source: Search XML templates and Lua mixins, grep the full UI source, read individual files, and browse UI packages.
Addon Authoring & Validation: Lint Lua for client-specific issues (deprecated APIs, taint, performance); validate XML and TOC files; generate addon skeletons with various config options; inspect local WoW installations and addons.
Game Data & Art: Look up file paths/FileDataIDs, icons, and texture atlas elements for use in textures and models; check data set sync status.
Accessibility: Works with multiple WoW clients, integrates with MCP-compatible AI assistants, and offers a local web UI for direct browsing.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Hated WoW MCPWhat does C_Item.GetItemInfo return?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Hated WoW MCP
An MCP server for writing World of Warcraft addons. Free and open source.
It gives your AI assistant three things it otherwise guesses at: the in-game Lua API for the client you are targeting, Blizzard's own shipped UI source so it can see how the game itself does something, and the game's art and file data so texture references are real rather than invented.
20 tools. Works with Claude Desktop, Claude Code, Cursor, Cline, and anything else that speaks MCP — or browse them in a local web UI with no AI at all.
☕ Support this project
Hated WoW MCP is free and always will be. If it saves you time, you can buy me a coffee — it genuinely helps keep it maintained through patch cycles.
buymeacoffee.com/rdygaming
Everything here is about code that runs inside the client. There is no Battle.net web API in this server — no armory lookups, no auction house.
Quick start
Requires Node 20+. Nothing to clone, nothing to build.
Claude Code
claude mcp add wow -- npx -y hated-wow-mcpAdd -s user to make it available in every project instead of just the current
one. Verify with claude mcp list.
Claude Desktop
Edit your config file:
OS | Path |
Windows |
|
macOS |
|
Windows Store install? If that path doesn't exist, look under
%LOCALAPPDATA%\Packages\Claude_*\LocalCache\Roaming\Claude\instead.
Add the mcpServers block. If the file already has other keys, keep them —
merge this in rather than replacing the file:
{
"mcpServers": {
"wow": {
"command": "npx",
"args": ["-y", "hated-wow-mcp"],
"env": {
"WOW_DEFAULT_FLAVOR": "mainline"
}
}
}
}Then fully quit Claude Desktop from the system tray and reopen it — closing the window is not enough, and the config is only read at startup.
Cursor / Cline / Windsurf / other MCP clients
Same JSON block as above. Cursor reads .cursor/mcp.json in your project, or
~/.cursor/mcp.json globally. See mcp-config.example.json in this repo.
Then sync the game data
The Lua API indexes ship inside the package, so API search, type and event lookup, linting, TOC/XML validation and scaffolding work the moment you add it — no sync, no waiting.
The UI source corpus and the art/FileDataID lookups are too large to ship, so those nine tools — including the CVar lookup — need a one-time sync. It needs git on your PATH:
npx -y hated-wow-mcp sync allBefore you sync: open https://wago.tools/ once in your browser and let the page fully load. wago.tools sits behind bot protection, and visiting it first from the same connection lets the atlas download through. Skip this and the atlas step may fail with HTTP 403.
That fetches a ~44 MB shallow clone of Blizzard's UI source and a ~149 MB listfile — a few minutes on first run. Re-running later is cheap: an unchanged listfile is revalidated rather than re-downloaded, so a no-op sync takes about two seconds.
Verify it worked
Ask your assistant: "Using the WoW MCP, what does C_Item.GetItemInfo return?" You should get a full 18-value signature. Or run the server directly:
npx hated-wow-mcp --listThat should print all 20 tools.
Where the data lives
Synced data never goes inside the package — that is what makes npx work. It
lands in your OS cache directory:
Platform | Location |
Windows |
|
macOS |
|
Linux |
|
Set WOW_MCP_DATA_DIR to override — useful for putting ~70 MB on another
drive, or sharing one sync between several installs. wow_data_status always
reports where it resolved to and why.
Related MCP server: wow-api-mcp
Running from a clone
You only need this to modify the server, or to use the local web UI, which is not part of the published package. Requires Node 20+ and git.
git clone https://github.com/RdyGaming/hated-wow-mcp.git
cd hated-wow-mcp
npm install
npm run build
npm run sync-all
npm testnpm test should report 65 passed, 0 failed. On Windows, setup.cmd does
all five steps and prints the absolute path you need below.
A clone keeps its synced data in data/ beside the source rather than in the OS
cache, so working on the server never disturbs an npx install you already have.
Point your client at the built entry point instead of npx:
{
"mcpServers": {
"wow": {
"command": "node",
"args": ["C:\\absolute\\path\\to\\hated-wow-mcp\\dist\\index.js"]
}
}
}On Windows, backslashes must be doubled in JSON. On macOS/Linux use a normal
path like /Users/you/hated-wow-mcp/dist/index.js.
See CONTRIBUTING.md before opening a PR.
Browse it without an AI client
Every tool also runs in a local web UI — no assistant, no API key, no tokens. Useful for looking something up quickly, or for checking what a tool returns before you wire it into a prompt.
This one needs a clone; it is not part of the npm package.
npm run webThen open http://localhost:3001.
Pick a tool from the sidebar and it builds the form for you: the fields, their types, and the help text all come from the tool's own schema, so the UI always matches what the tool actually accepts. Results render in a Monaco editor with a copy button.
This talks to the tools directly — it does not speak the MCP protocol, so nothing here interferes with the server your assistant is using. Both can run at the same time.
Two things worth knowing:
Run
npm run sync-allfirst. The UI is only as complete as your synced data; without it the UI source and game data tools return nothing.Art tools show paths, not pictures.
wow_icon_searchand friends return FileDataIDs and texture paths — there is no BLP decoding (see Known limits). Paste a FileDataID into wago.tools to see the actual image.
Set PORT if 3001 is taken:
PORT=4000 npm run webThe UI's dependencies (express, cors) are dev dependencies — a normal
npm install picks them up, and the MCP server itself never imports them.
Configuration
All settings are optional — see .env.example.
Variable | Purpose |
| Client to answer for when a tool call doesn't name one: |
| Your WoW folder. Auto-detected if unset. |
| AddOns folder the file tools read and write. Confines them to that directory. |
What it knows
Data set | Contents | Source |
Lua API index | 6,335 functions, 1,783 events, 1,676 enums/structures, 6,704 globals (retail; Classic and Classic Era indexed separately) | Blizzard's own generated |
UI source | 4,036 files across 348 | Same mirror |
CVars | 1,635 console variables with defaults, categories, scope and Blizzard's own descriptions; 451 also carry usage evidence from the UI source | Ketho/BlizzardInterfaceResources + UI source |
UI schema | Blizzard's | Same mirror |
File index | 172,175 interface files including 36,624 icons, mapped to FileDataIDs | |
Atlas index | 17,465 named | wago.tools DB2 exports |
All of it is synced from public mirrors by the scripts in src/sync/, so it
tracks patches without anyone hand-maintaining a list.
Tools
API reference
Tool | Purpose |
| Find a function with its full argument and return signature |
| Find an event and its payload arguments, in order |
| Find an |
| Compare availability across retail / Classic / Classic Era |
| Show which indexes are loaded and when they were synced |
Blizzard's UI source
Tool | Purpose |
| Find an inheritable XML template, with its inheritance chain |
| Find a mixin by name or by one of its methods |
| Find a CVar: default, category, scope, whether it is protected, and how Blizzard uses it |
| Regex-search all 4,036 shipped Lua/XML files |
| Read a shipped source file in context |
| List the |
Authoring
Tool | Purpose |
| Removed/moved APIs, unknown events, taint, performance traps |
| Validate interface XML against Blizzard's |
| Validate a |
| Generate a working addon skeleton |
| Report local installs and installed addons |
Game data and art
Tool | Purpose |
| Path ↔ FileDataID, both directions |
| Find an icon and get both usable reference forms |
| Find a |
| Show which game data sets are synced |
Why the linter is worth running
It is built on the per-flavor index rather than a hand-written deprecation list, so it knows things that are true for the client you are targeting:
$ wow_lua_lint --flavor mainline
local n = GetContainerNumSlots(0)
1:9 warning api/moved-to-namespace
"GetContainerNumSlots" has moved into a namespace in Retail (Midnight)…
-> C_Container.GetContainerNumSlotsThe same code is clean on Classic, because there the global still exists. That distinction is derived from Blizzard's data, not asserted by hand.
It also catches the taint mistakes that produce "Interface action failed because of an AddOn" — calling protected functions, reassigning Blizzard globals, touching secure frames during combat lockdown.
Measured false-positive rate, checked by running both validators across Blizzard's own shipped code:
XML validator: 0 of 1,091 files report an error.
Lua linter: 48 of 2,551 files (1.9%), and those are almost entirely correct — they are Blizzard's own
Blizzard_Deprecated*shims, which exist precisely to redefine removed APIs.
Keeping it current
Re-run after a patch. wow_api_stats and wow_data_status show what you have
and when it was synced.
Command | Fetches | Notes |
| Lua API index for all three clients | ~1,700 small HTTPS requests |
| Blizzard UI source (shallow git clone, ~44 MB) | Re-run fast-forwards |
| Listfile + atlas tables | Add |
| All three |
Those are the commands for a clone. An installed copy has no package scripts, so
it uses the sync subcommand instead:
npx -y hated-wow-mcp sync all
npx -y hated-wow-mcp sync game-data -- --fullsync-api is checkout-only — it regenerates data that ships inside the package,
so an installed copy gets a newer API index by upgrading rather than syncing.
The data comes from public upstream mirrors, so re-syncing picks up patch changes without waiting on a release here. Note that those mirrors typically lag a live patch by hours to days.
Re-syncing is cheap when nothing changed. The 149 MB listfile is revalidated
with its ETag, so an unchanged one costs a single round trip rather than a
fresh download, and the index is left alone rather than rebuilt — a no-op
sync-game-data finishes in about two seconds. Pass --force to ignore the
cache and rebuild regardless.
The server tells you when it has gone stale. Once a synced index is more
than 30 days old, answers drawn from it carry a one-line warning, and
wow_data_status reports the age of each set. Stale data is the failure mode
worth catching: a confident answer about a function or texture that a patch has
since removed is worse than no answer at all.
wago.tools access
Open https://wago.tools/ in a browser and let it load before running
sync-game-data or sync-all. The site is behind bot protection, and a
browser visit from the same connection clears the way for the atlas download
that follows. Doing this first avoids most atlas failures.
If the atlas step still reports HTTP 403, wago.tools is refusing the connection outright — it blocks many datacentre, cloud and VPN IP ranges. Run it from a normal desktop connection, with any VPN off.
This never blocks the rest of the sync. The file index in the same script comes
from GitHub and works regardless, and only wow_atlas_search depends on the
atlas step — the other 19 tools are unaffected.
Layout
src/
config.ts flavors, interface versions, install detection
wowapi/ API index loading, search, rendering
uisource/ Blizzard UI source index, template/mixin/grep search
gamedata/ listfile and atlas lookup
lua/ tokenizer, analyzer, rule tables
xml/ UI.xsd parser, XML validator
toc/ .toc parser and validator
scaffold/ addon generator
tools/ MCP tool definitions
sync/ the three sync scripts, plus their shared entry point
paths.ts bundled vs. synced data locations
server.js local web UI backend (npm run web)
index.html local web UI frontend
test/smoke.mjs 65 end-to-end checks against real data
data/ bundled API indexes, plus synced ones in a cloneKnown limits
Widget method inheritance is not modelled.
Frame:SetPointis found, but the server does not know thatButtoninherits it fromFrame. Searching the bare method name works.Classic progression flavors share one index. Blizzard publishes generated docs for three running clients; Cata/Wrath/TBC map onto the Classic index, so answers for those are approximate.
No BLP decoding. Art tools return paths, FileDataIDs and atlas coordinates — not rendered images. Extracting actual textures needs a CASC tool such as wow.export against your own installation.
The linter's scope model is approximate. It is a lexer with a scope stack, not a full Lua parser. It errs toward silence on ambiguous code.
Troubleshooting
Server doesn't appear in Claude Desktop. Fully quit from the system tray, not just the window. Check the JSON is valid and backslashes are doubled.
"Cannot find module ... dist/index.js". Only applies when running from a
clone: you skipped npm run build, or the path in your config is wrong. It must
be absolute. On npx, use "command": "npx", "args": ["-y", "hated-wow-mcp"] and
there is no path to get wrong.
UI source, art or icon lookups return nothing. Those need the one-time sync.
Run npx -y hated-wow-mcp sync all (or npm run sync-all from a clone), then check
wow_data_status — it reports where it looked and when that data was built.
The sync fails. You need git on your PATH for the UI source step. For an
HTTP 403 on the atlas step, see the wago.tools note in
Quick start.
Data seems stale after an update. npx caches the package. Force the newest
release with npx -y hated-wow-mcp@latest, or clear it with npm cache clean --force. wow_api_stats shows which index is actually loaded.
"Filename too long" / "Clone succeeded, but checkout failed" (Windows). Some
Blizzard filenames are 108 characters on their own, so a deep clone path can
exceed Windows' 260-character limit. The sync scripts pass core.longpaths=true
to git to handle this. If you still hit it, clone somewhere shorter — keep the
path under about 150 characters (C:\dev\hated-wow-mcp is plenty of room) — or
enable long paths system-wide in Windows.
Contributing
Issues and pull requests welcome at github.com/RdyGaming/hated-wow-mcp.
CONTRIBUTING.md covers the dev setup, how the two data sets differ, and what to know before adding a tool. Participation is governed by the Code of Conduct.
The most valuable report is a lookup that returns something wrong rather than nothing — there is an issue template for it that asks how you verified the real behaviour, so the fix can be checked against the game.
Found a security problem? Please report it privately — see SECURITY.md.
License
MIT — see LICENSE.
Not affiliated with or endorsed by Blizzard Entertainment. World of Warcraft is a trademark of Blizzard Entertainment, Inc. All game data is fetched at runtime from public community mirrors and is not redistributed by this project.
Available Tools
19 toolswow_addon_scaffoldGenerate an addon skeletonA
Generate a complete, working addon skeleton: .toc manifests for the chosen clients, an event-dispatch Core.lua with SavedVariables handling and a slash command, and optionally an XML frame template with its Lua mixin and a Settings-API options panel. Use this to start a new addon rather than writing boilerplate by hand.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Addon name; also the folder name. | |
| notes | No | One-line description for the .toc and README. | |
| write | No | Write the files into the configured addon folder instead of just returning them. | |
| author | No | ||
| flavors | No | Clients to support. Defaults to retail only. | |
| version | No | ||
| withFrame | No | Include an XML template and frame mixin. | |
| withOptions | No | Include a Settings API options panel. | |
| slashCommand | No | Slash command without the leading slash. | |
| savedVariables | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden, and it discloses the generated artifacts (event-dispatch Core.lua, SavedVariables handling, slash command, optional XML/mixin and Settings-API panel) and frames the tool as a skeleton generator. It doesn't explicitly state write-side-effect behavior, but the schema's 'write' parameter handles that, so the description adds substantial context beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences: the first is a compact, front-loaded enumeration of what is generated, and the second is a crisp usage directive. No filler or redundancy; every phrase conveys necessary information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description provides a strong overview of the generated skeleton's structure and components, which is the core context. However, it omits the return format when 'write' is false and doesn't mention prerequisites like folder configuration; with no output schema, these details would be useful. Slight deduction for that gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 70%, setting a baseline of 3. The description adds meaning to multiple parameters: 'chosen clients' links to flavors, 'SavedVariables handling' to savedVariables, 'slash command' to slashCommand, 'XML frame template with its Lua mixin' to withFrame, and 'Settings-API options panel' to withOptions. This enriches the brief schema descriptions beyond their literal definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose with a specific verb ('Generate') and resource ('addon skeleton'), listing all included components (.toc manifests, Core.lua, SavedVariables handling, slash command, optional XML/mixin and Settings-API panel). This distinguishes it unambiguously from sibling tools that focus on API search, file reading, or validation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says 'Use this to start a new addon rather than writing boilerplate by hand,' giving clear when-to-use guidance. It doesn't enumerate alternatives or when-not-to-use, but no sibling tool serves as a direct alternative for scaffolding, so exclusions are implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_api_diffCompare API availability across clientsA
Check whether a function, event or type exists in each game client (retail, Classic progression, Classic Era). Use this before writing code that has to run on more than one flavor, or to explain why something works on Classic but not retail.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Function, event or type name, e.g. GetSpellInfo or C_Item.GetItemInfo. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of behavioral disclosure. It clearly states the tool checks existence, implying a read-only query, but it does not detail the return format (e.g., a per-client boolean table) or any error behavior. The description is not misleading but lacks depth beyond the basic operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the purpose, then gives a concrete usage scenario. Every sentence earns its place, and there is no wasted text or redundancy with the schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a simple single-parameter lookup tool with no output schema. The description covers what it checks, which clients, and when to use it. It omits details about the output structure, but for a 1-param diff tool of this simplicity, the description is sufficiently complete for an agent to select and invoke it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with the parameter description already explaining 'Function, event or type name, e.g. GetSpellInfo or C_Item.GetItemInfo.' The tool description repeats 'function, event or type' but adds no new meaning about the parameter beyond what the schema provides, so the baseline score of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb phrase 'Check whether a function, event or type exists in each game client' and clearly names the resource (function/event/type) and scope (retail, Classic progression, Classic Era). This distinguishes it from sibling search tools like wow_api_search, which find definitions rather than compare availability across clients.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance: 'Use this before writing code that has to run on more than one flavor, or to explain why something works on Classic but not retail.' This provides clear context, though it does not explicitly name alternative tools for when not to use it (e.g., 'use wow_api_search to find where something is defined').
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_api_event_searchSearch in-game eventsA
Search the events an addon can register with frame:RegisterEvent, and show each event's payload arguments in order. Use this whenever writing an OnEvent handler, so the argument list matches what the client sends.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | Event name or fragment, e.g. COMBAT_LOG or BAG_UPDATE. | |
| flavor | No | Game client to answer for. Defaults to WOW_DEFAULT_FLAVOR, or retail. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It uses non-mutating verbs like 'search' and 'show', implying a read-only operation. However, it does not disclose any potential limitations, pagination, or how results are ordered beyond 'in order'. It adds some context about payload arguments but is not rich in behavioral details.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no fluff. It front-loads the core purpose and immediately follows with a practical use case. Every word earns its place, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a search tool with no output schema, the description adequately explains what the tool does and shows a key output detail: 'payload arguments in order'. It does not describe the full return format or how 'limit' and 'flavor' affect results, but given the tool's simplicity and schema coverage, it is reasonably complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers 67% of parameters with descriptions for 'query' and 'flavor'. The description reinforces that the query is an 'event name or fragment' but does not add details for the 'limit' parameter, which lacks a description. Overall, it adds little beyond the schema, but does not conflict with it, earning a baseline score.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action: 'Search the events an addon can register with frame:RegisterEvent' and adds the distinct feature of 'show each event's payload arguments in order'. This distinguishes it from sibling tools like wow_api_search or wow_api_type_search by focusing specifically on events and their payloads.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a clear usage context: 'Use this whenever writing an OnEvent handler, so the argument list matches what the client sends.' This tells the agent when to use it, though it does not explicitly mention alternatives or when not to use it. It provides a clear 'when' but lacks 'when-not'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_api_searchSearch the in-game Lua APIA
Search World of Warcraft's in-game Lua API — the functions an addon can call from inside the client. Covers namespaced functions (C_Item.GetItemInfo), legacy globals (UnitHealth), and widget methods (Frame:SetPoint). Results include full argument and return signatures. Use this before writing any addon code that calls the game.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | Function name or fragment. Matches exact names, prefixes, substrings and camel-hump abbreviations (GIIBID finds GetItemInfoByID). | |
| flavor | No | Game client to answer for. Defaults to WOW_DEFAULT_FLAVOR, or retail. | |
| namespace | No | Restrict to one namespace, e.g. C_Spell. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It discloses valuable behavioral information: the search covers specific API categories and results include full argument and return signatures. It does not mention whether the search is read-only or any limitations, but for a search tool this is reasonably transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and well-structured: a clear opening sentence, an illustrative second sentence with concrete examples, and a practical usage directive. No redundant information; every sentence contributes meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity, no output schema, and rich sibling set, the description covers the tool's scope, result contents, and usage. It could go further by explicitly stating that events/types are handled by sibling tools, but the enumeration of function categories already implies this distinction.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already describes query, flavor, and namespace well. The description adds useful context about API families, but it does not elaborate on the limit parameter, which remains undocumented. With 75% schema coverage, the description provides some extra meaning but does not fully close the gap for the undocumented parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'Search World of Warcraft's in-game Lua API'. It further distinguishes from siblings by enumerating the covered API types (namespaced functions, legacy globals, widget methods) and by noting that it returns argument and return signatures. This clearly identifies it as the function search tool versus event/type search siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides clear usage context: 'Use this before writing any addon code that calls the game.' This tells the agent when to invoke the tool. However, it does not explicitly mention exclusions or point to alternatives like wow_api_event_search or wow_api_type_search, so it falls short of full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_api_statsShow what API data is loadedA
Report which API index, UI source and game data sets this server has, when each was synced, and how large it is. Use this to confirm the data is present and current before relying on other tools.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It implies a read-only operation via 'Report' and 'confirm,' but does not explicitly state safety or side effects. It does add details about sync times and size, which is useful context beyond a simple 'report.'
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the key output aspects and a usage tip. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple with no params and no output schema. The description covers what the tool reports (API index, UI source, game data sets, sync times, size) and when to use it. This is complete for the tool's complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has no parameters, so the baseline is 4. The description explains what the tool reports, but since there are no params, there is no parameter syntax to clarify. It adds context but does not further explain parameter semantics beyond that.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reports which API index, UI source, and game data sets the server has, along with sync times and size. This is a specific verb+resource and distinguishes from siblings like wow_data_status by focusing on sync status and size.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The sentence 'Use this to confirm the data is present and current before relying on other tools' provides clear context for when to use it. There are no explicit alternatives or exclusions, but the context is sufficient for a 0-param status tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_api_type_searchSearch API enums, structures and constantsA
Search the Enum., Constants. and structure tables the in-game API uses — for example Enum.ItemQuality or the AuraData structure returned by C_UnitAuras. Searching for a member name finds the table that contains it.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Restrict to one kind of table. | |
| limit | No | ||
| query | Yes | Type, enum, constant or member name. | |
| flavor | No | Game client to answer for. Defaults to WOW_DEFAULT_FLAVOR, or retail. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full transparency burden. It discloses that the tool searches multiple table types and resolves member names to their containing table, which is useful. However, it omits behavioral details like default flavor, return shape, or pagination behavior, leaving gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler: the first states the tool's scope and gives a concrete example, the second clarifies member-name behavior. Every word earns its place; format is ideal for agent consumption.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and a straightforward search use case, the description adequately covers what is searched and how member-name search behaves. It doesn't describe return format, but for a search tool this is not a critical gap, especially with sibling context indicating a specialized type search.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 75%, with query, kind, and flavor already described. The description adds significant semantic value by explaining member-name resolution, which clarifies query behavior beyond the schema. The limit parameter still lacks narrative guidance, but the schema's min/max partially covers it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb + resource: 'Search the Enum.*, Constants.* and structure tables', clearly distinguishing it from sibling tools like wow_api_search and wow_api_event_search. The concrete example (Enum.ItemQuality, AuraData) further anchors the purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly explains a key usage pattern: 'Searching for a member name finds the table that contains it.' This gives actionable guidance beyond a generic 'search' instruction. It does not explicitly name alternatives or state when not to use it, but the sibling context makes the niche apparent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_atlas_searchFind a texture atlas elementA
Search the named texture atlas elements the UI uses with SetAtlas — the modern way to reference Blizzard art, since an atlas name carries its own size and coordinates. Returns dimensions, the sheet FileDataID and the exact SetAtlas call. Prefer atlases over raw texture paths for UI art.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | Atlas element name or fragment. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses important return values and explains the atlas concept, but it omits behavioral details such as how search matching works (substring vs exact), whether results are limited by the limit parameter, sorting, or error conditions. This is adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, with the main action front-loaded, followed by return values and a usage preference. Every sentence adds value; no redundant or filler content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a search tool with no output schema and no annotations, the description covers purpose, return values, and usage preference. It is missing explanation of the limit parameter and result limit behavior, but given the tool's simplicity, it is largely complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50% (query is described, limit is not). The description adds no parameter-level detail beyond implying the query is the atlas name fragment. It does not explain the limit parameter's function or default behavior, leaving a gap that the description doesn't compensate for.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches named texture atlas elements used with SetAtlas, distinguishing it from sibling search tools (e.g., wow_icon_search, wow_file_search). It also lists specific return values (dimensions, FileDataID, exact SetAtlas call), making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance to prefer atlases over raw texture paths for UI art, which is a clear usage directive. However, it doesn't name specific sibling tools as alternatives or state when NOT to use this tool, so it falls slightly short of full exclusionary guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_data_statusShow game data availabilityA
Report which game data sets are synced — the file/FileDataID index and the texture atlas index — with counts and sync dates, and what to run for any that are missing. Use this when a game data lookup returns nothing.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of disclosing behavior. It does so by explaining what the tool reports (counts and sync dates) and what to do for missing datasets. It does not mention side effects, auth, or rate limits, but as a read-only status reporter, the absence of such disclosures is not a significant gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no wasted words. It front-loads the primary action ('Report which game data sets are synced') and adds the needed usage context. Every phrase earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (no parameters, no output schema), the description is nearly complete: it identifies what data sets are covered, what metrics are provided (counts and dates), and how to react if data is missing. It could optionally mention the underlying data source, but this is not essential for an agent to select and invoke the tool effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, and the schema is empty. According to the rubric, the baseline for no parameters is 4. The description adds no parameter information because none is needed, making this score appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb 'Report' and clearly identifies the resource: which game data sets are synced (file/FileDataID index and texture atlas index). It distinguishes from siblings by focusing on sync status rather than searching or file operations, and the phrasing 'Use this when a game data lookup returns nothing' further differentiates it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use the tool: 'Use this when a game data lookup returns nothing.' However, it does not name alternative tools or explicitly state when not to use it, though the 'what to run for any that are missing' clause hints at next steps. This is clear but lacks full exclusionary guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_file_searchLook up game files and FileDataIDsA
Find game art and asset files by name, and get the FileDataID and texture path an addon needs to reference them. Covers every interface texture and icon (and models and maps when the full index is synced). A numeric query is treated as a FileDataID and resolved back to its path. Use this whenever writing SetTexture, SetNormalTexture or SetModel.
| Name | Required | Description | Default |
|---|---|---|---|
| ext | No | Restrict by extension, e.g. blp or m2. | |
| limit | No | ||
| query | Yes | File name fragment, or a numeric FileDataID to resolve. | |
| under | No | Restrict to a path prefix, e.g. interface/icons/ or interface/buttons/. | |
| includeNonInterface | No | Search beyond interface/** — models, maps, sounds. Requires the full index. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the burden. It adds useful behavior like numeric queries resolving to paths and the dependency on index syncing, but it does not explicitly state that the operation is read-only, nor does it disclose performance, error behavior, or output format.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, front-loaded with the core purpose, and every sentence adds distinct value (function, coverage, usage). No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
It covers core purpose, usage, and some behavioral nuances, but with 5 parameters and no output schema, it leaves gaps: no mention of what a response looks like, what happens on not found, or how to check index sync status (e.g., wow_data_status). It is adequate but not fully comprehensive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 80%, and the description adds meaningful semantics beyond the schema—explaining that numeric queries are treated as FileDataIDs and that model/map coverage depends on the full index. This enriches the meaning of query and includeNonInterface beyond the raw property definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool finds game art and asset files by name and returns FileDataID and texture path. It also explicitly ties usage to SetTexture, SetNormalTexture, or SetModel, distinguishing it from sibling search tools like wow_icon_search or wow_atlas_search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides a clear directive: 'Use this whenever writing SetTexture, SetNormalTexture or SetModel.' This gives explicit context for when to use, though it does not mention when not to use or point to alternatives, so it lacks full exclusionary guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_icon_searchFind an icon textureA
Search the game's icon textures by name and return the path and FileDataID for each. Icons follow a naming convention (spell_fire_*, inv_sword_*, ability_warrior_*), so searching by theme works well. Use this to pick an icon for a button, an addon compartment entry, or a .toc IconTexture.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | Icon name fragment, e.g. fireball, sword, warrior. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the transparency burden. It discloses that the tool returns path and FileDataID, and explains the naming convention, but it does not explicitly state read-only behavior, how the limit parameter works, or what happens when no icons match.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each earning its place: function and returns, naming convention, and use cases. No fluff or redundant content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple search tool, the description covers the return value and use cases. However, it omits details about the limit parameter and does not describe the response format or behavior for empty results, so it is not fully complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema documents 'query' with an example, and the description adds useful naming convention context. However, the 'limit' parameter is not explained in either place, leaving a key part of the parameter semantics uncovered. Coverage is approximately 50%.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches game icon textures by name and returns the path and FileDataID. However, it does not explicitly distinguish itself from sibling tools like wow_atlas_search, even though the focus on 'icon textures' is specific.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit use cases: picking icons for buttons, addon compartment entries, and .toc IconTexture. It does not mention exclusions or alternatives, but provides clear context for when to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_install_infoShow the local WoW installationA
Report the World of Warcraft installations found on this machine — their paths, flavors, build numbers, and the addons currently installed. Use this to confirm which client tools will target and to discover addon folders to lint.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the behavioral transparency burden. The word 'Report' implies a read-only operation, and it discloses what information is returned (paths, flavors, build numbers, addons). It doesn't explicitly state side-effect-free behavior, but given the simplicity of the tool, this is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with what the tool does and followed by practical usage. Every word earns its place; no fluff or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple, zero-parameter tool with no output schema, the description explains what is reported and why to use it. It lists the categories of information returned, making it sufficient for an agent to decide when to call. A bit more detail on the output structure could earn a 5, but this is not a significant gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the input schema provides no information to clarify. The description adds value by describing the kind of data returned (paths, flavors, build numbers, addons), which helps set expectations for the output. Baseline for 0 params is 4.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Report') and the resource ('World of Warcraft installations found on this machine'), with specific details (paths, flavors, build numbers, addons) that distinguish it from sibling tools which focus on APIs, UI files, linting, etc.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit use cases: 'confirm which client tools will target' and 'discover addon folders to lint.' While it provides clear context, it does not mention when not to use it or name alternative tools, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_lua_lintLint addon Lua against a game clientA
Analyse addon Lua for problems specific to World of Warcraft: APIs that were removed or moved into a namespace in the target client, unknown events, taint (calling protected functions, overwriting Blizzard globals, touching secure frames in combat), and performance traps. Run this on any addon Lua before shipping it, and whenever porting between clients.
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Lua source to analyse. | |
| path | No | Path to a .lua file to analyse instead of inline code. | |
| flavor | No | Target client. Defaults to retail. | |
| disable | No | Rule ids to suppress. | |
| knownGlobals | No | Globals defined elsewhere (embedded libraries, other files) — suppresses unknown-API warnings for them. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It details the categories of problems detected (removed/moved APIs, unknown events, taint, performance traps), offering substantive insight into behavior. It does not mention output format or side effects, but for a static analysis tool this is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose. Every sentence contributes value: the first defines the tool and its scope, the second specifies when to run it. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no output schema and no annotations, the description provides sufficient context: what it analyzes, what categories of issues it finds, and when to use it. It lacks explicit return-format details, but the description is otherwise complete and actionable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so each parameter is already documented. The description does not add additional parameter-level meaning, but that is acceptable given the high schema coverage. The baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Analyse') and identifies the resource ('addon Lua'), and clearly distinguishes this tool from sibling tools by focusing on WoW-specific linting (removed APIs, events, taint, performance traps). It fully explains what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use the tool ('Run this on any addon Lua before shipping it, and whenever porting between clients'). It does not name alternative tools or provide when-not-to-use exclusions, but the context is clear enough for an agent to decide.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_toc_validateValidate an addon .toc manifestA
Validate a .toc manifest: interface version against the target client, flavor suffix consistency, unrecognised directives the client silently drops, SavedVariables names, and files listed but missing (or present but unlisted). Run this whenever an addon fails to load or shows as out of date.
| Name | Required | Description | Default |
|---|---|---|---|
| toc | No | .toc contents to validate. | |
| path | No | Path to a .toc file, or to an addon folder. | |
| fileName | No | Filename to assume when validating inline contents, e.g. MyAddon_Vanilla.toc. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It discloses what is validated and mentions that some directives are 'silently dropped' by the client, implying the tool surfaces warnings. However, it does not describe the output format, whether it is read-only, or any side effects. For a validation tool, this is acceptable but not fully transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, front-loaded with the core action and scope, followed by practical usage guidance. Every word earns its place, with no redundant phrasing or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a validation tool with no output schema and no annotations, the description provides a solid scope of checks and a clear usage context. It misses only the return format or outcome expectations, but given the tool's nature, this is not a major gap. Overall, it is complete enough for an agent to select and invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already has 100% description coverage for all three parameters. The tool description adds overall context about validation scope but does not provide additional meaning beyond the schema for individual parameters. Baseline 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses the specific verb 'Validate' with the resource '.toc manifest', and enumerates distinct checks (interface version, flavor suffix, directives, SavedVariables, file lists). This clearly distinguishes it from sibling tools like wow_lua_lint and wow_xml_validate, which target other file types.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use the tool: 'Run this whenever an addon fails to load or shows as out of date.' This gives a clear trigger context. However, it does not mention when not to use it or alternatives, but that is less critical given the specialized purpose.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_ui_grepSearch Blizzard's UI source codeA
Regex-search the full Lua and XML source of the 348 Blizzard addons that ship with the client. This is the ground truth for how the game itself does something — event handling, secure frames, data providers, layout. Use it when the API reference tells you what a function is but not how it is meant to be used.
| Name | Required | Description | Default |
|---|---|---|---|
| ext | No | Restrict by file type. | |
| pkg | No | Restrict to one Blizzard package, e.g. Blizzard_ActionBar. | |
| limit | No | ||
| flavor | No | Game client. Defaults to retail. | |
| context | No | Lines of surrounding context per hit. | |
| pattern | Yes | JavaScript regular expression to search for. | |
| ignoreCase | No | ||
| pathContains | No | Restrict to paths containing this. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the full transparency burden. It conveys a read-only search over a large fixed corpus and adds 'ground truth' context, but it does not disclose output format, default flavor/limit behavior, or performance implications.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences: the first front-loads the action and scope, the second provides valuable usage context. No words are wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite 8 parameters and no output schema, the description clearly covers the tool's purpose, scope, and primary use case. It relies on the schema for filters and limits, though it does not describe the return structure or mention TOC files, leaving a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 75%, so the schema already documents most parameters. The description adds no parameter-specific meaning beyond reinforcing that this is a regex search, so the baseline score is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Regex-search the full Lua and XML source of the 348 Blizzard addons that ship with the client.' This clearly distinguishes it from sibling tools like wow_api_search or wow_ui_read_file by emphasizing full-source ground-truth searching.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'Use it when the API reference tells you what a function is but not how it is meant to be used' gives a clear trigger and context. However, it does not explicitly name alternative tools or provide when-not-to-use exclusions, so it falls short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_ui_list_packagesList Blizzard's shipped UI packagesA
List the Blizzard_* addon packages that ship with the client, optionally filtered. Use this to find which package owns a piece of the UI before grepping it, e.g. Blizzard_ActionBar for action buttons.
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Substring filter on the package name. | |
| flavor | No | Game client. Defaults to retail. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It conveys that the tool lists packages and supports optional filtering, and it frames this as a read-only, preparatory step. However, it does not explicitly disclose whether there are any side effects, permissions, or limitations (e.g., return format, ordering, or performance characteristics). This is sufficient for a simple list operation but leaves room for more transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loads the action, and each clause earns its place. It states the payload, the optional filter, the intended workflow, and a practical example without any filler or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simplicity of the tool, the rich parameter schema, and the presence of sibling tools like grep and file search, the description is adequately complete. It explains the tool's scope, ties it into a workflow, and gives an example. It does not describe return values, but the absence of an output schema makes that less critical. A 5 would require more explicit details about output or edge cases, so 4 is appropriate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value by providing a concrete example ('Blizzard_ActionBar for action buttons') that illustrates how the filter parameter maps to real UI packages, going beyond the schema's basic substring definition. This extra semantic guidance raises the score to 4.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('List') and names the exact resource ('Blizzard_* addon packages that ship with the client'), clearly distinguishing it from sibling tools like grep or file search. It also gives a concrete example ('Blizzard_ActionBar for action buttons'), which reinforces the tool's purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells when to use this tool ('Use this to find which package owns a piece of the UI before grepping it'), which clearly positions it relative to a sibling tool (grep). It provides a clear usage scenario but does not list explicit exclusions or when not to use it, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_ui_mixin_searchSearch Blizzard's Lua mixinsA
Search the mixin tables Blizzard's UI uses — reusable method sets attached to frames via the XML mixin attribute or CreateFromMixins. Searching a method name finds the mixin that defines it. Use this to reuse Blizzard's behaviour or to understand what a template's methods do.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | Mixin name, fragment, or an exact method name. | |
| flavor | No | Game client. Defaults to retail. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It explains what mixins are and that searching a method name yields the defining mixin, adding useful context. However, it doesn't disclose return format, pagination, or other side effects, leaving some behavioral aspects implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the main purpose, and contains no filler or redundant phrasing. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a focused search tool with 3 parameters and no output schema, the description covers core functionality, domain context, and use cases. It doesn't explicitly mention result format or parameter edge cases, but the provided information is sufficient for a straightforward read-only search.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 67% (query and flavor have descriptions, limit does not). The description adds a small behavioral nuance about query ('Searching a method name finds the mixin that defines it') but doesn't elaborate on limit or flavor beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific action ('Search') and a clear resource ('the mixin tables Blizzard's UI uses'), and further distinguishes itself from sibling tools by explicitly mentioning 'XML mixin attribute or CreateFromMixins' and 'method name finds the mixin that defines it'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit use cases: 'reuse Blizzard's behaviour' and 'understand what a template's methods do.' It doesn't name alternatives but clearly implies this tool is for mixin-specific searches, making it distinct from API or template searches.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_ui_read_fileRead a file from Blizzard's UI sourceA
Read a Lua or XML file from Blizzard's shipped interface source, by the path that wow_ui_grep or wow_ui_template_search reported. Use this to see a full implementation in context rather than a single matching line.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Path relative to the UI source root, e.g. Interface/AddOns/Blizzard_UIParent/UIParent.lua. | |
| flavor | No | Game client. Defaults to retail. | |
| endLine | No | ||
| startLine | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It discloses the core behavior (reading a file) and the purpose, but it does not mention return format, error handling, line range behavior, or any potential side effects. Since it's a read-only tool, the safety profile is implied but not explicitly stated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the primary purpose, and contains no unnecessary words. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 4 parameters and no output schema, the description is minimal. It gives good context for the purpose and usage, but it does not explain the startLine/endLine parameters or describe the return value. The schema provides partial coverage, but the description leaves important operational details ambiguous.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema descriptions cover 'path' and 'flavor', but 'startLine' and 'endLine' have no descriptions. The description adds context for 'path' by saying it should come from grep/template_search, but it does not explain the line range parameters at all. With 50% schema coverage, the description needed to compensate for the missing parameters but does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: reading a Lua or XML file from Blizzard's shipped UI source. It uses a specific verb ('Read') and resource ('file from Blizzard's shipped interface source'), and distinguishes itself from sibling tools by referencing paths from wow_ui_grep or wow_ui_template_search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to use this tool when you need the full implementation in context rather than a single matching line, and directs users to use paths reported by wow_ui_grep or wow_ui_template_search. This clearly defines when to use this tool versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_ui_template_searchSearch Blizzard's XML frame templatesA
Search the virtual XML templates that ship with the game — the frames an addon can inherit by name to get Blizzard's own look and behaviour (buttons, scroll lists, panels, tooltips). Shows the inheritance chain, attached mixins and where each is defined. Use this instead of writing frame art from scratch.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Restrict to an element type, e.g. Button, Frame, CheckButton. | |
| limit | No | ||
| query | Yes | Template name or fragment, e.g. ScrollBox or UIPanelButton. | |
| flavor | No | Game client. Defaults to retail. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses that results show inheritance chain, attached mixins, and definition locations, which is useful behavioral info. It does not explicitly state read-only behavior, rate limits, or other side effects, but for a search tool this is acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences, front-loaded with the core action. Each sentence adds value: what it searches, what it shows, and a usage tip. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (4 params, no output schema), the description covers the main purpose, key result content, and a practical use case. It does not detail return format or ordering, but the info provided is enough for an agent to select and invoke the tool correctly in most cases.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 75% (three of four parameters have descriptions), but none of the parameters are explained in the tool description itself. The 'limit' parameter has no description in either schema or description, so the description does not compensate for the gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches Blizzard's virtual XML templates and shows inheritance chain, mixins, and definitions. It distinguishes the tool from writing frame art from scratch, but does not explicitly differentiate it from sibling search tools like wow_ui_mixin_search, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a clear usage context: use this to inherit Blizzard's look and behavior instead of creating frame art from scratch. However, it does not mention when not to use it or compare it to alternative sibling tools, so it lacks explicit exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
wow_xml_validateValidate interface XMLA
Validate WoW interface XML against Blizzard's own UI.xsd: unknown or misspelled elements and attributes, invalid nesting, bad enum values, and structural mistakes like a virtual frame with no name. Run this on every XML file an addon loads — the client silently ignores what it does not understand, so these mistakes are otherwise invisible.
| Name | Required | Description | Default |
|---|---|---|---|
| xml | No | XML source to validate. | |
| path | No | Path to a .xml file to validate. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and discloses specific behaviors: it checks for unknown elements/attributes, nesting, enum values, and structural issues. It also highlights that errors are otherwise invisible, which is meaningful context beyond a generic 'validate' statement.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, both dense with useful information. No fluff or repetition; the first sentence explains scope, the second provides usage rationale.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers what, why, and when for this simple validation tool. Minor gaps: it doesn't describe the return format (no output schema) or clarify that at least one parameter must be supplied, but these are not critical for basic usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with both parameters described, so the baseline is 3. The description adds no extra meaning about the parameters, notably not clarifying the relationship between 'xml' and 'path' (e.g., whether they are alternatives or combined).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Validate WoW interface XML against Blizzard's own UI.xsd' and lists specific error types it catches, distinguishing it from sibling tools like wow_lua_lint and wow_toc_validate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly instructs 'Run this on every XML file an addon loads' and explains why (the client silently ignores mistakes), giving clear context for when to use the tool, though it doesn't name alternatives or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
19 tool updates
v0.1.0- First observed
wow_addon_scaffold - First observed
wow_api_diff - First observed
wow_api_event_search - First observed
wow_api_search - First observed
wow_api_stats - First observed
wow_api_type_search - First observed
wow_atlas_search - First observed
wow_data_status - First observed
wow_file_search - First observed
wow_icon_search - First observed
wow_install_info - First observed
wow_lua_lint - First observed
wow_toc_validate - First observed
wow_ui_grep - First observed
wow_ui_list_packages - First observed
wow_ui_mixin_search - First observed
wow_ui_read_file - First observed
wow_ui_template_search - First observed
wow_xml_validate
TDQS
Scored across 19 tools
Most tools have clear distinct purposes (API search vs events vs types, UI grep vs read file vs templates, lint vs validate). Minor overlap exists between wow_file_search and wow_icon_search (both find icons), and wow_api_stats and wow_data_status both report sync state, but descriptions clarify the differences.
All names use the wow_ prefix and snake_case, but there is a mix of verb-led names (wow_api_search, wow_ui_read_file, wow_addon_scaffold) and noun-led names (wow_install_info, wow_data_status, wow_api_stats). Overall the pattern is predictable and consistent enough to be intuitive.
At 19 tools, the count exceeds the typical 3-15 well-scoped range, but the scope is broad: API reference, UI source inspection, asset search, validation, and scaffolding for WoW addons. Each tool serves a distinct need, making the count reasonable for the domain.
The toolset covers the full addon development lifecycle: researching APIs and events, inspecting Blizzard UI source, searching assets, validating Lua/XML/TOC files, linting, and scaffolding new addons. There are no obvious gaps that would block an agent from completing common tasks.
Maintenance
Related MCP Connectors
An MCP server that gives your AI access to the source code and docs of all public github repos
Driflyte MCP server which lets AI assistants query topic-specific knowledge from web and GitHub.
MCP server for AI dialogue using various LLM models via AceDataCloud
Augments MCP Server - A comprehensive framework documentation provider for Claude Code
Related MCP Servers
- AlicenseNot gradedqualityCmaintenanceA local MCP server that lets any MCP-compatible AI client manage a standalone World of Warcraft private server, including server control, database operations, NPC/quest/loot management, and more.1MIT
- AlicenseNot gradedqualityCmaintenanceMCP server that exposes structured World of Warcraft API data (functions, deprecated replacements, enums, events, widget methods) to AI agents, enabling querying and exploration of WoW API without wiki parsing.12 npm13MIT
- FlicenseNot gradedqualityDmaintenanceMCP server that gives LLMs live access to warcraft.wiki.gg API documentation with behavioral notes, restrictions, and patch history for World of Warcraft APIs.1-
- AlicenseAqualityBmaintenanceAn MCP server that gives AI coding assistants access to the World of Warcraft addon API documentation, FrameXML/AddOn UI source code, and the Warcraft Wiki across all four client flavors.96 npmMIT