redm-search-discoveriesLABSCO SUMMARY
The docs, the natives and the discoveries repo answer as one.
RedM knowledge is normally spread across a framework wiki, a natives reference and a community research repo, and the smart context loader is what collapses that: naming VORP pulls the framework docs and the database documentation along with the answer. Native output prefers the function name with the hash as a comment, which is the form you actually paste into Lua.
What it is
A Node server for RedM development. It bundles framework documentation and a native-function database, and searches the RDR3 discoveries repository on GitHub, loading the relevant set from what you asked.
What you get
- The RDR3 discoveries repository searched, browsed and read — redm-search-discoveries, redm-list-discovery-dirs, redm-read-discovery-file
- Lua code examples found by topic — redm-get-lua-examples
- VORP and RSGCore documentation searched or returned whole, plus oxmysql database documentation — redm-search-framework-docs, redm-get-vorp-docs, redm-get-rsgcore-docs, redm-get-oxmysql-docs
- Native functions searched by name, read in detail, and browsed across 86+ namespaces — redm-search-natives, redm-get-native-details, redm-list-native-namespaces, redm-browse-namespace
- Relevant documentation loaded from context — mention VORP or RSG and the framework docs arrive with the answer — redm-get-smart-context
- Natives written as direct calls with the hash in a trailing comment, rather than the hash alone
Requirements
Node.js 16.0.0 or higher. Clone the repository, run npm install, then register node index.js with your client — claude mcp add works, and a project-level .mcp.json is included. GITHUB_TOKEN is optional and raises the GitHub API rate limit for the discoveries searches.
Setup effort
Build from source — git clone https://github.com/iamvillain/sj-redm-mcp.git
USE CASES
01
Writing against a framework you are new to
Mention VORP or RSGCore and the matching documentation loads alongside the answer, including the database layer you will need anyway.
02
Checking what a native actually takes
Search by name, then read the parameters, types and a working Lua example rather than guessing the signature.
03
Researching a game asset
Search the discoveries repository for textures, ped models, scenarios or animations, and read the file that turned up.
04
Getting a database query right
The oxmysql documentation is bundled, so an insert or a query is written against the real API instead of general SQL habit.
13 tools
Listed in project docs. Your client may show a different list.
redm-read-discovery-fileredm-list-discovery-dirsredm-get-lua-examplesredm-search-framework-docsredm-get-vorp-docsredm-get-rsgcore-docsredm-get-oxmysql-docsredm-search-nativesredm-get-native-detailsredm-list-native-namespacesredm-browse-namespaceredm-get-smart-contextBEFORE YOU INSTALL
What to know first
Tools you get
13 tools named in the project's documentation.
Requires
Node.js 16.0.0 or later
Where it runs
Both documented clients run the server on your machine.
INSTALLATION
Connect your client
You clone this one yourself.
Server setup
TERMINAL
git clone https://github.com/iamvillain/sj-redm-mcp.git
cd sj-redm-mcp
npm installMCP Clients
Claude Code, Claude Desktop
JSON
{
"mcpServers": {
"sj-redm-mcp": {
"command": "node",
"args": [
"<YOUR_PATH_TO_SJ_REDM_MCP>/index.js"
],
"env": {
"GITHUB_TOKEN": "<YOUR_GITHUB_TOKEN>"
}
}
}
}
