SJ RedM

You have a unified MCP server for RedM development that combines RDR3 discoveries, framework documentation, native functions, and database operations into one powerful tool. It lets you quickly explore game assets, read framework docs, run native function lookups, and manage database interactions from a single, context-aware interface.

How to use

You run the MCP server locally and connect to it with an MCP client. The server automatically loads relevant documentation when you reference RedM frameworks like VORP or RSGCore, or when you search for native functions. Use it to search discoveries, read framework guides, and browse native details, all while performing common tasks in your RedM development workflow.

How to install

Prerequisites: Node.js 16.0.0 or higher. A Claude app or Claude Code CLI is used to manage MCP servers.

1. Open a terminal and navigate to your project directory.

2. Install dependencies.

cd "/path/to/sj-redm-mcp"
npm install

Option A: Claude Code CLI Setup (Recommended)

Add the MCP server to Claude Code using the node command that starts the server.

claude mcp add sj-redm-mcp node "/absolute/path/to/sj-redm-mcp/index.js"

Option A: Add JSON configuration for tokenized access (optional but recommended)

Provide a JSON configuration with the command, arguments, and an optional GitHub token to increase API rate limits.

claude mcp add-json sj-redm-mcp '{
  "command": "node",
  "args": ["/absolute/path/to/sj-redm-mcp/index.js"],
  "env": {
    "GITHUB_TOKEN": "your-github-token-here"
  }
}'

Verify the server configuration (CLI)

Check that the MCP server is registered and active.

claude mcp list

Option B: Claude Desktop Setup

Configure Claude Desktop to run the MCP server locally. Add the following to your Claude Desktop configuration.

{
  "mcpServers": {
    "sj-redm-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/sj-redm-mcp/index.js"],
      "env": {
        "GITHUB_TOKEN": "your-github-token-here"
      }
    }
  }
}

Restart Claude Desktop

After adding the configuration, restart Claude Desktop to load the new MCP server.

Available tools

redm-search-discoveries

Search the RDR3 discoveries repository to locate assets, textures, ped models, controls, scenarios, and animations.

redm-read-discovery-file

Read specific files from the RDR3 discoveries repository to view code examples and topic explanations.

redm-list-discovery-dirs

List directory contents within the RDR3 discoveries repository for quick navigation.

redm-get-lua-examples

Find Lua code examples by topic within the discoveries and framework resources.

redm-search-framework-docs

Search VORP and RSGCore framework documentation for core concepts, events, and APIs.

redm-get-vorp-docs

Get all VORP framework documentation sections including core, characters, inventory, and metabolism.

redm-get-rsgcore-docs

Get all RSGCore framework documentation for client/server events and functions.

redm-get-oxmysql-docs

Access database operation documentation for oxmysql integration.

redm-search-natives

Search for native functions by name across namespaces.

redm-get-native-details

Get detailed information about a specific native function, including parameters and Lua examples.

redm-list-native-namespaces

List all available native namespaces like ENTITY, PLAYER, VEHICLE, etc.

redm-browse-namespace

Browse natives within a specific namespace to view usage and parameters.

redm-get-smart-context

Get intelligent context suggestions based on your query to load relevant docs automatically.