https://github.com/tmhsdigital/cfx-mcp
MCP server providing agent-callable tools for CFX/FiveM resource development, server management, and community platform integration.
https://github.com/tmhsdigital/cfx-mcp
Last synced: 16 days ago
JSON representation
MCP server providing agent-callable tools for CFX/FiveM resource development, server management, and community platform integration.
- Host: GitHub
- URL: https://github.com/tmhsdigital/cfx-mcp
- Owner: TMHSDigital
- License: other
- Created: 2026-05-24T22:44:00.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-24T23:50:03.000Z (about 2 months ago)
- Last Synced: 2026-05-25T01:12:14.122Z (about 2 months ago)
- Homepage: https://tmhsdigital.github.io/cfx-mcp/
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Roadmap: ROADMAP.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# CFX MCP
**Read-only MCP server for CFX/FiveM development. Three tools, no API key required.**
---
## Tools
### cfx_getNative
Look up a FiveM or RedM native function by exact name, partial name, or hex hash. The full native database (~5 MB) is fetched once from `runtime.fivem.net` and cached in memory for the session.
**Args**
- `query` (string, required) - native name (`GET_ENTITY_COORDS`), partial name (`ENTITY_COORDS`), or hex hash (`0x3FEF770D40960D5A`). Partial matches return up to 20 results.
**Example**
```json
{ "query": "GET_ENTITY_COORDS" }
```
---
### cfx_queryServer
Inspect a live FiveM server's public HTTP endpoints. Fetches `/info.json` and `/players.json` from the server. Times out after 5 seconds per endpoint.
**Args**
- `host` (string, required) - server IP or hostname (`127.0.0.1`, `play.example.com`). No URL scheme or port here.
- `port` (number, optional, default `30120`) - server port.
**Example**
```json
{ "host": "play.example.com", "port": 30120 }
```
---
### cfx_searchReleases
Search the cfx.re community releases forum via the public Discourse search API.
**Args**
- `query` (string, required) - search terms (`vehicle spawn menu`, `esx banking`, `vrp framework`).
- `limit` (number, optional, default `10`, max `20`) - number of results.
**Example**
```json
{ "query": "esx framework", "limit": 5 }
```
---
## Running as an MCP server
```bash
npm install -g @tmhsdigital/cfx-mcp
cfx-mcp
```
Or run from source:
```bash
npm ci
npm run build
node dist/index.js
```
Add to your MCP client config (Claude Desktop, Cursor, etc.):
```json
{
"mcpServers": {
"cfx-mcp": {
"command": "cfx-mcp"
}
}
}
```
## Notes
- All three tools are read-only. No credentials or API keys are required.
- `cfx_queryServer` validates the `host` parameter to prevent arbitrary URL access. Supply a plain IP or hostname only.
- The native database is cached per process. Restart the server to force a refresh.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## License
CC-BY-NC-ND-4.0 -- see [LICENSE](LICENSE) for details.
---
**Built by TMHSDigital**