fivem-mcp
v0.2.0
Published
MCP server serving FiveM, ox (Overextended), ESX and QBCore documentation, security rules, and live server-stack detection to any MCP-capable AI editor.
Downloads
217
Maintainers
Readme
fivem-mcp
An MCP server that gives any AI editor accurate FiveM knowledge — instead of a plausible guess at an API that doesn't exist.
Serves documentation for the FiveM Lua runtime, fxmanifest.lua, GTA V natives, the ox (Overextended) stack — ox_lib, ox_core, ox_target, ox_inventory — plus ESX Legacy, QBCore and Qbox, all verified against real resource sources. It also analyses your Lua for exploitable defects and detects which framework a server actually runs.
Works in Claude Code, Claude Desktop, Cursor, Windsurf, VS Code, Zed, or anything else that speaks MCP.
Install
npx -y fivem-mcpClaude Code
claude mcp add fivem -- npx -y fivem-mcp@latestOr install the full plugin, which bundles this server plus skills and slash commands:
/plugin marketplace add hamchowderr/fivem-kit
/plugin install fivemCursor / Windsurf / Claude Desktop / VS Code
Add to the MCP config (.cursor/mcp.json, claude_desktop_config.json, mcp.json — the
shape is the same):
{
"mcpServers": {
"fivem-kit": {
"command": "npx",
"args": ["-y", "fivem-mcp@latest"]
}
}
}Tools
| Tool | What it does |
|---|---|
| fivemDocs | List or read documentation pages. Call with no arguments for the index. |
| fivemSearch | Keyword search across every page, with matching excerpts. |
| fivemNatives | Search all ~7,300 GTA V + CFX natives by name, hash or task description. |
| fivemAudit | Static analysis of Lua for exploitable defects, plus review prompts for what a regex cannot decide. |
| fivemDetectStack | Inspect a server folder: framework, libraries, resources, load order, cfg problems. |
fivemAudit
Deterministic checks — SQL injection, load/loadstring, unguarded commands, source
used after a yield, committed secrets, sensitive broadcasts, while true with no Wait,
legacy MySQL APIs. It knows whether a file is client- or server-side and suppresses rules
that don't apply.
Rules that need semantic judgement (is this parameter validated? is there a distance check?) are not guessed at — they come back as targeted review prompts naming the entry points found. A report padded with false positives buries the real finding.
fivemNatives
The complete database: ~6,416 GTA V natives across 44 namespaces plus ~943 CFX/FiveM natives, with parameter names, types, return types and official descriptions.
Resolves a native by Lua name, snake name, or hash, and searches by task description ("give weapon to ped"). It distinguishes client natives from their server RPC equivalents — these share a name but have different hashes — and points at the ox_lib wrapper where one exists.
Fetched from runtime.fivem.net on first use and cached for 30 days under
$LOCALAPPDATA/fivem-kit or $XDG_CACHE_HOME/fivem-kit; override with
FIVEM_CACHE_DIR. Not bundled: the CitizenFX natives repositories publish no license, and
the database tracks game builds so a bundled copy would go stale.
fivemDetectStack
Reports the framework (ox_core / es_extended / qb-core / qbx_core), the libraries, every
installed resource with its declared dependencies, the server.cfg load order, resources
started but missing from disk, and cfg lines containing ; — which FiveM splits on and
runs as separate commands rather than treating as a comment.
Development
npm install
npm start # run over stdio
npm run inspect # MCP Inspector
npm run build:corpus # bundle docs into corpus/ (runs automatically on publish)The corpus is the plugin's own markdown. From a repo checkout it is read directly from
../skills and ../docs; on publish, build-corpus.mjs copies it into corpus/ so the
npm package is self-contained.
License
MIT © Otaku Solutions. Built by the team behind myRP.build.
Not affiliated with or endorsed by Cfx.re or the Overextended team.
