OSRS
- javascript
19
GitHub Stars
javascript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"jayarrowz-mcp-osrs": {
"command": "node",
"args": [
"/path/to/mcp-osrs/dist/index.js"
]
}
}
}OSRS MCP Server provides tools to query the Old School RuneScape Wiki and data definitions through the Model Context Protocol. It exposes wiki search, page info, parsed pages, and a suite of game data search endpoints to help you build rich OSRS data integrations.
How to use
You connect to the OSRS MCP Server using a client that understands MCP endpoints. You can run the server locally and point your client to it, or use a remote MCP endpoint if available. Use the provided tools to search the OSRS Wiki, fetch page information, parse pages, and query game data definitions across various data files.
How to install
# Prerequisites
- Node.js v16 or later
- npm or yarn
# Clone the package
git clone https://github.com/jayarrowz/mcp-osrs.git
cd mcp-osrs
# Install dependencies
npm install
# Build the package
npm run build
# Run the server locally using npm start (after build) or configure your MCP client to start it
npm start
# Alternatively, run via npx with Claude Desktop configuration
# This step is shown in the client configuration example
npx -y @jayarrowz/mcp-osrs
```"
Additional notes
Two common ways to run the server from a client perspective are shown in the configuration examples. You can either start the server via Node.js by pointing to the built index, or use a package runner like npx to launch it inline. In Claude Desktop, you configure the MCP server entry as either a stdio process with node and the dist index, or an npx invocation that loads the package directly.
Available tools
osrs_wiki_search
Search the OSRS Wiki for pages matching a search term.
osrs_wiki_get_page_info
Get information about specific pages on the OSRS Wiki.
osrs_wiki_parse_page
Get the parsed HTML content of a specific OSRS Wiki page.
search_varptypes
Search the varptypes.txt file for player variables that store state and progress.
search_varbittypes
Search the varbittypes.txt file for variable bits that compose varps.
search_iftypes
Search the iftypes.txt file for interface definitions used in the UI.
search_invtypes
Search the invtypes.txt file for inventory type definitions.
search_loctypes
Search the loctypes.txt file for location and object type definitions.
search_npctypes
Search the npctypes.txt file for NPC definitions.
search_objtypes
Search the objtypes.txt file for object and item definitions.
search_rowtypes
Search the rowtypes.txt file for row definitions used in interfaces.
search_seqtypes
Search the seqtypes.txt file for animation sequence definitions.
search_soundtypes
Search the soundtypes.txt file for sound effect definitions.
search_spottypes
Search the spottypes.txt file for spot animation definitions.
search_spritetypes
Search the spritetypes.txt file for sprite image definitions.
search_tabletypes
Search the tabletypes.txt file for interface tab definitions.
search_data_file
Search any file in the data directory for matching entries.
get_file_details
Get details about a file in the data directory.
list_data_files
List available data files in the data directory.
