# FiveM Documentation MCP Server
A FastMCP server providing documentation lookup for FiveM development with QBCore and ox framework.
## Features
- **lookup_native** - Search GTA V native functions
- **lookup_qb_event** - Search QBCore events and functions
- **lookup_ox_export** - Search ox_lib exports
- **search_docs** - Full-text search across all documentation
- **get_fxmanifest** - Generate resource templates
## Installation
### Local Development
```bash
# Install dependencies
pip install -r requirements.txt
# Run locally (stdio transport)
python server.py
# Run with SSE transport (for web)
python -c "from server import mcp; mcp.run(transport='sse')"
```
### Deploy to FastMCP Cloud
1. Install FastMCP CLI:
```bash
pip install fastmcp
```
2. Deploy:
```bash
fastmcp deploy server.py --name fivem-docs
```
### Docker Deployment
```bash
# Build
docker build -t mcp-fivem-docs .
# Run
docker run -p 8000:8000 mcp-fivem-docs
```
## Connect to Claude Code
### Option 1: FastMCP Cloud (Recommended)
After deploying to FastMCP Cloud, add to your `.mcp.json`:
```json
{
"mcpServers": {
"fivem-docs": {
"url": "https://your-server.fastmcp.io/sse"
}
}
}
```
### Option 2: Local SSE Server
Run the server locally with SSE transport, then:
```json
{
"mcpServers": {
"fivem-docs": {
"url": "http://localhost:8000/sse"
}
}
}
```
### Option 3: Local STDIO
```json
{
"mcpServers": {
"fivem-docs": {
"command": "python",
"args": ["C:\\path\\to\\server.py"]
}
}
}
```
## Usage Examples
Once connected, you can ask Claude:
- "Look up the GetPlayerPed native"
- "Find QBCore player loaded event"
- "Search ox_lib for notifications"
- "Generate fxmanifest for a new qbcore script"
- "How do I use callbacks in QBCore?"
## Tools Reference
### lookup_native
```
query: string (required) - Native name or keyword
category: string (optional) - PLAYER, VEHICLE, PED, ENTITY, etc.
```
### lookup_qb_event
```
query: string (required) - Event name or keyword
side: string (optional) - 'client', 'server', or 'both'
```
### lookup_ox_export
```
query: string (required) - Export name or keyword
module: string (optional) - 'interface', 'callback', 'cache', etc.
```
### search_docs
```
query: string (required) - Search query
source: string (optional) - 'all', 'natives', 'qbcore', 'ox', 'fivem'
```
### get_fxmanifest
```
name: string (required) - Resource name
framework: string (optional) - 'qbcore', 'ox', 'standalone'
has_ui: boolean (optional) - Include NUI files
use_ox_lib: boolean (optional) - Include ox_lib dependency
```
## License
MIT
