What is wow_api_mcp AGENTS.md?

Repository instructions for a TypeScript MCP server that exposes World of Warcraft addon information. They describe its data sources, project layout, commands, and development conventions.

Use them when developing, testing, ingesting data for, or running the WoW API server. They cover commands such as build, test, ingest, and smoke testing.

They give coding agents the context needed to change the repository safely and consistently. They also explain which generated files should not be edited by hand.

How Nighthawk42/wow_api_mcp configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to Nighthawk42/wow_api_mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/Nighthawk42/wow_api_mcp/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/Nighthawk42/wow_api_mcp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/nighthawk42/wow_api_mcp/agents-md/github.svg)](https://agentmods.dev/instructions/nighthawk42/wow_api_mcp/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/nighthawk42/wow_api_mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/nighthawk42/wow_api_mcp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/nighthawk42/wow_api_mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/nighthawk42/wow_api_mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,903 This file is loaded in full into every session.

When invoked 1,903 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01903	$0.01903
Opus 5.5	$0.00761	$0.00761
Sonnet 5.5	$0.00381	$0.00381
Haiku 4.5	$0.00190	$0.00190

Measured 16d ago against content hash 7f821312bcaf, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

wow_api_mcp AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 16d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 78 lines

How it starts

The opening of the file, as written. The whole thing — 78 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Guidance for AI agents working in this repository.

What this is

A TypeScript MCP server (stdio transport) exposing the WoW addon API across every Gethe/wow-ui-source track. Data comes from four places:

Parsed Blizzard docs — data/<flavor>.json.gz, generated by npm run ingest from Blizzard_APIDocumentationGenerated Lua files in Gethe/wow-ui-source. Never hand-edit anything in data/.
Warcraft Wiki — fetched live via the MediaWiki API, cached on disk (~24h).
UI source code — shallow clones per flavor in the OS cache dir, searched with git grep.
The local game install — .build.info, .flavor.info, client executable version resources, and addon .toc files, used to decide which flavor a question is about.

Commands

npm run build        # tsc → dist/
npm run dev          # run server from source (tsx)
npm test             # vitest (offline)
npm run typecheck    # tsc --noEmit
npm run verify-data  # assert data/ manifest, name index and payloads agree
npm run ingest       # regenerate data/ (discovers upstream branches itself)
npm run smoke        # end-to-end: calls every tool via in-memory client (needs network)

npm run ingest -- --list     # show which tracks exist upstream
npm run ingest -- live ptr   # refresh a subset
npm run ingest -- --prune    # drop data for branches that vanished upstream

On Windows, npm run update (update.ps1) pulls, rebuilds, and checks that the built server answers an MCP initialize. It never edits agent config files: if mcpm is on PATH it runs mcpm sync, otherwise it prints the entry to add.

Maintenance

Data refresh. .github/workflows/refresh-data.yml runs daily at 06:17 UTC, regenerates every track, builds, tests, and commits straight to main. The commit message lists which tracks moved and to which build; an unchanged upstream produces no commit. It needs push access to main for GITHUB_TOKEN (the workflow requests contents: write; if main is ever protected, let github-actions[bot] bypass). workflow_dispatch takes an optional track list and a prune toggle.

Read the full file on GitHub · 78 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

16d ago Changed · +49 tokens per session 7f821312bcaf
1mo ago Changed · +17 lines · +564 tokens per session 77ad12272840
1mo ago Changed · +20 lines · +798 tokens per session 43bfe5d0a28c
2mo ago First seen · 41 lines · 492 tokens per session scan A 3666e8e6ef4d

Subscribe to this mod's changes

wow_api_mcp AGENTS.md is an instructions file published in the GitHub repository Nighthawk42/wow_api_mcp (0 stars, last pushed yesterday), licensed MIT. It adds 1,903 tokens to every session, about $0.0076 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

wow_api_mcp AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
wow_api_mcp AGENTS.mdNighthawk42/wow_api_mcp	Instructions file	0	yesterday	MIT	A	1,903	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

wow_api_mcp: Instructions file for Codex