redm-mcp
Provides Cfx/FiveM runtime documentation and native lookups, including GTA5-only native warnings, and supports converting FiveM YCD / Mixamo FBX animations to RedM YCDs.
redm-mcp — RedM / RDR3 docs MCP server
Model Context Protocol (MCP) server for RedM / RDR3: native lookups (hash ↔ name), hybrid semantic search, static checking of agent-written scripts, framework docs (VORP, RSGCore, ox_lib, oxmysql, Feather), Cfx runtime docs, community-verified findings, map/location lookups, game-asset and discovery catalogs (peds, weapons, animations, AI flags, props, audio banks, catalog items) and an animation converter. Gives AI coding agents (Claude Code, Cursor, Claude Desktop, VS Code Copilot, Zed, …) exact answers instead of guesses.
Runs as a hosted HTTP-transport MCP at https://redm-mcp.fivem.no/mcp — no local install. Free to use; you sign in once with Discord (OAuth) when your client connects.
This repository contains only installation/usage docs and serves as the issue tracker. The server source code is proprietary and not distributed. The hosted endpoint is free to use.
Why
When an agent reads RedM code it typically encounters:
Citizen.InvokeNative(0x09C28F828EE674FA, player, 1.5, 5000)Without a lookup, the agent guesses at parameters and semantics. With this server:
lookup_native({ hash: "0x09C28F828EE674FA" })
→ BOOST_PLAYER_HORSE_SPEED_FOR_TIME(player Player, speedBoost float, duration int)The server advertises its own usage via MCP instructions — no skill or extra client config needed.
Related MCP server: SJ RedM MCP Server
Tools
Tool | Use |
| Exact lookup by hash or name (incl. old names). Warnings, usage and linked community findings; flags GTA5-only natives. |
| Hybrid (semantic + lexical, reranked) search by behavior/concept across docs, frameworks and findings. |
| Regex/literal grep across raw doc files. Needed for the large data tables that are only preview-indexed in embeddings. |
| Fetch a doc path (optionally trimmed to relevant sections) or an exact line range. |
| List categories, namespaces and document paths. |
| Static check of a whole Lua/JS/TS script against the natives the RedM runtime actually defines: nil globals, wrong signatures/arity, cross-game natives, |
| Peds, weapons, vehicles, props etc. by name, hash or type. |
| Search community discovery catalogs (animations, AI flags, controls, bones, events, catalog items, …). |
| Where is X, what is near these coordinates, which town is this. |
| How to call natives correctly from Lua / JS. |
| Share a verified gotcha so other agents find it. Findings are reviewed before they become public. |
| Convert FiveM YCD / Mixamo FBX animations to RedM YCDs with integration steps. Offline-verified, not in-game; the operator can switch access off. |
The server also exposes MCP prompts and resources (decision tree, invoke guides, pool-size limits).
Client setup
All clients connect to https://redm-mcp.fivem.no/mcp. The first connection opens a Discord sign-in (OAuth; only your Discord identity is requested, identify scope). Clients with built-in OAuth support (Claude Code, Cursor, VS Code, Claude Desktop connectors) handle this automatically; mcp-remote does the same for stdio-only clients.
VS Code and Cursor users: click an install badge above for one-click setup. For everything else, copy-paste the config below — also available as ready-made files in examples/.
Claude Code
claude mcp add --transport http redm-mcp https://redm-mcp.fivem.no/mcpOr edit ~/.claude.json manually:
{
"mcpServers": {
"redm-mcp": {
"type": "http",
"url": "https://redm-mcp.fivem.no/mcp"
}
}
}Cursor
Edit ~/.cursor/mcp.json (or .cursor/mcp.json in a project root):
{
"mcpServers": {
"redm-mcp": {
"url": "https://redm-mcp.fivem.no/mcp"
}
}
}Restart Cursor. Check Settings → MCP for green status.
Claude Desktop
Claude Desktop doesn't support HTTP MCP directly — use mcp-remote as a proxy. Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"redm-mcp": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://redm-mcp.fivem.no/mcp"
]
}
}
}Restart Claude Desktop.
VS Code (Copilot / Continue)
.vscode/mcp.json in a project root:
{
"servers": {
"redm-mcp": {
"type": "http",
"url": "https://redm-mcp.fivem.no/mcp"
}
}
}Zed
~/.config/zed/settings.json:
{
"context_servers": {
"redm-mcp": {
"command": {
"path": "npx",
"args": [
"-y",
"mcp-remote",
"https://redm-mcp.fivem.no/mcp"
]
}
}
}
}Other clients (generic)
HTTP transport clients: point to
https://redm-mcp.fivem.no/mcpstdio-only clients: use
mcp-remoteas a proxy
Verify it works
curl https://redm-mcp.fivem.no/health→{"ok":true}curl https://redm-mcp.fivem.no/ingest-status→ shows version and last ingested timestampIn your client: sign in with Discord when prompted, then ask the agent to look up
0x09C28F828EE674FA— should returnBOOST_PLAYER_HORSE_SPEED_FOR_TIME
Endpoints
Path | Auth | Purpose |
| Discord OAuth | MCP protocol |
| no | Liveness |
| no |
|
Usage is logged per tool call (tool, arguments, Discord identity) to operate and improve the service. Scripts sent to check_code are stored with secrets masked for 90 days.
Example prompts
See examples/prompts.md for things to try once installed (native lookups, behavior searches, framework / inventory questions, debugging).
Issues / feedback
Bug, missing docs, incorrect native lookups, requests for new tools? Open an issue.
Doc sources
Indexed upstreams:
femga/rdr3_discoveries — community ped/weapon/anim/prop hashes, AI flags, enums
VORPCORE/documentation, rsgcore.com, overextended (
ox_lib,oxmysql), Feather and community repos — framework and library docsVORPCORE/RDR3natives and the Cfx native dumps — natives
citizenfx/fivem-docs — Cfx runtime/scripting docs
jeanropke/RDOMap — map locations
Community findings shared through
share_finding
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
Access and search Branch's official API documentation directly within any AI agent or client.
Persistent memory and knowledge management for AI agents with semantic search and 50+ tools.
Versioned documentation registry and semantic search for AI tools and coding assistants.
Agent-native search engine with live web research optimized for AI agents.
Related MCP Servers
- FlicenseNot gradedqualityNot gradedmaintenanceProvides documentation lookup and search capabilities for FiveM development, including GTA V native functions, QBCore events, and ox_lib exports. Enables developers to query documentation and generate resource templates through natural language.-
- AlicenseBqualityDmaintenanceA unified development tool for RedM that provides access to RDR3 discoveries, framework documentation (VORP/RSGCore), native functions across 86+ namespaces, and database operations with smart context-aware loading.137MIT
- FlicenseNot gradedqualityDmaintenanceEnables AI assistants to fetch, index, and perform semantic RAG-based searches on API documentation from various sources. It provides tools for hybrid search and collection management, allowing users to access up-to-date documentation from projects like Gemini and FastMCP.-
- AlicenseNot gradedqualityBmaintenanceEnables coding assistants to query Resemble AI documentation, search pages, and access OpenAPI schemas for code generation.3MIT