FiveM Development MCP Server

Installation & Connection

Choose how you want to connect to the FiveM MCP server:

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

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

{
        "mcpServers": {
            "fivem": {
                "command": "/path/to/php",
                "args": [
                "/path/to/fivem-mcp/artisan",
                "mcp:start",
                "fivem"
                ]
            }
        }
    }

php artisan mcp:start fivem

{
        "mcp": {
            "servers": {
                "fivem": {
                    "command": "php",
                    "args": ["artisan", "mcp:start", "fivem"],
                    "cwd": "/path/to/fivem-mcp"
                }
            }
        }
    }

{
        "mcp": {
            "servers": {
                "fivem": {
                    "command": "/path/to/php",
                    "args": ["/path/to/fivem-mcp/artisan", "mcp:start", "fivem"]
                }
            }
        }
    }

Available Tools

The FiveM MCP Server provides 30 tools organized by category. These tools allow AI assistants to search documentation, generate code, and lookup framework functions.

Available Resources

MCP Resources provide read-only reference documentation that AI assistants can access. Currently available: 4 resources.

Available Prompts

MCP Prompts are pre-built prompt templates for common tasks. Currently available: 5 prompts.

Testing the Server

You can test the MCP server locally using the inspector:

php artisan mcp:inspector fivem

This will open the MCP Inspector in your browser where you can test all the tools interactively.

Development

Adding New Tools

1. Create a new tool class in app/Mcp/Tools/:

<?php

    namespace App\Mcp\Tools;

    use Illuminate\Contracts\JsonSchema\JsonSchema;
    use Laravel\Mcp\Request;
    use Laravel\Mcp\Response;
    use Laravel\Mcp\Server\Attributes\Description;
    use Laravel\Mcp\Server\Tool;

    #[Description('Your tool description')]
    class YourTool extends Tool
    {
        public function handle(Request $request): Response
        {
            // Tool logic here
            return Response::text('Result');
        }

        public function schema(JsonSchema $schema): array
        {
            return [
                'param' => $schema->string()->required(),
            ];
        }
    }
    

2. Register the tool in app/Mcp/Servers/FiveMServer.php:

protected array $tools = [
        // ... existing tools
        \App\Mcp\Tools\YourTool::class,
    ];

Code Formatting

Format code with Laravel Pint:

vendor/bin/pint

Supported Frameworks

• Standalone: Basic FiveM resources without framework dependencies
• ESX: ESX Framework (es_extended)
• QBCore: QBCore Framework (qb-core / qbx_core)
• Prodigy Studios (prp-bridge): Unified bridge supporting QBox, QB-Core, ESX, and ND Core with events, exports, UniQueue, groups, allowlists, sell shops, cases, and ped interactions

Scripting Languages

Both Lua and JavaScript are fully supported across all tools and generators.

Resources

• FiveM Documentation
• FiveM Natives Reference
• COX MySQL Documentation - Required for database operations
• QBCore Documentation
• Prodigy Studios Documentation
• Laravel MCP Documentation
• Model Context Protocol

Contributing

Contributions are welcome! Areas for expansion:

• More native functions in the database
• Additional framework support (vRP, etc.)
• More event types
• Advanced code generators
• Database query builders