MCP server for Old School RuneScape Wiki API
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 (varps) that store player state and progress
search_varbittypes - Search the varbittypes.txt file for variable bits (varbits) that store individual bits from varps
search_iftypes - Search the iftypes.txt file for interface definitions used in the game's UI
search_invtypes - Search the invtypes.txt file for inventory type definitions in the game
search_loctypes - Search the loctypes.txt file for location/object type definitions in the game world
search_npctypes - Search the npctypes.txt file for NPC (non-player character) definitions
search_objtypes - Search the objtypes.txt file for object/item definitions in the game
search_rowtypes - Search the rowtypes.txt file for row definitions used in various interfaces
search_seqtypes - Search the seqtypes.txt file for animation sequence definitions
search_soundtypes - Search the soundtypes.txt file for sound effect definitions in the game
search_spottypes - Search the spottypes.txt file for spot animation (graphical effect) definitions
search_spritetypes - Search the spritetypes.txt file for sprite image definitions used in the interface
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
bash
npx @smithery/cli@latest install @jayarrowz/mcp-osrs --client claude
`
$3
- Node.js (v16 or later)
- npm or yarn
$3
`bash
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:
$3
`json
{
"mcpServers": {
"osrs": {
"command": "npx",
"args": ["@jayarrowz/mcp-osrs"]
}
}
}
`
$3
`json
{
"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
$3
`javascript
// Search for information about the Abyssal whip
const result = await callTool("osrs_wiki_search", {
search: "Abyssal whip"
});
`
$3
`javascript
// Get information about a specific wiki page
const pageInfo = await callTool("osrs_wiki_get_page_info", {
titles: "Abyssal_whip"
});
`
$3
`javascript
// Search for items in the object definitions
const items = await callTool("search_objtypes", {
query: "dragon",
page: 1,
pageSize: 10
});
`
$3
`javascript
// Get a list of all data files
const files = await callTool("list_data_files", {});
`
Development
`bash
Install dependencies
npm install
Start the server in development mode
npm start
Build the server
npm run build
``