Free & Open Source · BSD 2-Clause

Connect AI to Old School RuneScape

A two-part system that gives AI assistants like Claude access to your OSRS data. 13 tools covering wiki, prices, and deep personal account data — fully local, zero cloud costs, privacy-first.

Get Started View on GitHub

Claude Desktop / Claude Code

You: What quests do I still need for Recipe for Disaster?

Claude: Let me check your quest log and the wiki requirements...

■ Calling get_my_quests · search("Recipe for Disaster")

Claude: You've completed 6 of the 10 sub-quests. You still need:
  • Freeing Sir Amik Varze (requires 107 QP)
  • Freeing King Awowogei (requires Monkey Madness)
  • Freeing the Lumbridge Guide
  • Defeating the Culinaromancer (final boss)

Why OSRS MCP Companion?

Everything runs on your machine. No accounts, no API keys, no subscriptions.

100% Local & Private

All player data stays on your machine as local JSON files. The RuneLite plugin makes zero network requests. Nothing is sent to any server or third party.

Zero Cost

No cloud services, no API keys, no subscriptions. One npm command and one RuneLite plugin — that's it. Free and open source under BSD 2-Clause.

13 Powerful Tools

Wiki search, GE price lookups, and 9 deep player data tools covering bank, stats, quests, equipment, inventory, diaries, and combat achievements.

Easy Setup

Add one config block to Claude Desktop or Claude Code. The MCP server auto-installs from npm. Install the RuneLite plugin and you're done.

Open Standard

Built on MCP (Model Context Protocol), an open standard by Anthropic for connecting AI to tools. Works with Claude Desktop and Claude Code out of the box.

Multi-Character

Each character gets its own JSON file. Switch between accounts seamlessly — your AI assistant can query any synced character's data.

13 Tools at Your AI's Fingertips

From wiki lookups to deep account data, everything your AI needs to help you play.

No plugin needed

Wiki & Price Tools

Work standalone — search the wiki, get page summaries, and check Grand Exchange prices.

Tool	Description
`search`	Search the OSRS Wiki for articles matching a query
`summary`	Get the introductory summary of any OSRS Wiki page
`price`	Look up current Grand Exchange buy/sell prices for any item
`player`	Fetch player data via the WikiSync RuneLite plugin

Requires RuneLite plugin

Player Sync Tools

Deep access to your character data — bank, stats, quests, gear, and more.

Tool	Description
`list_synced_players`	List all players who have synced data on this machine
`get_my_profile`	Full player summary — stats, quest count, bank size, diary progress
`get_my_bank`	Search/browse bank contents, filter by tab or item name
`get_my_stats`	Skill levels and XP, optionally filter to a specific skill
`get_my_quests`	Quest completion status, filter by state or search by name
`get_my_equipment`	Currently equipped items
`get_my_inventory`	Current inventory contents
`get_my_diaries`	Achievement diary completion by region
`get_my_combat_achievements`	Combat achievement tier/task completion

How It Works

Two parts working together — the plugin writes, the MCP server reads.

RuneLite Plugin

Saves your player data (stats, bank, quests, gear, diaries) as local JSON files to ~/.runelite/mcp-sync/

Local JSON Files

One file per character, updated on changes and periodically. Contains all your synced data categories.

MCP Server

Reads the JSON files and exposes 13 tools to your AI assistant via the Model Context Protocol.

AI Assistant

Claude can now query your bank, stats, quests — plus search the wiki and look up GE prices.

What Gets Synced

Skill Levels & XP On login + stat changes

Bank Contents When you open your bank

Inventory On item changes

Equipment On equipment changes

Quest Status Polled every ~18 seconds

Achievement Diaries Polled every ~18 seconds

Combat Achievements Polled every ~18 seconds

Get Started in Minutes

Two quick steps and you're ready to go.

Step 1

Install the RuneLite Plugin

Search for "MCP Sync" in the RuneLite Plugin Hub and install it. Log into RuneScape and your data will start syncing automatically.

Plugin Configuration

Save interval: default 60s (minimum 30s)
Individual toggles for each data category
All data saved locally to ~/.runelite/mcp-sync/

View Plugin on GitHub

Step 2

Add the MCP Server

Add this to your Claude Desktop or Claude Code MCP settings:

MCP Configuration

{
  "mcpServers": {
    "osrs-companion": {
      "command": "npx",
      "args": ["-y", "osrs-companion"]
    }
  }
}

That's it — one command, auto-installs from npm. No API keys needed.

View on npm

What Can You Ask?

A few examples of what's possible when your AI has full access to your OSRS data.

⚔

“What quests do I still need to complete for Recipe for Disaster?”

💰

“Based on my bank, what's my total wealth at current GE prices?”

⚙

“What's the best gear upgrade I can afford right now?”

⛏

“How much XP do I need for 99 Mining and what's the fastest method?”

📈

“Look up the current price of Dragon bones on the GE.”

📖

“What are the requirements for Desert Treasure 2?”