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., "@osrs-companion search OSRS Wiki for dragon scimitar"
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.
An MCP server for Old School RuneScape that gives AI assistants access to wiki search, Grand Exchange prices, and your synced player data — all running locally on your machine.
Wiki Search — Search the OSRS Wiki for any article
Page Summaries — Get introductory summaries of wiki pages
GE Prices — Look up current Grand Exchange buy/sell prices
WikiSync Player Data — Fetch player data via the WikiSync plugin
Local Player Sync — Read detailed player data saved by the companion RuneLite plugin (bank, skills, quests, equipment, inventory, diaries, combat achievements)
Related MCP server: RuneScape Wiki MCP Server
For the local player sync tools, install the OSRS MCP Companion RuneLite plugin. Wiki search, summaries, and GE prices work without it.
Add to your MCP configuration:
{
"mcpServers": {
"osrs-companion": {
"command": "npx",
"args": ["-y", "osrs-companion"]
}
}
}npx -y osrs-companionTool | Description |
| Search the OSRS Wiki for articles |
| Get the intro summary of a wiki page |
| Look up Grand Exchange prices |
| Fetch player data via WikiSync |
Tool | Description |
| List players with synced data |
| Full player summary |
| Search bank contents |
| Skill levels and XP |
| Quest completion status |
| Currently equipped items |
| Current inventory |
| Achievement diary progress |
| Combat achievement status |
The MCP server runs locally via stdio transport. Wiki and price tools
fetch from public OSRS APIs. Player sync tools read JSON files from
~/.runelite/osrs-companion/ that are written by the companion RuneLite plugin.
No data is stored in the cloud. No API keys required.
Wiki content returned by the search and summary tools is sourced from the
Old School RuneScape Wiki, which is licensed
under CC BY-NC-SA 3.0.
All wiki tool responses include an attribution notice automatically.
Grand Exchange price data is provided by the OSRS Wiki Prices API. Player data is fetched via the WikiSync API or read from local files saved by the RuneLite plugin — neither contains wiki article content.
BSD 2-Clause "Simplified" License. See LICENSE.
Search and browse the player's synced bank contents. Supports filtering by item name, bank tab, and minimum quantity.
Inputs: username (required), tab, search, minQuantity.
Get the player's combat achievement completion status. Optionally search by task name.
Inputs: username (required), search.
Get the player's achievement diary completion status. Optionally filter by region.
Inputs: username (required), region.
Get the player's currently equipped items (last synced state).
Inputs: username (required).
Get the player's current inventory contents (last synced state).
Inputs: username (required).
Get a full summary of synced player data including stats, quest count, bank size, and diary progress. Data is synced from RuneLite via the MCP Sync plugin.
Inputs: username (required).
Get the player's synced quest completion status. Filter by state or search by name.
Inputs: username (required), state, search.
Get the player's synced skill levels and XP. Optionally filter to a specific skill.
Inputs: username (required), skill.
List all players that have synced data from RuneLite. Use this first to find available usernames.
Inputs: no named parameters.
Fetch RuneLite player data via the WikiSync plugin (requires RuneLite client)
Inputs: username (required), forceRefresh.
Look up the current Grand Exchange price for an item
Inputs: item (required).
Search the Old School RuneScape Wiki for articles matching a query
Inputs: query (required), limit.
Get the introductory summary of an OSRS Wiki page
Inputs: title (required).
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
Scored across 13 tools
Each tool has a clearly distinct purpose: wiki search, summary, price, and the player data tools are all narrowly scoped (profile, bank, stats, quests, equipment, inventory, diaries, combat achievements). The 'player' tool is slightly generic but is differentiated from list_synced_players by fetching raw data, and from get_my_* by being a lower-level operation. No two tools appear to do the same thing.
The player data tools consistently follow a 'get_my_*' pattern, but the wiki tools use simple verbs/nouns (search, summary, price) and 'player' is a bare noun. This creates minor inconsistency across the set, but within each functional group the naming is predictable and readable.
Thirteen tools is well within the ideal 3-15 range for a server with two clear purposes: wiki lookup and player data retrieval. Every tool serves a distinct need without redundancy, making the set feel appropriately scoped.
The server covers the core companion features: wiki search with summary and price lookup, and comprehensive synced player data including profile, bank, stats, quests, equipment, inventory, diaries, and combat achievements. There are no obvious missing operations for the stated domain, as it is a read-only companion tool.
Search your AI chat history (ChatGPT, Claude, Codex) from any MCP client. Remote, private, read-only
Connect any AI to your Foundry VTT world: actors, combat, dice, journals, tokens, compendiums.
Connect AI assistants to your GitHub-hosted Obsidian vault to seamlessly access, search, and analy…
Connect AI assistants to your approved computer for files, commands, browser and desktop tasks.