FiveM MCP Quick Start Guide

What is this?

This MCP server gives AI assistants (like Claude) access to FiveM development tools including:

  • Documentation search
  • Native function lookups
  • Manifest generation
  • Event references
  • Resource boilerplate generation

Choose Your Setup

Easy setup! Connect to a hosted MCP server. Works from anywhere without any local installation.

If someone is hosting the FiveM MCP server for you, follow these steps to connect:

1. Get the Server URL

Ask your server administrator for the MCP server URL. It will look like: 

https://your-domain.com/fivem

If you're using the official hosted server, use this URL: 

https://fivem.homestead.systems/fivem

2. Configure Claude Desktop

Edit your Claude Desktop configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Add this configuration (replace the URL with your actual server URL): 

{
    "mcpServers": {
        "fivem": {
            "url": "https://your-domain.com/fivem"
        }
    }
}

For VSCode (Cline Extension):

Edit your VSCode settings.json: 

{
    "mcp": {
        "servers": {
            "fivem": {
                "url": "https://your-domain.com/fivem"
            }
        }
    }
}

3. Restart Claude Desktop

Completely quit and restart Claude Desktop for changes to take effect.

4. Verify Connection

In Claude Desktop, you should see a small 🔌 icon or indication that the FiveM MCP server is connected.

That's it! You're now connected to the remote MCP server and can start using FiveM development tools with Claude.

Quick Examples

Once connected, try these prompts in Claude:

Example 1: Search Documentation

Search FiveM docs for "state bags"

Example 2: Look Up a Native

What does the GetPlayerPed native function do? Show me an example.

Example 3: Generate a Manifest

Generate a fxmanifest.lua for my resource called "vehicle-shop" using ESX framework

Example 4: List Events

Show me all FiveM core server events

Example 5: Create Boilerplate

Create a complete resource structure for a QBCore script called "bank-heist" with NUI

Troubleshooting

Server Not Connecting

  1. Check PHP Path: Make sure the PHP path in your config is correct 
    which php
# or for Herd:
ls -la "~/Library/Application Support/Herd/bin/"
  2. Test Manually: Run the server command directly 
    cd /path/to/fivem-mcp
php artisan mcp:start fivem
  3. Check Logs: Look at Claude Desktop logs
    • macOS: ~/Library/Logs/Claude/
    • Windows: Check Event Viewer or app logs

Permission Issues

If you get permission errors:

cd /path/to/fivem-mcp
chmod +x artisan

Path Issues

Make sure to use absolute paths in your config, not relative paths.

Next Steps

  • Read the full documentation
  • Explore all 5 tools in the MCP Inspector
  • Try creating a complete FiveM resource with AI assistance
  • Contribute new tools or improve existing ones

Support

For issues:

  1. Check Laravel MCP Documentation
  2. Check FiveM Documentation
  3. Review server logs
  4. Open a GitHub issue

Happy coding! 🎮