FiveM MCP Server Documentation

35 tools, 5 resources, 5 prompts across 4 domains.

Connecting

Add to your MCP client config (Claude Desktop, Cline, etc.):

{
    "mcpServers": {
        "fivem": {
            "url": "https://fivem.homestead.systems/fivem",
            "type": "http"
        }
    }
}

Restart your client after changing config. Test locally with php artisan mcp:inspector fivem.

FiveM Core (7 tools)

Search Five M Docs

Search FiveM documentation for specific topics, concepts, or features. Returns relevant documentation URLs and summaries.

SearchFiveMDocs

Generate Manifest

Generate a fxmanifest.lua file for a FiveM resource with the specified configuration options.

GenerateManifest

Generate Resource Boilerplate

Generate boilerplate code for a FiveM resource including client, server, config, and manifest files.

GenerateResourceBoilerplate

Get Native Client Function

Look up GTA5/FiveM client-side native functions by name. Returns function signature, parameters, return type, and usage examples.

GetNativeClientFunction

Get Native Server Function

Look up GTA5/FiveM server-side native functions by name. Returns function signature, parameters, return type, and usage examples.

GetNativeServerFunction

Get Event Client Reference

Get information about FiveM client-side events including framework events (ESX, QBCore).

GetEventClientReference

Get Event Server Reference

Get information about FiveM server-side events including framework events (ESX, QBCore).

GetEventServerReference

QBCore (9 tools)

Get Q B Core Server Function

Look up QBCore server-side functions and exports by name. Returns function signature, parameters, return type, and usage examples.

GetQBCoreServerFunction

Get Q B Core Client Function

Look up QBCore client-side functions by name. Returns function signature, parameters, return type, and usage examples.

GetQBCoreClientFunction

Get Q B Core Server Event Reference

QBCore event reference for server-side events. Includes built-in core events and framework-specific events for server scripts.

GetQBCoreServerEventReference

Get Q B Core Client Event Reference

QBCore event reference for client-side events. Includes built-in core events and framework-specific events for client scripts.

GetQBCoreClientEventReference

Get Q B Core Shared Data

Look up QBCore shared data structure by name. Returns information about items, jobs, gangs, vehicles, weapons, and utility functions.

GetQBCoreSharedData

Get Q B Core Config

Look up QBCore configuration options and settings. Returns information about core config, player defaults, server settings, and framework options.

GetQBCoreConfig

Get Q B Core Players

Look up information about the QBCore.Players table structure and how to access player data. Describes player object properties and methods.

GetQBCorePlayers

Get Q B Core Resource List

Get a complete list of all 58 documented QBCore resources with brief descriptions and categories.

GetQBCoreResourceList

Get Q B Core Resource Reference

Get detailed documentation for a specific QBCore resource. Returns information about configuration, commands, events, callbacks, and usage examples.

GetQBCoreResourceReference

COX (Overextended) (10 tools)

Get C O X Event Reference

Get information about COX MySQL events and callbacks.

GetCOXEventReference

Get C O X Function

Look up COX MySQL functions and methods by name. Returns function signature, parameters, return type, and usage examples.

GetCOXFunction

Get Inventory Server Function

Look up ox_inventory server functions by name. Returns function signature, parameters, return type, and usage examples for server-side inventory management.

GetInventoryServerFunction

Get Inventory Client Function

Look up ox_inventory client functions by name. Returns function signature, parameters, return type, and usage examples for client-side inventory management.

GetInventoryClientFunction

Get Ox Target Client Function

Look up ox_target client functions by name. Returns function signature, parameters, return type, and usage examples for targeting/third-eye interaction system.

GetOxTargetClientFunction

Get Ox Fuel Client Function

Look up ox_fuel client functions by name. Returns function signature, parameters, return type, and usage examples for vehicle fuel management.

GetOxFuelClientFunction

Get Ox Fuel Server Function

Look up ox_fuel server functions by name. Returns function signature, parameters, return type, and usage examples for server-side fuel management.

GetOxFuelServerFunction

Get Ox Doorlock Client Function

Look up ox_doorlock client functions by name. Returns function signature, parameters, return type, and usage examples for client-side door management.

GetOxDoorlockClientFunction

Get Ox Doorlock Server Function

Look up ox_doorlock server functions by name. Returns function signature, parameters, return type, and usage examples for server-side door management.

GetOxDoorlockServerFunction

Get Ox Doorlock Server Event

Look up ox_doorlock server events by name. Returns event signature, parameters, and usage examples for server-side door events.

GetOxDoorlockServerEvent

Community Bridge (9 tools)

Get Bridge Framework

Framework module โ€” server, client functions

GetBridgeFramework

Get Bridge Inventory

Inventory module โ€” server, client functions

GetBridgeInventory

Get Bridge Notify Dispatch

NotifyDispatch module โ€” server, client functions

GetBridgeNotifyDispatch

Get Bridge Interaction

Interaction module โ€” client, server functions

GetBridgeInteraction

Get Bridge Vehicle Appearance

VehicleAppearance module โ€” client, server functions

GetBridgeVehicleAppearance

Get Bridge Economy World

EconomyWorld module โ€” server, client, shared functions

GetBridgeEconomyWorld

Get Bridge Game Libraries

GameLibraries โ€” client, server-side utilities

GetBridgeGameLibraries

Get Bridge Utility Libraries

UtilityLibraries โ€” shared, server-side utilities

GetBridgeUtilityLibraries

Get Bridge World Libraries

WorldLibraries โ€” client-side utilities

GetBridgeWorldLibraries

Resources (5)

Code Snippets

Common FiveM code patterns and snippets for quick reference

Best Practices

FiveM development best practices and optimization tips

Framework Comparison

Comparison of FiveM frameworks: Standalone, ESX, and QBCore

Database Queries

FiveM database query examples and common patterns for COX MySQL

Community Bridge Overview

Community Bridge overview: universal FiveM compatibility layer for QBCore, ESX, QBox. Covers all modules (Framework, Inventory, Notify, etc.) and libraries (Anim, Raycast, Markers, etc.) with setup instructions.

Prompts (5)

Create New Resource

Create a new FiveM resource with framework and language selection

Debug Issues

Debug common FiveM issues and errors

Optimize Performance

Optimize FiveM script performance

Convert Language

Convert code between Lua and JavaScript

Add Framework Integration

Add ESX or QBCore framework integration to existing resource

Quick Examples

Search docs Search FiveM docs for "state bags"
Native lookup What does the GetPlayerPed native do? Show me an example.
Generate manifest Generate a fxmanifest.lua for my resource called "vehicle-shop" using ESX framework
QBCore events Show me all QBCore server events for player management
COX inventory How do I add items to a player inventory with ox_inventory?
Community Bridge How do I use Community Bridge to add items across any framework?
Boilerplate Create a complete QBCore resource called "bank-heist" with NUI

Supported Frameworks

Frameworks

  • Standalone โ€” No framework dependency
  • ESX โ€” es_extended
  • QBCore โ€” qb-core / qbx_core
  • Community Bridge โ€” Universal across all

Languages

Lua and JavaScript fully supported across all tools and generators.