MCP Osrs

🚀 OSRS MCP Server

This is an MCP server for interacting with the Old School RuneScape (OSRS) Wiki API and data files. It provides tools for searching the OSRS Wiki and accessing game data definitions.

🚀 Quick Start

The OSRS MCP Server offers a range of tools to interact with the OSRS Wiki API and game data files. Below are the details of these tools, installation steps, configuration requirements, and usage examples.

✨ Features

OSRS Wiki Methods

1. osrs_wiki_search - Search the OSRS Wiki for pages matching a query term.
2. osrs_wiki_get_page_info - Get information about a specific OSRS Wiki page.
3. osrs_wiki_parse_page - Get the parsed HTML content of a specific OSRS Wiki page.

Game Data Search Methods

4. search_varptypes - Search the varptypes.txt file for variables (varps) that store player state and progress.
5. search_varbittypes - Search the varbittypes.txt file for individual bits (varbits) from varps.
6. search_iftypes - Search the iftypes.txt file for game interface definitions.
7. search_invtypes - Search the invtypes.txt file for game inventory type definitions.
8. search_loctypes - Search the loctypes.txt file for location/object type definitions in the game world.
9. search_npctypes - Search the npctypes.txt file for non-player character (NPC) definitions.
10. search_objtypes - Search the objtypes.txt file for item definitions.
11. search_searchtypes - Search the searchtypes.txt file for definitions of searchable objects.
12. search_groundtypes - Search the groundtypes.txt file for ground object definitions.

Data File Methods

13. list_data_files - Get a list of all available data files.
14. get_file_info - Get information about a specific file.

📦 Installation

Via Smithery

# Install using Smithery

Manual Installation

# Install dependencies
npm install

# Build the server
npm run build

# Start the server (development mode)
npm start

📚 Documentation

Configuration

Add the following configuration to config.json:

{
  "wiki apiUrl": "https://oldschool.runescape.wiki/api.php",
  "wiki username": "your-wiki-username",
  "wiki password": "your-wiki-password"
}

💻 Usage Examples

Search for Items

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

Get File Information

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

// Get information about a specific file
const fileInfo = await callTool("get_file_info", {
  file: "objtypes.json"
});

Development

# Install dependencies
npm install

# Start the server in development mode
npm start

# Build the server
npm run build

📄 License

This MCP server is released 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, see the LICENSE file in the project repository.