You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add four MCP tools that drive a running txAdmin panel over HTTP:
txadmin_server_control, txadmin_resource_control, txadmin_player_search,
and txadmin_kick_player. A dependency-free client (urllib + cookiejar)
authenticates via POST /auth/password, stores the session cookie, and
echoes the csrfToken in the x-txadmin-csrftoken header. Credentials are
read only from TXADMIN_URL / TXADMIN_USERNAME / TXADMIN_PASSWORD.
Add the txadmin-integration skill and update README, CLAUDE.md, docs
(index, getting-started, architecture), and ROADMAP counts and tables
(10 skills, 10 MCP tools). Extend the CI py_compile list.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CLAUDE.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Project documentation for Claude Code and AI assistants working on this reposito
6
6
7
7
## Project Overview
8
8
9
-
CFX Developer Tools is a Cursor IDE plugin for FiveM and RedM (CFX) resource development. It includes 9 skills, 6 rules, 24 code snippets, 11 starter templates, and a companion Python MCP server with 6 tools for resource scaffolding, native lookup, manifest generation, framework detection, and live doc and event search.
9
+
CFX Developer Tools is a Cursor IDE plugin for FiveM and RedM (CFX) resource development. It includes 10 skills, 6 rules, 24 code snippets, 11 starter templates, and a companion Python MCP server with 10 tools for resource scaffolding, native lookup, manifest generation, framework detection, live doc and event search, and txAdmin server control.
10
10
11
11
**Works with:** Cursor (plugin), Claude Code (terminal and in-editor), and any MCP-compatible client.
12
12
@@ -40,7 +40,7 @@ CFX-Developer-Tools/
40
40
workflows/ # CI / release / native-update / docs-index automation
41
41
```
42
42
43
-
## Skills (9)
43
+
## Skills (10)
44
44
45
45
| Skill | Description |
46
46
|-------|-------------|
@@ -53,6 +53,7 @@ CFX-Developer-Tools/
53
53
|`nui-development`| NUI lifecycle, message routing, asset loading, callbacks, and Vite / Svelte integration |
|`state-bags`| StateBag CRUD, replicated vs local, change handlers, and replacement of legacy SetX patterns |
56
+
|`txadmin-integration`| Control a running server, manage resources, search players, and kick players through the txAdmin API |
56
57
57
58
## Rules (6)
58
59
@@ -65,9 +66,9 @@ CFX-Developer-Tools/
65
66
|`security-best-practices.mdc`| Global | Flag hardcoded API keys, server-trust violations, unsafe NUI callbacks, missing input validation |
66
67
|`performance-rules.mdc`| CFX resource files | Flag thread blockers, unbounded loops, missing `Wait()` in `CreateThread`, expensive natives in tight loops |
67
68
68
-
## MCP Server (6 tools)
69
+
## MCP Server (10 tools)
69
70
70
-
The companion MCP server is Python-based (FastMCP). It exposes CFX-aware tools that read from local data files (`mcp-server/data/`) and the working tree.
71
+
The companion MCP server is Python-based (FastMCP). It exposes CFX-aware tools that read from local data files (`mcp-server/data/`) and the working tree. The txAdmin tools additionally talk to a running txAdmin panel over HTTP, using credentials from the `TXADMIN_URL` / `TXADMIN_USERNAME` / `TXADMIN_PASSWORD` environment variables.
71
72
72
73
| Tool | Description |
73
74
|------|-------------|
@@ -77,6 +78,10 @@ The companion MCP server is Python-based (FastMCP). It exposes CFX-aware tools t
77
78
|`search_events_tool`| Search the indexed CFX events database for canonical net-event and exports usage patterns |
78
79
|`detect_framework_tool`| Detect ESX / QBCore / Qbox / ox_core / VORP / RSG / standalone from a workspace path |
79
80
|`search_docs_tool`| Search the indexed `docs.fivem.net` snapshot for parameters, gotchas, and code samples |
81
+
|`txadmin_server_control_tool`| Start, stop, or restart the FXServer through a running txAdmin panel |
82
+
|`txadmin_resource_control_tool`| Start, stop, restart, or ensure a single resource through txAdmin |
83
+
|`txadmin_player_search_tool`| Search players known to the server by name, notes, or identifier through txAdmin |
84
+
|`txadmin_kick_player_tool`| Kick an online player by netid through txAdmin |
Scaffold complete FiveM/RedM resources, look up native functions, generate manifests, detect frameworks, search documentation, and write optimized scripts in Lua, JavaScript, and C# -- all from within Cursor's AI chat. Covers the full CFX development lifecycle from project setup to database integration.
Copy file name to clipboardExpand all lines: docs/ARCHITECTURE.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,6 +66,12 @@ Cursor AI Agent --(MCP protocol)--> MCP Server --(reads)--> Data Files
66
66
|`search_events_tool`| Searches 101 events by name, side, game, or framework |
67
67
|`detect_framework_tool`| Scans workspace files to detect ESX, QBCore, Qbox, ox_core, VORP, RSG, or standalone |
68
68
|`search_docs_tool`| Searches the FiveM/RedM documentation index by keyword or section |
69
+
|`txadmin_server_control_tool`| Starts, stops, or restarts the FXServer through a running txAdmin panel |
70
+
|`txadmin_resource_control_tool`| Starts, stops, restarts, or ensures a single resource through txAdmin |
71
+
|`txadmin_player_search_tool`| Searches players by name, notes, or identifier through txAdmin |
72
+
|`txadmin_kick_player_tool`| Kicks an online player by netid through txAdmin |
73
+
74
+
The four txAdmin tools talk to a running txAdmin panel over HTTP, authenticating with credentials from the `TXADMIN_URL` / `TXADMIN_USERNAME` / `TXADMIN_PASSWORD` environment variables.
Copy file name to clipboardExpand all lines: docs/GETTING-STARTED.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ This guide takes you from zero to building FiveM/RedM resources with AI assistan
26
26
- Generate a correct `fxmanifest.lua` with all the right directives
27
27
- Write code that follows FiveM/RedM best practices automatically
28
28
29
-
The plugin includes **9 skills**, **6 rules**, **24 code snippets**, **11 starter templates**, and **6 MCP tools** (including a searchable database of 12,000+ native functions, 101 events, and documentation search).
29
+
The plugin includes **10 skills**, **6 rules**, **24 code snippets**, **11 starter templates**, and **10 MCP tools** (including a searchable database of 12,000+ native functions, 101 events, documentation search, and txAdmin server control).
30
30
31
31
<details>
32
32
<summary><strong>What is Cursor?</strong></summary>
@@ -203,7 +203,7 @@ You may see a prompt asking you to **trust the workspace**. Click **Yes, I trust
203
203
When you open the folder, Cursor:
204
204
205
205
- Reads `.cursor-plugin/plugin.json` and registers the plugin
206
-
- Makes the 9 skills available to the AI assistant
206
+
- Makes the 10 skills available to the AI assistant
207
207
- Activates the 6 coding rules based on file types you open
208
208
- Loads the MCP server configuration from `.cursor/mcp.json`
0 commit comments