- Home
- MCP servers
- FiveM Documentation
FiveM Documentation
- python
0
GitHub Stars
python
Language
6 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
You run a FastMCP server that provides quick access to FiveM documentation and related tooling. This MCP server lets you search GTA native functions, QBCore events, ox_lib exports, full-text docs, and generate resource templates, all from an unified chat-based interface.
How to use
Connect to your MCP server from your client or IDE and start asking for documentation lookups. You can search for native functions, QBCore events, ox_lib exports, or full-text docs. You can also generate an fxmanifest template for a new script. Use natural language queries like “Look up the GetPlayerPed native” or “Generate fxmanifest for a new qbcore script.” If you prefer, you can run a local version to test before deploying.
When you connect, you can use these kinds of requests: look up a native, find a QBCore event, search ox_lib exports, run a full-doc search, or generate an fxmanifest. The toolset is designed to be practical for development workflows and Quick access to common references.
How to install
Prerequisites: you need Python installed on your development machine.
Step 1: Install dependencies for local development.
# Install dependencies
pip install -r requirements.txt
Step 2: Run the MCP server locally using the standard I/O transport.
python server.py
Step 3: (Optional) Run with SSE transport for web-based clients.
python -c "from server import mcp; mcp.run(transport='sse')"
Step 4: If you want to deploy to FastMCP Cloud, install the FastMCP CLI and deploy your server.
# Install the CLI
pip install fastmcp
# Deploy your server
fastmcp deploy server.py --name fivem-docs
Step 5: (Optional) Build and run a Docker deployment.
# Build the image
docker build -t mcp-fivem-docs .
# Run the container
docker run -p 8000:8000 mcp-fivem-docs
Additional configuration and options
You can connect to Claude Code using either a cloud-hosted MCP URL or a local instance. The cloud URL is served over SSE, while a local instance can be accessed via localhost on the SSE endpoint or via STDIO for direct scripting.
Tools and capabilities
The MCP server provides the following searchable tools and endpoints to accelerate your FiveM development workflow:
Available tools
lookup_native
Search GTA V native functions by name or keyword across categories such as PLAYER, VEHICLE, PED, and ENTITY.
lookup_qb_event
Search QBCore events and functions by name or keyword, with optional scope to client, server, or both.
lookup_ox_export
Search ox_lib exports by name or keyword, with optional module context like interface or callback.
search_docs
Perform a full-text search across all documentation sources to find relevant references quickly.
get_fxmanifest
Generate a template fxmanifest for a new resource, with optional framework and dependencies.