███████╗██╗██╗ ██╗███████╗ ██████╗██╗ █████╗ ██╗ ██╗ ██╔════╝██║██║ ██║██╔════╝██╔════╝██║ ██╔══██╗██║ ██║ █████╗ ██║██║ ██║█████╗ ██║ ██║ ███████║██║ █╗ ██║ ██╔══╝ ██║╚██╗ ██╔╝██╔══╝ ██║ ██║ ██╔══██║██║███╗██║ ██║ ██║ ╚████╔╝ ███████╗╚██████╗███████╗██║ ██║╚███╔███╔╝ ╚═╝ ╚═╝ ╚═══╝ ╚══════╝ ╚═════╝╚══════╝╚═╝ ╚═╝ ╚══╝╚══╝
The local AI bridge between your FiveM server and your IDE.
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 — plus a full local toolkit for FiveM analysis: security scanning, resource validation, anti-pattern and duplicate detection, event tracing, dependency graphs, and more.
Everything runs on your machine. No API key required to get started. An optional free FiveClaw account adds the cloud docs library — 6,400+ FiveM/GTA natives and framework references (ESX, QBCore, ox).
Install once. Works everywhere you code.
Quick Install
pip install fiveclaw-agent
That's it — every analysis and server tool runs locally with no account. Want native/framework docs too? Grab a free API key and add it to your config.
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 · no key needed
│ │
│ ├─ 🛡 Security & analysis │ scan · validate · trace · deps
│ ├─ 📁 Resource map + search│
│ ├─ 🗃 MySQL queries │
│ ├─ 🖥 Server control │
│ ├─ 📋 Log reader │
│ ├─ 🔑 SSH + deploy │
│ └─ 🧠 Persistent memory │
└──────────┬──────────────────┘
│ HTTPS · free API key (docs only)
▼
┌─────────────────────────────┐
│ FiveClaw Docs │ 6,400+ natives · ESX · QBCore · ox
│ (free with an account) │ framework refs · best practices
└─────────────────────────────┘
Your credentials and code never leave your machine — the analysis runs locally. Only native/framework doc lookups reach FiveClaw, and those never include your code.
Tools
Everything below runs locally on your machine, no API key needed, except the FiveClaw Docs section at the end.
Analysis (local)
| Tool | What it does |
|---|---|
🛡 scan_security / scan_security_all |
Detect injection, auth bypass, and logic vulnerabilities |
🏥 resource_health_check |
Validate manifest, syntax, NUI build, dependencies |
✅ tool_validate_resource |
Full resource validation (fxmanifest, Lua syntax, structure) |
🎯 trace_event_flow |
Trace any event from trigger to handler across resources |
🗺 show_dependency_graph |
Map every resource dependency across your server |
🔎 detect_anti_patterns / detect_duplicate_code |
Flag common FiveM mistakes and copy-pasted logic |
📐 validate_load_order / validate_export_contracts |
Catch load-order and export/import mismatches |
🔗 find_exports / find_event_handlers / find_triggers |
Locate exports, handlers, and triggers anywhere |
🧩 pattern_list / pattern_apply |
Scaffold resources from reusable templates |
✅ tool_syntax_check |
Check Lua syntax (built-in checker — no external binary needed) |
Server & files (local)
| Tool | What it does |
|---|---|
📂 repomap_generate / tool_search |
Map and search all resources in your server |
🗃 tool_mysql_query / mysql_list_databases / mysql_visualize_schema |
Query and inspect your FiveM MySQL databases |
🖥 tool_server_control / tool_resource_control |
Start, stop, restart the FXServer or individual resources |
📡 tool_server_console |
Send console commands |
📋 read_latest_logs |
Tail FXServer and resource logs |
🔑 tool_ssh_run/ls/read/write · 🚀 deploy_resource |
Full SSH access and deploy to your remote server |
🧠 context_remember / context_recall |
Persistent notes across AI sessions |
ℹ️ tool_platform_info |
Show configured OS, paths, and enabled services |
FiveClaw Docs (cloud — free with an account)
Native and framework reference, accessed with a free API key. Your code is never sent — these are read-only doc lookups.
📖 fivem_native |
Full reference for all 6,400+ FiveM/GTA natives with examples |
🏗 fivem_get_framework_docs |
ESX, QBCore, ox_lib, ox_core — guides, functions, patterns |
💡 fivem_get_best_practice |
Lua performance, sync patterns, common pitfalls |
⚠️ fivem_get_error_solution |
Common FiveM errors with step-by-step fixes |
🌐 fivem_fetch_live_natives |
Fetch live documentation directly from CFX |
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 |
MySQL and Lua syntax checking work out of the box on every OS — the agent ships a built-in MySQL client and Lua checker, so there's no MariaDB/luac install or path setup.
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
- Python 3.10+
- A free FiveClaw account — optional, only for the cloud docs
License
MIT — free to use, fork, and modify. Every tool in this package is open source and runs locally. The FiveClaw Docs service (native/framework reference) is a separate hosted service accessed with a free account key.
Built by FiveClaw · Get the setup guide
1 maintainer
Metadata
1 maintainer
Release files for fiveclaw-agent 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fiveclaw_agent-1.4.0.tar.gz | 81.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fiveclaw_agent-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 163.9 kB
Release files / fiveclaw_agent-1.4.0.tar.gz
| Download URL | fiveclaw_agent-1.4.0.tar.gz |
|---|---|
| Size | 81.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d070e948c4045fe0492f7add8973a797d3c36200697813807f55efbb5d545f65
|
|
BLAKE2b-256 checksum How to use checksums |
4b5936297f7908b6ffbeaf614068921ce0fae4666a05d7142cce751cb0db1ac4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / fiveclaw_agent-1.4.0-py3-none-any.whl
| Download URL | fiveclaw_agent-1.4.0-py3-none-any.whl |
|---|---|
| Size | 82.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3fc61daf2cef93c48e066ea7a3445608ade54b559c85ad268f15bf278c6b7541
|
|
BLAKE2b-256 checksum How to use checksums |
a1beb069e567fa253dd03cf96084e5cdc453c5d2e4685033b9cb04036b23a65a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
