Skip to main content

Local MCP agent for FiveClaw — FiveM AI development tools

Project description

FiveClaw

███████╗██╗██╗   ██╗███████╗ ██████╗██╗      █████╗ ██╗    ██╗
██╔════╝██║██║   ██║██╔════╝██╔════╝██║     ██╔══██╗██║    ██║
█████╗  ██║██║   ██║█████╗  ██║     ██║     ███████║██║ █╗ ██║
██╔══╝  ██║╚██╗ ██╔╝██╔══╝  ██║     ██║     ██╔══██║██║███╗██║
██║     ██║ ╚████╔╝ ███████╗╚██████╗███████╗██║  ██║╚███╔███╔╝
╚═╝     ╚═╝  ╚═══╝  ╚══════╝ ╚═════╝╚══════╝╚═╝  ╚═╝ ╚══╝╚══╝

The local AI bridge between your FiveM server and your IDE.

Tested on Linux Windows WIP

PyPI version Python 3.10+ License: MIT Monthly downloads

Website · Setup Guide · Pricing


What is this?

fiveclaw-agent is a local MCP server that runs on your machine alongside your FiveM server. It gives your AI client (Claude, Cursor, Windsurf, etc.) direct access to your server's files, logs, MySQL database, and txAdmin — and connects it to the FiveClaw cloud platform for FiveM-specific AI intelligence.

Install once. Works everywhere you code.


Quick Install

pip install fiveclaw-agent

# With SSH deployment support
pip install fiveclaw-agent[ssh]

You'll need a FiveClaw account and an API key from your dashboard.


How it works

  ┌─────────────────────────────┐
  │   Your IDE / AI Client      │  Claude Code · Cursor · Windsurf
  │   (MCP-compatible)          │  Kilo Code · Gemini CLI
  └──────────┬──────────────────┘
             │  stdio / MCP protocol
             ▼
  ┌─────────────────────────────┐
  │      fiveclaw-agent         │  ← runs locally on your machine
  │                             │
  │  ├─ 📁 Resource map + search│
  │  ├─ 🗃  MySQL queries        │
  │  ├─ 🖥  txAdmin control      │
  │  ├─ 📋 Log reader           │
  │  ├─ 🚀 SSH deploy           │
  │  └─ 🧠 Persistent memory   │
  └──────────┬──────────────────┘
             │  HTTPS · your API key
             ▼
  ┌─────────────────────────────┐
  │   FiveClaw Platform         │
  │                             │
  │  ├─ fivem-mcp  (all plans)  │  6,400+ natives · ESX · QBCore · ox
  │  └─ ai-fivem-dev-mcp (Pro+) │  analysis · security · testing
  └─────────────────────────────┘

Your credentials never leave your machine. The agent only forwards tool requests to FiveClaw — it never uploads your code or files.


Local Tools

These run entirely on your machine. No API key needed.

Tool What it does
📂 repomap_generate Build a map of all resources in your server
🔍 tool_search Search Lua/JS files across your resources
tool_syntax_check Check Lua syntax without running the server
📋 read_latest_logs Tail FXServer, txAdmin, and resource logs
🗃 tool_mysql_query Run queries against your FiveM MySQL database
🖥 tool_server_control Start, stop, restart the FXServer via txAdmin
🔌 tool_resource_control Start/stop/restart individual resources
📡 tool_server_console Send console commands to the running server
🚀 deploy_resource SSH-deploy a resource directly to production
🧠 context_remember Store persistent notes across AI sessions

Cloud Tools

Powered by FiveClaw. Requires an API key from fiveclaw.xyz.

fivem-mcp — included on all plans (even free)

FiveM intelligence. 6,400+ native functions, framework docs, best practices, live CFX docs.

📖 Native docs Full reference for all 6,400+ FiveM/GTA natives with examples
🏗 Framework docs ESX, QBCore, ox_lib, ox_core — guides, functions, patterns
💡 Best practices Lua performance, sync patterns, common pitfalls
🔎 Anti-pattern guide What not to do and why — with fixes
⚠️ Error solutions Database of common FiveM errors with step-by-step fixes
🌐 Live CFX docs Fetch live documentation directly from CFX

ai-fivem-dev-mcp — Pro + Enterprise

Deep code intelligence for your actual server resources.

🏥 Resource health Validate manifests, exports, load order
🛡 Security scanner Detect injection, auth bypass, and logic vulnerabilities
🔗 Export contracts Validate that imports match their exported signatures
🎯 Event tracer Trace any event from trigger to handler across resources
🧪 Test engine Unit tests, event tests, database tests, coverage reports
📐 Pattern library Scaffold new resources from reusable team templates
🔍 Duplicate detector Find copy-pasted code blocks across your codebase
📦 Dependency graph Visualize resource dependencies (Enterprise)
👥 Team patterns Shared scaffolds across your whole team (Enterprise)

Supported AI Clients

Client Config file
Claude Code Project: .mcp.json · Global: ~/.claude.json
Cursor Project: .cursor/mcp.json · Global: ~/.cursor/mcp.json
Windsurf ~/.codeium/windsurf/mcp_config.json
Kilo Code Project: .kilocode/mcp.json · Global: extension settings
Gemini CLI ~/.gemini/settings.json — merge mcpServers key

The interactive setup wizard at fiveclaw.xyz/dashboard/download generates your config automatically.


Manual Config

Add to your AI client's MCP config. Only FIVECLAW_API_KEY is required — remove any lines you don't use.

{
  "mcpServers": {
    "fiveclaw": {
      "command": "fiveclaw",
      "env": {
        "FIVECLAW_API_KEY":    "fc_live_YOUR_API_KEY_HERE",
        "FIVEM_PROJECT_ROOT":  "/path/to/your/fivem-server",
        "FIVEM_RESOURCES_DIR": "/path/to/your/fivem-server/resources",
        "TXADMIN_URL":         "http://localhost:40120",
        "TXADMIN_USER":        "admin",
        "TXADMIN_PASS":        "YOUR_TXADMIN_PASSWORD",
        "MYSQL_HOST":          "127.0.0.1",
        "MYSQL_USER":          "root",
        "MYSQL_PASSWORD":      "YOUR_MYSQL_PASSWORD",
        "MYSQL_DATABASE":      "fivem",
        "FIVEM_SSH_HOST":      "YOUR_VPS_IP",
        "FIVEM_SSH_USER":      "root",
        "FIVEM_SSH_KEY":       "~/.ssh/id_rsa"
      }
    }
  }
}

Restart your AI client after saving.

Verify it's working

Ask your AI: "Run mcp_health to check my FiveClaw connection."


Platform Support

Environment Status
Linux (local agent + Linux FiveM server) ✅ Fully tested
macOS (local agent) ✅ Should work — untested
Windows (local agent or Windows FiveM server) 🚧 Work in progress

Note: Development and testing has been done entirely on Linux (local machine + remote server). Windows support is being actively worked on — core functionality should work, but edge cases around SSH deployment and MySQL tooling on Windows may need ironing out. If you hit an issue on Windows, open an issue.

Requirements


License

MIT — free to use, fork, and modify.
The fiveclaw-agent itself is open source. The cloud tools (fivem-mcp, ai-fivem-dev-mcp) are proprietary services accessed via API key.


Built by FiveClaw · Get started free

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fiveclaw_agent-1.0.7.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fiveclaw_agent-1.0.7-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file fiveclaw_agent-1.0.7.tar.gz.

File metadata

  • Download URL: fiveclaw_agent-1.0.7.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for fiveclaw_agent-1.0.7.tar.gz
Algorithm Hash digest
SHA256 2574abf85f5f6104aaa50371400f61856fe6466d437165eb935b1f44e97b424c
MD5 d82ccb8ad02406e43ef87592fcf3e235
BLAKE2b-256 f50ecc70e99df5b8162239b7ec23b8ce9c17d99b9a06412d0fd95854347ac09f

See more details on using hashes here.

File details

Details for the file fiveclaw_agent-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: fiveclaw_agent-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for fiveclaw_agent-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b3f6af13e98b57b7fba64428a466826530d4d507112e1272ea165eacba140d1d
MD5 6b69532b92bb2ecca040e28cca86ae9f
BLAKE2b-256 45a0764d44e398c9c32e60789d084aa1eb96f05040384a4b635dc2dd27b0cf28

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page