OSRS Wiki MCP server

The OSRS MCP Server provides a powerful interface to interact with Old School RuneScape data through the Model Context Protocol. It allows searching the OSRS Wiki and accessing game data definitions from various files.

Installation Options

Automatic Installation via Smithery

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

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

Manual Installation

If you prefer manual installation, follow these steps:

Prerequisites

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

Installation 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

To use the OSRS MCP server with Claude Desktop, you need to modify your claude_desktop_config.json file.

Using npx (Recommended)

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

Direct Node.js Execution

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

Replace /path/to/mcp-osrs with the actual path to your installation directory.

Available Tools

OSRS Wiki Tools

Wiki Search

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

Get Wiki Page Info

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

Parse Wiki Page

// Get the parsed HTML content of a wiki page
const pageContent = await callTool("osrs_wiki_parse_page", {
  page: "Abyssal_whip"
});

Game Data Search Tools

You can search various game data files using specific tools:

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

// Search for NPCs
const npcs = await callTool("search_npctypes", {
  query: "dragon",
  page: 1,
  pageSize: 10
});

Similar methods exist for searching other game data files:

• search_varptypes - Player variables
• search_varbittypes - Variable bits
• search_iftypes - Interface definitions
• search_invtypes - Inventory definitions
• search_loctypes - Location/object definitions
• search_rowtypes - Interface row definitions
• search_seqtypes - Animation sequences
• search_soundtypes - Sound effects
• search_spottypes - Spot animations/graphical effects
• search_spritetypes - Interface sprites
• search_tabletypes - Interface tabs

Generic Data File Tools

List All Data Files

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

Get File Details

// Get details about a specific data file
const fileDetails = await callTool("get_file_details", {
  filename: "objtypes.txt"
});

Search Any Data File

// Generic search across any data file
const results = await callTool("search_data_file", {
  filename: "objtypes.txt",
  query: "dragon",
  page: 1,
  pageSize: 10
});

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "osrs" '{"command":"npx","args":["-y","@jayarrowz/mcp-osrs"]}'

See the official Claude Code MCP documentation for more details.

For 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 > Tools & Integrations and click "New MCP Server".

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

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

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 explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect