Skip to main content

Local MCP agent for FiveClaw — FiveM AI development tools

Project description

fiveclaw-agent

Local MCP agent for FiveClaw — AI-powered FiveM development tools.

What it does

fiveclaw-agent runs on your machine alongside your FiveM server. It handles local operations (file search, logs, MySQL, txAdmin, SSH deploy) and relays AI analysis requests to the FiveClaw platform using your API key.

Local tools (run on your machine):

  • Resource map generation and querying
  • File search across Lua/JS resources
  • Lua syntax checking
  • Log reading
  • MySQL query execution
  • txAdmin server control (start/stop/restart resources, send console commands)
  • SSH deployment to remote servers
  • Persistent context memory

Cloud tools (powered by FiveClaw, gated by your plan):

fivem-mcp (all plans):

  • FiveM native docs — 6,400+ native functions
  • ESX, QBCore, ox_lib & ox_core framework docs
  • Best practices, anti-pattern guides, error solutions
  • Live CFX documentation fetch

ai-fivem-dev-mcp (Pro + Enterprise):

  • Resource validation and health checks
  • Anti-pattern and duplicate code detection
  • Security scanner — injection, auth & logic vulnerabilities
  • Export contract validation and NUI completeness checks
  • Event tracer — trace any event from trigger to handler
  • Find exports, event handlers, and triggers across your codebase
  • Full test engine — unit, event, database, and coverage tests
  • Auto-generate test stubs from existing code
  • Pattern library — scaffold new resources from reusable templates
  • Load order validator and dependency graph (Enterprise)
  • Team patterns — shared scaffolds across your whole team (Enterprise)

Requirements

Installation

pip install fiveclaw-agent

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

Setup

  1. Create a .env file in your FiveM project root:
FIVECLAW_API_KEY=fc_live_your_key_here

# Optional — auto-detected if not set
# FIVEM_PROJECT_ROOT=/path/to/your/server

# Optional SSH deployment
# FIVEM_SSH_HOST=1.2.3.4
# FIVEM_SSH_USER=root
# FIVEM_SSH_KEY_PATH=~/.ssh/id_rsa
# FIVEM_REMOTE_RESOURCES=/server-data/resources
  1. Add to your Claude config (claude_desktop_config.json or .mcp.json):
{
  "mcpServers": {
    "fiveclaw": {
      "url": "http://localhost:5200/mcp"
    }
  }
}
  1. Start the agent in your project directory:
fiveclaw

The agent runs on http://localhost:5200/mcp and stays running while you work. Restart it anytime without restarting Claude.

  1. Verify by asking Claude: "Run mcp_health to check my FiveClaw connection."

Configuration

SSH, txAdmin, and MySQL settings are configured locally inside your MCP client config (e.g. claude_desktop_config.json). The setup guide at fiveclaw.xyz/dashboard/download walks you through each field — only fill in what you use, everything is optional.

Links

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.5.tar.gz (18.2 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.5-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.5.tar.gz
  • Upload date:
  • Size: 18.2 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.5.tar.gz
Algorithm Hash digest
SHA256 32effac0bec92cb2537deb1a6e66ff6a9d9fae3aa77aaefd2ee47a725bbe3229
MD5 77e5591a2196747fb6288c7912510ec3
BLAKE2b-256 fa3f16c457f42a98e7f195a3ec87f488bdfec6d0e6049e9fa96e0f0572a12726

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 18.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b69b5a2ff903cef824bf9769e972ae1725be8390fc2310fcae65ef8097e5da93
MD5 2534624143332064f8d3d2a4e300d64b
BLAKE2b-256 a0b0209f4f63c748e852e8ae2238b43a805a168b06ed13f3bea9ce26a0edede1

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