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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.3.tar.gz
  • Upload date:
  • Size: 17.6 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.3.tar.gz
Algorithm Hash digest
SHA256 6a0219251cb0797ff21b56b384c5b21dbc70a88c1cfeeb197ff1ee3d9a350ab1
MD5 e50d6f0b4b34c3db1066ef919fe307e6
BLAKE2b-256 fc2c6fe986e68b0e799a4b3361740be87a4cfe918c3adc74cf2f7ff9bf526c9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fiveclaw_agent-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45f4e28bde6be0482e8b5d0a9a07a018365883cbfc536d394f3b9134f83702bf
MD5 272225bbf5261cb71d0a49578b1347ef
BLAKE2b-256 908ca4922ce12e5370fc749d87a89f59dde75f17d7db693436cd250cee0ee59c

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