fx-natives-mcp
v1.0.0
Published
MCP server for searching and retrieving CFX/FiveM/RedM native method documentation
Maintainers
Readme
FX Natives MCP
Disclaimer: This project is not affiliated with, endorsed by, or associated with Cfx.re, Rockstar Games, or Take-Two Interactive.
An MCP (Model Context Protocol) server that provides AI assistants with access to CFX/FiveM/RedM native method documentation. Get accurate, up-to-date native function signatures and documentation directly in your AI-powered development workflow.
Installation
Using npx
Add to your MCP client configuration:
{
"mcpServers": {
"fx-natives": {
"command": "npx",
"args": ["-y", "fx-natives-mcp"]
}
}
}Using Bun (Recommended)
{
"mcpServers": {
"fx-natives": {
"command": "bunx",
"args": ["fx-natives-mcp"]
}
}
}Global Installation
npm install -g fx-natives-mcpThen add to your MCP configuration:
{
"mcpServers": {
"fx-natives": {
"command": "fx-natives-mcp"
}
}
}Configuration by Editor
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"fx-natives": {
"command": "npx",
"args": ["-y", "fx-natives-mcp"]
}
}
}Run the following command:
claude mcp add fx-natives -- npx -y fx-natives-mcpOr add to your .claude/settings.json:
{
"mcpServers": {
"fx-natives": {
"command": "npx",
"args": ["-y", "fx-natives-mcp"]
}
}
}Add to your Cursor MCP settings:
{
"mcpServers": {
"fx-natives": {
"command": "npx",
"args": ["-y", "fx-natives-mcp"]
}
}
}Add to your VS Code settings JSON:
{
"mcp": {
"servers": {
"fx-natives": {
"command": "npx",
"args": ["-y", "fx-natives-mcp"]
}
}
}
}Available Tools
search-native
Search for native methods using fuzzy matching.
Parameters:
query(string) - Search query for native methodpage(number, optional) - Page number for paginated results (default: 1)
Example:
Search: "get player ped"
Returns: List of matching natives with their hashesget-native-doc
Get detailed documentation for a specific native by name or hash.
Parameters:
hashOrName(string) - Exact native name or hash
Example:
Input: "GET_PLAYER_PED" or "0x275F255ED201B937"
Returns: Full documentation with TypeScript and Lua signaturesDevelopment
# Install dependencies
bun install
# Run in development mode
bun run dev
# Run with MCP Inspector
bun run inspect
# Build for production
bun run build