OSRS MCP Server
OfficialClick 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 MCP Server search the wiki for abyssal whip drop rates"
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.
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
Related MCP server: MCP Server
Installation
Installing via Smithery
To install mcp-osrs for Claude Desktop automatically via Smithery:
npx @smithery/cli@latest install @jayarrowz/mcp-osrs --client claudePrerequisites
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 buildUsage 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 buildLicense
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.
Available Tools
19 toolsget_file_detailsC
Get details about a file in the data directory.
Inputs: filename (required).
list_data_filesB
List available data files in the data directory.
Inputs: fileType.
osrs_wiki_get_page_infoC
Get information about specific pages on the OSRS Wiki.
Inputs: titles (required).
osrs_wiki_parse_pageC
Get the parsed HTML content of a specific OSRS Wiki page.
Inputs: page (required).
osrs_wiki_searchC
Search the OSRS Wiki for pages matching a search term.
Inputs: search (required), limit, offset.
search_data_fileC
Search any file in the data directory for matching entries.
Inputs: filename (required), query (required), page, pageSize.
search_iftypesC
Search the iftypes.txt file for interface definitions used in the game's UI.
Inputs: query (required), page, pageSize.
search_invtypesC
Search the invtypes.txt file for inventory type definitions in the game.
Inputs: query (required), page, pageSize.
search_loctypesC
Search the loctypes.txt file for location/object type definitions in the game world.
Inputs: query (required), page, pageSize.
search_npctypesC
Search the npctypes.txt file for NPC (non-player character) definitions.
Inputs: query (required), page, pageSize.
search_objtypesC
Search the objtypes.txt file for object/item definitions in the game.
Inputs: query (required), page, pageSize.
search_rowtypesC
Search the rowtypes.txt file for row definitions used in various interfaces.
Inputs: query (required), page, pageSize.
search_seqtypesC
Search the seqtypes.txt file for animation sequence definitions.
Inputs: query (required), page, pageSize.
search_soundtypesC
Search the soundtypes.txt file for sound effect definitions in the game.
Inputs: query (required), page, pageSize.
search_spottypesC
Search the spottypes.txt file for spot animation (graphical effect) definitions.
Inputs: query (required), page, pageSize.
search_spritetypesC
Search the spritetypes.txt file for sprite image definitions used in the interface.
Inputs: query (required), page, pageSize.
search_tabletypesC
Search the tabletypes.txt file for interface tab definitions.
Inputs: query (required), page, pageSize.
search_varbittypesC
Search the varbittypes.txt file for variable bits (varbits) that store individual bits from varps.
Inputs: query (required), page, pageSize.
search_varptypesC
Search the varptypes.txt file for player variables (varps) that store player state and progress.
Inputs: query (required), page, pageSize.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 19 tools
Most tools have distinct purposes: file operations, wiki interactions, and specific data file searches. However, the 12 'search_*' tools for different file types (e.g., search_npctypes, search_objtypes) could be confused as they share similar search patterns across different game data categories, though descriptions clarify the target file.
Naming is mixed: 'get_file_details' and 'list_data_files' use verb_noun, while 'osrs_wiki_*' tools prefix with 'osrs_wiki_' and use verb_noun, and 'search_*' tools use a consistent 'search_<type>' pattern. This creates readable but inconsistent conventions across the set.
With 19 tools, the count is borderline high for a server focused on OSRS data and wiki access. It includes many specialized search tools, which might feel heavy but are justified by the domain's complexity, though some consolidation could improve coherence.
The tool set comprehensively covers the domain: file management, wiki access, and detailed searches across all major game data types (NPCs, objects, animations, etc.). No obvious gaps exist for retrieving and searching OSRS-related information.
Related MCP Connectors
MCP server for developer documentation, generated by doc2mcp.
Market data tools for the MCP ecosystem: server stats, events, search, leaderboards, package trends.
MCP server for skill documentation, generated by doc2mcp.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceMCP Server simplifies the implementation of the Model Context Protocol by providing a user-friendly API to create custom tools and manage server workflows efficiently.39 npm4MIT
- AlicenseNot gradedqualityCmaintenanceMCP Server provides a simpler API to interact with the Model Context Protocol by allowing users to define custom tools and services to streamline workflows and processes.26 npm3MIT
- FlicenseBqualityDmaintenanceAn MCP server that enables interaction with Markdown knowledge bases, allowing users to search and retrieve content by tags, text, URL, or date range from their local markdown files.791-
- AlicenseBqualityCmaintenanceEnables interaction with Old School RuneScape game data and Wiki through the Model Context Protocol, providing tools to search the OSRS Wiki and access game definitions for items, NPCs, locations, and game mechanics.2350 npm40MIT