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):

  • Resource validation and health checks
  • Anti-pattern and duplicate code detection
  • Export/event flow tracing
  • AI code review and test generation
  • FiveM native docs search
  • Pattern library (scaffold new resources/features)

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 can also be configured on the FiveClaw dashboard — the agent fetches them automatically using your API key, so you don't need to duplicate them in .env.

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.1.tar.gz (11.9 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.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.1.tar.gz
  • Upload date:
  • Size: 11.9 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.1.tar.gz
Algorithm Hash digest
SHA256 9e681fa9e074b8c5a357e3c882ce9de6e9eeeb42365ff0365dd7951fc90d6423
MD5 f6d59ff0e3430c6a3582e3bcae968389
BLAKE2b-256 a696d5e938f57589df09ef16e8ed08bd55330e78e0df1b823216763fa75e0388

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce73bc8751404d6ac341bc99862cd321fb1a14d7837e1e014ef06554b44f841c
MD5 448f3e33e69aed249a8e373b17a64eeb
BLAKE2b-256 460b7e87e853d80da2bd185be4ebddd225df9e38f7e38bcb3bbfa3cb35e36342

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