2009scape-wiki-api

Turns the raw 2009scape game sources (items, NPCs, shops, drop tables, quests, locations) into one immutable SQLite artifact, served two ways: a FastAPI contract for a wiki front end, and an MCP server for Claude and other agents.

flowchart LR
    SRC["game sources<br/>+ overlays"] --> PIPE["pipeline/artifact<br/>offline build"]
    PIPE --> ART[("knowledge.sqlite3<br/>one immutable build")]
    subgraph RUN ["one image, one process, one port"]
        REPO["repository<br/>SQLite + FTS5"] --> CORE["core<br/>resolve, walk, search"]
        CORE --> HTTP["surfaces/http<br/>FastAPI"]
        CORE --> MCP["surfaces/mcp<br/>FastMCP"]
        HTTP --> GUARD["guarding<br/>token, rate, bans"]
        MCP --> GUARD
    end
    ART --> REPO
    GUARD --> WIKI["wiki front end"]
    GUARD --> AGENT["Claude, editors,<br/>any MCP client"]
    DOM["domain<br/>entities, relationships<br/>attribute registry"] -.-> PIPE & REPO & CORE

A build holds ~20,000 entities, ~83,000 relationships and two years of weekly Grand Exchange prices. It ships on Hugging Face, never in this repository.

Installing

uv tool install scape2009-wiki-api                        # a Python environment
docker run -p 8000:8000 arsalananwari/2009scape-wiki-api  # a container

Debian, Fedora and Arch packages are on the releases page. Each way in is complete on its own: dataset, settings file, keys and the commands to manage them. See install.

Getting started

scape2009-wiki-data pull              # the published dataset, once
scape2009-wiki-keys init              # the key this deployment answers, once
scape2009-wiki-keys issue --label me  # one token, saved under tokens/me.json
scape2009-wiki-serve                  # HTTP on :8000, contract at /docs

TOKEN=$(jq -r .access_token ~/.config/scape2009-wiki-api/tokens/me.json)
curl -H "authorization: Bearer $TOKEN" \
  http://localhost:8000/v1/entities/item/dragon-scimitar

Documentation

The full documentation is at arsalan-anwari.github.io/2009scape-wiki-api.