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.

Linux supported Windows supported Python 3.10+ License: MIT

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 Code, Cursor, Windsurf, etc.) direct access to your server's files, logs, MySQL database, SSH, 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

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


Configuration

The easiest way to get your MCP config is the interactive setup wizard at:

👉 fiveclaw.xyz/dashboard/download

It generates the exact JSON for your AI client (Claude Code, Cursor, Windsurf, Kilo Code, Gemini CLI) based on your OS, server details, and plan — including Windows-specific settings, SSH, MySQL, txAdmin, and custom panel options.


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        │
  │  ├─ 🖥  Server control       │
  │  ├─ 📋 Log reader           │
  │  ├─ 🔑 SSH tools            │
  │  ├─ 🚀 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.

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 (embedded LuaJIT — no external binary needed)
📋 read_latest_logs Tail FXServer and resource logs
🗃 tool_mysql_query Run queries against your FiveM MySQL database
🖥 tool_server_control Start, stop, restart the FXServer via txAdmin or custom panel
🔌 tool_resource_control Start/stop/restart individual resources
📡 tool_server_console Send console commands
🔑 tool_ssh_run/ls/read/write Full SSH access to your remote server
🚀 deploy_resource Deploy a resource directly to production
🧠 context_remember Store persistent notes across AI sessions
ℹ️ tool_platform_info Show configured OS, paths, and enabled services

Cloud Tools

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

fivem-mcp — included on all plans

📖 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
⚠️ 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

🏥 Resource health Validate manifests, exports, load order
🛡 Security scanner Detect injection, auth bypass, and logic vulnerabilities
🎯 Event tracer Trace any event from trigger to handler across resources
📐 Pattern library Scaffold new resources from reusable team templates
🔍 Duplicate detector Find copy-pasted code across your codebase
📋 Load order validator Catch server.cfg load order mistakes before they crash your server
🗺 Dependency graph Map every resource dependency across your entire server

ai-fivem-dev-mcp — Enterprise

🧪 Test engine Run full test suites (test_resource, test_database)
🎯 Event testing Simulate and assert on live network events (test_event)
🔬 Function testing Unit-test any Lua or JS function in isolation (test_function)
📊 Coverage reports See exactly which functions and events are tested (test_coverage)
⚙️ Test generation Auto-generate test stubs from your existing code (test_generate)
🧠 Shared team context Team knowledge base stored on FiveClaw infrastructure — all members read and write

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

Platform Support

Environment Status
Linux ✅ Fully supported
macOS ✅ Fully supported
Windows ✅ Fully supported

Windows note: Use python -u -m fiveclaw_agent as the command (not the fiveclaw entry point) to avoid pipe-buffering issues. The setup wizard handles this automatically.


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 the setup guide

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.3.4.tar.gz (32.0 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.3.4-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.3.4.tar.gz
  • Upload date:
  • Size: 32.0 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.3.4.tar.gz
Algorithm Hash digest
SHA256 d3dda1e47346fccf6cce80d40ab92a056fe7ecdf25d071cc02ca20088eb808f7
MD5 0244b718008a2fdb4ce5ed20284e5557
BLAKE2b-256 effe69b1562b3f010b42336affebd31a311d2cc6c048b6fa8892a54b0241ed4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 31.4 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.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b860a1c393ad86de6adf51b52d4087a5a7779edb060dc6b5b645e08ca6d80d61
MD5 a929f0c0964d52243dffbd0a42cc8dd1
BLAKE2b-256 61db3f372b2a4d4f6b2acb9fdbeeff11ec2a4007b6a1d931f9a263ce49bcf38b

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