OSRS Wiki MCP server

This MCP server provides tools to search the Old School RuneScape (OSRS) Wiki and access game data definitions through the Model Context Protocol. It offers methods for searching the wiki, retrieving page information, and searching through various game data files.

Installation Options

Using Smithery (Recommended)

The easiest way to install the OSRS MCP server for Claude Desktop is via Smithery:

npx @smithery/cli@latest install @jayarrowz/mcp-osrs --client claude

Manual Installation

Prerequisites

• Node.js (v16 or later)
• npm or yarn

Steps

# 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

Configuration for Claude Desktop

Add one of the following configurations to your claude_desktop_config.json file:

Using npx

{
  "mcpServers": {
    "osrs": {
      "command": "npx",
      "args": ["-y", "@jayarrowz/mcp-osrs"]
    }
  }
}

Using Node.js Directly

{
  "mcpServers": {
    "osrs": {
      "command": "node",
      "args": ["/path/to/mcp-osrs/dist/index.js"]
    }
  }
}

Replace /path/to/mcp-osrs with the actual path to your installed repository.

Available Tools

OSRS Wiki Methods

These tools allow you to interact with the OSRS Wiki:

• 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

Game Data Search Methods

These tools search through various game data files:

• search_varptypes: Search player variables (varps) that store player state and progress
• search_varbittypes: Search variable bits (varbits) that store individual bits from varps
• search_iftypes: Search interface definitions used in the game's UI
• search_invtypes: Search inventory type definitions
• search_loctypes: Search location/object type definitions in the game world
• search_npctypes: Search NPC (non-player character) definitions
• search_objtypes: Search object/item definitions
• search_rowtypes: Search row definitions used in various interfaces
• search_seqtypes: Search animation sequence definitions
• search_soundtypes: Search sound effect definitions
• search_spottypes: Search spot animation (graphical effect) definitions
• search_spritetypes: Search sprite image definitions used in the interface
• search_tabletypes: Search interface tab definitions

Generic Data File Methods

These tools provide more general access to data files:

• 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

Usage Examples

Searching the OSRS Wiki

// Search for information about the Abyssal whip
const result = await callTool("osrs_wiki_search", { 
  search: "Abyssal whip" 
});

Getting Wiki Page Information

// Get information about a specific wiki page
const pageInfo = await callTool("osrs_wiki_get_page_info", { 
  titles: "Abyssal_whip" 
});

Searching Game Data

// Search for items in the object definitions
const items = await callTool("search_objtypes", { 
  query: "dragon",
  page: 1,
  pageSize: 10
});

Listing Available Data Files

// Get a list of all data files
const files = await callTool("list_data_files", {});

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.