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 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.4.tar.gz (17.7 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.4-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.4.tar.gz
  • Upload date:
  • Size: 17.7 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.4.tar.gz
Algorithm Hash digest
SHA256 b13f27ecc78f075f2ce229f1c0e0a1a4281d36a1bfcc2c2a25cba09f859f7bcd
MD5 ba0a27440c7d75cad2c28f87638f1ad7
BLAKE2b-256 6b524e11f801790eebb1fc189fa52f35e5cb6461e649ee78b9352ddda0511d5c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7164667b52e3152b26cff533096f9433a04c6ea51764509ac8d614a2abbdde13
MD5 948d4e50413f8b3c629dca16003c1286
BLAKE2b-256 16da96360b3541843192fa035a7fc5435210fd059c76636a13220cea8609c25c

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