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.

In plain words
What is it for?
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.
Why use it?
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.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/nighthawk42/wow_api_mcp/agents-md
Clone the repo
git clone --depth 1 https://github.com/Nighthawk42/wow_api_mcp

Made for: Codex, OpenCode.

Per session 492 This file is loaded in full into every session.
When invoked 492 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00492 $0.00492
Opus 5 $0.00246 $0.00246
Sonnet 5 $0.00098 $0.00098
Haiku 4.5 $0.00049 $0.00049

Measured 2d ago against content hash 3666e8e6ef4d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 2d 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 · 41 lines

What it actually says

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 four game flavors (live, classic, classic_era, classic_anniversary). Data comes from three places:

  1. Parsed Blizzard docsdata/<flavor>.json, generated by npm run ingest from Blizzard_APIDocumentationGenerated Lua files in Gethe/wow-ui-source. Never hand-edit data/*.json.
  2. Warcraft Wiki — fetched live via the MediaWiki API, cached on disk (~24h).
  3. UI source code — shallow clones per flavor in the OS cache dir, searched with git grep.

Commands

npm run build     # tsc → dist/
npm run dev       # run server from source (tsx)
npm test          # vitest
npm run ingest    # regenerate data/<flavor>.json (clones 4 sparse branches)
npm run smoke     # end-to-end: calls every tool via in-memory client

Layout

  • src/index.ts — server entry (McpServer + StdioServerTransport)
  • src/tools/ — one file per tool group: api.ts, wiki.ts, source.ts
  • src/lua/parse-docs.ts — luaparse AST → JSON (never executes Lua)
  • src/data/loader.ts — loads data/*.json, builds MiniSearch index at startup
  • src/wiki/client.ts — MediaWiki client + turndown + disk cache
  • src/source/repo-cache.ts — shallow-clone manager + git grep
  • scripts/ingest.ts, scripts/smoke.ts
  • tests/ — vitest; parser fixtures live in tests/fixtures/

Conventions

  • ESM (type: module), Node 20+, strict TypeScript.
  • Tool inputs validated with zod; tool names are snake_case.
  • All tool responses are plain text/markdown (broadest client support).
  • Flavor IDs are exactly the upstream branch names — never invent aliases.
  • Keep stdout clean in server code: stdio transport owns it; log to stderr.
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.

  1. 2d 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 2d ago), licensed MIT. It adds 492 tokens to every session, about $0.0025 per session on Opus 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.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens