OSRS MCP Server 
MCP Server for interacting with the Old School RuneScape (OSRS) Wiki API and data files. This server provides tools to search the OSRS Wiki and access game data definitions through the Model Context Protocol.
Tools
This server implements the following tools:
OSRS Wiki Methods
osrs_wiki_search- Search the OSRS Wiki for pages matching a search termosrs_wiki_get_page_info- Get information about specific pages on the OSRS Wikiosrs_wiki_parse_page- Get the parsed HTML content of a specific OSRS Wiki page
Game Data Search Methods
search_varptypes- Search the varptypes.txt file for player variables (varps) that store player state and progresssearch_varbittypes- Search the varbittypes.txt file for variable bits (varbits) that store individual bits from varpssearch_iftypes- Search the iftypes.txt file for interface definitions used in the game's UIsearch_invtypes- Search the invtypes.txt file for inventory type definitions in the gamesearch_loctypes- Search the loctypes.txt file for location/object type definitions in the game worldsearch_npctypes- Search the npctypes.txt file for NPC (non-player character) definitionssearch_objtypes- Search the objtypes.txt file for object/item definitions in the gamesearch_rowtypes- Search the rowtypes.txt file for row definitions used in various interfacessearch_seqtypes- Search the seqtypes.txt file for animation sequence definitionssearch_soundtypes- Search the soundtypes.txt file for sound effect definitions in the gamesearch_spottypes- Search the spottypes.txt file for spot animation (graphical effect) definitionssearch_spritetypes- Search the spritetypes.txt file for sprite image definitions used in the interfacesearch_tabletypes- Search the tabletypes.txt file for interface tab definitions
Generic Data File Methods
search_data_file- Search any file in the data directory for matching entriesget_file_details- Get details about a file in the data directorylist_data_files- List available data files in the data directory
Installation
Installing via Smithery
To install mcp-osrs for Claude Desktop automatically via Smithery:
npx @smithery/cli@latest install @jayarrowz/mcp-osrs --client claude
Prerequisites
- Node.js (v16 or later)
- npm or yarn
Installing the package
# Clone the repository
git clone https://github.com/jayarrowz/mcp-osrs.git
cd mcp-osrs
# Install dependencies
npm install
# Build the package
npm run build
Usage with Claude Desktop
Add the following to your claude_desktop_config.json:
Using npx
{
"mcpServers": {
"osrs": {
"command": "npx",
"args": ["-y", "@jayarrowz/mcp-osrs"]
}
}
}
Direct Node.js
{
"mcpServers": {
"osrs": {
"command": "node",
"args": ["/path/to/mcp-osrs/dist/index.js"]
}
}
}
Replace /path/to/mcp-osrs with the actual path to your repository.
Examples
Search the OSRS Wiki
// Search for information about the Abyssal whip
const result = await callTool("osrs_wiki_search", {
search: "Abyssal whip"
});
Get Page Information
// Get information about a specific wiki page
const pageInfo = await callTool("osrs_wiki_get_page_info", {
titles: "Abyssal_whip"
});
Search Game Data
// Search for items in the object definitions
const items = await callTool("search_objtypes", {
query: "dragon",
page: 1,
pageSize: 10
});
List Available Data Files
// Get a list of all data files
const files = await callTool("list_data_files", {});
Development
# Install dependencies
npm install
# Start the server in development mode
npm start
# Build the server
npm run build
License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.