Refactor documentation layout and styling

- Removed the old layout file `layout.blade.php` and created a new layout structure in `layouts/app.blade.php`.
- Introduced partial views for navigation and footer in `layouts/partials/navigation.blade.php` and `layouts/partials/footer.blade.php`.
- Updated the `quickstart.blade.php` to extend the new layout and utilize the new partials.
- Enhanced the styling with dark mode support and improved color themes in `vite.config.js`.
This commit is contained in:
Adrian Mejias committed 2026-03-01 17:47:48 -06:00
1 parent 686b41e406
commit f6da6705db
10 files changed
+947 -887

No files matched your search

+10 -57
View File
@@ -8,64 +8,17 @@
@theme {
--font-sans: 'Instrument Sans', ui-sans-serif, system-ui, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji',
'Segoe UI Symbol', 'Noto Color Emoji';
}
.tab-button {
transition: all 0.2s ease-in-out;
}
--animate-fade-in: fade-in 0.3s ease-in-out;
.tab-content {
animation: fadeIn 0.3s ease-in-out;
}
@keyframes fadeIn {
from {
opacity: 0;
transform: translateY(10px);
}
to {
opacity: 1;
transform: translateY(0);
@keyframes fade-in {
from {
opacity: 0;
transform: translateY(10px);
}
to {
opacity: 1;
transform: translateY(0);
}
}
}
.code-block-wrapper {
position: relative;
}
.copy-button {
position: absolute;
top: 0.5rem;
right: 0.5rem;
padding: 0.375rem 0.75rem;
background-color: rgba(55, 65, 81, 0.8);
color: white;
border: 1px solid rgba(255, 255, 255, 0.2);
border-radius: 0.375rem;
font-size: 0.75rem;
font-weight: 500;
cursor: pointer;
opacity: 0;
transition: all 0.2s ease-in-out;
display: flex;
align-items: center;
gap: 0.25rem;
}
.code-block-wrapper:hover .copy-button {
opacity: 1;
}
.copy-button:hover {
background-color: rgba(55, 65, 81, 1);
}
.copy-button.copied {
background-color: rgba(16, 185, 129, 0.9);
border-color: rgba(16, 185, 129, 1);
}
.copy-button svg {
width: 1rem;
height: 1rem;
}
+42 -7
View File
@@ -4,16 +4,16 @@ document.addEventListener('DOMContentLoaded', () => {
const codeBlocks = document.querySelectorAll('pre');
codeBlocks.forEach((pre) => {
if (!pre.parentElement.classList.contains('code-block-wrapper')) {
if (!pre.parentElement.classList.contains('relative')) {
const wrapper = document.createElement('div');
wrapper.className = 'code-block-wrapper';
wrapper.className = 'relative group';
pre.parentNode.insertBefore(wrapper, pre);
wrapper.appendChild(pre);
}
const wrapper = pre.parentElement;
const copyButton = document.createElement('button');
copyButton.className = 'copy-button';
copyButton.className = 'absolute top-2 right-2 px-3 py-1.5 bg-gray-700/80 text-white border border-white/20 rounded-md text-xs font-medium cursor-pointer opacity-0 group-hover:opacity-100 transition-all duration-200 ease-in-out flex items-center gap-1 hover:bg-gray-700';
copyButton.innerHTML = `<svg class="copy-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg> <span class="copy-text">Copy</span>`;
copyButton.addEventListener('click', () => {
@@ -21,12 +21,14 @@ document.addEventListener('DOMContentLoaded', () => {
const text = code ? code.textContent : pre.textContent;
navigator.clipboard.writeText(text).then(() => {
copyButton.classList.add('copied');
copyButton.innerHTML = `<svg fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 13l4 4L19 7"></path></svg> <span>Copied!</span>`;
copyButton.classList.remove('bg-gray-700/80', 'border-white/20', 'hover:bg-gray-700');
copyButton.classList.add('!bg-emerald-500/90', 'border-emerald-500');
copyButton.innerHTML = `<svg class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 13l4 4L19 7"></path></svg> <span>Copied!</span>`;
setTimeout(() => {
copyButton.classList.remove('copied');
copyButton.innerHTML = `<svg class="copy-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg><span class="copy-text">Copy</span>`;
copyButton.classList.add('bg-gray-700/80', 'border-white/20', 'hover:bg-gray-700');
copyButton.classList.remove('!bg-emerald-500/90', 'border-emerald-500');
copyButton.innerHTML = `<svg class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z"></path></svg><span class="copy-text">Copy</span>`;
}, 2000);
}).catch((err) => {
console.error('Failed to copy:', err);
@@ -35,4 +37,37 @@ document.addEventListener('DOMContentLoaded', () => {
wrapper.appendChild(copyButton);
});
// Tab switching functionality
const tabButtons = document.querySelectorAll('[data-tab]');
const tabContents = document.querySelectorAll('[data-tab-content]');
tabButtons.forEach(button => {
button.addEventListener('click', function () {
const targetTab = this.dataset.tab;
// Remove active class from all buttons
tabButtons.forEach(btn => {
btn.classList.remove('active', 'border-indigo-500', 'text-indigo-600', 'dark:text-indigo-400');
btn.classList.add('border-transparent', 'text-gray-500', 'dark:text-gray-400');
});
// Add active class to clicked button
this.classList.remove('border-transparent', 'text-gray-500', 'dark:text-gray-400');
this.classList.add('active', 'border-indigo-500', 'text-indigo-600', 'dark:text-indigo-400');
// Hide all tab contents
tabContents.forEach(content => {
content.classList.add('hidden');
content.classList.remove('active');
});
// Show target tab content
const targetContent = document.querySelector(`[data-tab-content="${targetTab}"]`);
if (targetContent) {
targetContent.classList.remove('hidden');
targetContent.classList.add('active');
}
});
});
});
+227 -215
View File
@@ -1,41 +1,38 @@
@extends('docs.layout')
@extends('layouts.app')
@section('title', 'Full Documentation - FiveM MCP Server')
@section('content')
<div class="max-w-5xl mx-auto py-12 px-4 sm:px-6 lg:px-8">
<div class="bg-white shadow rounded-lg p-8">
<h1 class="text-3xl font-extrabold text-gray-900 mb-6">FiveM Development MCP Server</h1>
<div class="bg-white dark:bg-gray-800 shadow rounded-lg p-8">
<h1 class="text-3xl font-extrabold text-gray-900 dark:text-white mb-6">FiveM Development MCP Server</h1>
<p class="text-lg text-gray-700 mb-8">
<p class="text-lg text-gray-700 dark:text-gray-300 mb-8">
A comprehensive Model Context Protocol (MCP) server for FiveM (GTA5) development, built with Laravel MCP.
This server provides AI assistants with powerful tools to help you develop FiveM resources more efficiently.
</p>
<!-- Installation -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Installation & Connection</h2>
<p class="text-gray-700 mb-6">Choose how you want to connect to the FiveM MCP server:</p>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Installation & Connection</h2>
<p class="text-gray-700 dark:text-gray-300 mb-6">Choose how you want to connect to the FiveM MCP server:</p>
<!-- Tab Buttons -->
<div class="border-b border-gray-200 mb-6">
<div class="border-b border-gray-200 dark:border-gray-700 mb-6">
<nav class="-mb-px flex space-x-8">
<button
data-tab="remote"
class="tab-button active border-b-2 border-indigo-500 py-4 px-1 text-center text-sm font-medium text-indigo-600"
>
<button data-tab="remote"
class="transition-all duration-200 ease-in-out active border-b-2 border-indigo-500 py-4 px-1 text-center text-sm font-medium text-indigo-600 dark:text-indigo-400">
<span class="flex items-center">
<span class="mr-2">🌐</span>
Remote Server
<span class="ml-2 inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium bg-indigo-100 text-indigo-800">
<span
class="ml-2 inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium bg-indigo-100 dark:bg-indigo-900 text-indigo-800 dark:text-indigo-200">
Recommended
</span>
</span>
</button>
<button
data-tab="local"
class="tab-button border-b-2 border-transparent py-4 px-1 text-center text-sm font-medium text-gray-500 hover:text-gray-700 hover:border-gray-300"
>
<button data-tab="local"
class="transition-all duration-200 ease-in-out border-b-2 border-transparent py-4 px-1 text-center text-sm font-medium text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 hover:border-gray-300 dark:hover:border-gray-600">
<span class="flex items-center">
<span class="mr-2">💻</span>
Local Installation
@@ -47,115 +44,139 @@
<!-- Tab Content Container -->
<div class="tab-content-container">
<!-- Remote Server Option -->
<div data-tab-content="remote" class="tab-content active">
<div class="bg-indigo-50 border-l-4 border-indigo-500 p-6">
<p class="text-gray-700 mb-4">
<strong>Easy setup!</strong> Connect to a hosted MCP server. This is the easiest option and works from anywhere without any local setup.
<div data-tab-content="remote" class="animate-fade-in active">
<div class="bg-indigo-50 dark:bg-indigo-900/20 border-l-4 border-indigo-500 p-6">
<p class="text-gray-700 dark:text-gray-300 mb-4">
<strong>Easy setup!</strong> Connect to a hosted MCP server. This is the easiest option and
works from anywhere without any local setup.
</p>
<h4 class="font-semibold text-gray-900 mb-2">Claude Desktop Configuration:</h4>
<p class="text-gray-700 mb-3">Edit your configuration file:</p>
<ul class="list-disc list-inside text-gray-700 mb-3 ml-4">
<li><strong>macOS:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code></li>
<li><strong>Windows:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code></li>
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Claude Desktop Configuration:</h4>
<p class="text-gray-700 dark:text-gray-300 mb-3">Edit your configuration file:</p>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 mb-3 ml-4">
<li><strong>macOS:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code>
</li>
<li><strong>Windows:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code>
</li>
</ul>
<p class="text-gray-700 mb-3">Add this configuration (replace with your actual server URL):</p>
<p class="text-gray-700 dark:text-gray-300 mb-3">Add this configuration (replace with your
actual
server URL):</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcpServers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}</code></pre>
"mcpServers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}</code></pre>
</div>
<div class="mt-6">
<h4 class="font-semibold text-gray-900 mb-2">VSCode Configuration (Cline Extension):</h4>
<p class="text-gray-700 mb-3">If using VSCode with the Cline extension, edit your settings:</p>
<ul class="list-disc list-inside text-gray-700 mb-3 ml-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">VSCode Configuration (Cline
Extension):
</h4>
<p class="text-gray-700 dark:text-gray-300 mb-3">If using VSCode with the Cline extension, edit
your
settings:</p>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 mb-3 ml-4">
<li>Open VSCode Settings (JSON)</li>
<li>Add to your global or workspace <code class="bg-gray-100 px-2 py-1 rounded text-sm">settings.json</code></li>
<li>Add to your global or workspace <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">settings.json</code>
</li>
</ul>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}
}</code></pre>
"mcp": {
"servers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}
}</code></pre>
</div>
</div>
<!-- Local Installation Option -->
<div data-tab-content="local" class="tab-content hidden">
<div class="bg-gray-50 border-l-4 border-gray-400 p-6">
<p class="text-gray-700 mb-4">
<strong>Advanced setup.</strong> Run the MCP server on your own machine. Requires PHP and Laravel setup.
<div data-tab-content="local" class="animate-fade-in hidden">
<div class="bg-gray-50 dark:bg-gray-700/20 border-l-4 border-gray-400 dark:border-gray-500 p-6">
<p class="text-gray-700 dark:text-gray-300 mb-4">
<strong>Advanced setup.</strong> Run the MCP server on your own machine. Requires PHP and
Laravel setup.
</p>
<h4 class="font-semibold text-gray-900 mb-2">Claude Desktop Configuration:</h4>
<p class="text-gray-700 mb-3">Edit your configuration file and add:</p>
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Claude Desktop Configuration:</h4>
<p class="text-gray-700 dark:text-gray-300 mb-3">Edit your configuration file and add:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>{
"mcpServers": {
"fivem": {
"command": "/path/to/php",
"args": [
"/path/to/fivem-mcp/artisan",
"mcp:start",
"fivem"
]
}
}
}</code></pre>
"mcpServers": {
"fivem": {
"command": "/path/to/php",
"args": [
"/path/to/fivem-mcp/artisan",
"mcp:start",
"fivem"
]
}
}
}</code></pre>
<h4 class="font-semibold text-gray-900 mb-2">Command Line Usage:</h4>
<p class="text-gray-700 mb-3">For any MCP-compatible client:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>php artisan mcp:start fivem</code></pre>
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Command Line Usage:</h4>
<p class="text-gray-700 dark:text-gray-300 mb-3">For any MCP-compatible client:</p>
<pre
class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>php artisan mcp:start fivem</code></pre>
<h4 class="font-semibold text-gray-900 mb-2 mt-6">VSCode Configuration (Cline Extension):</h4>
<p class="text-gray-700 mb-3">If using VSCode with the Cline extension, add to <code class="bg-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:</p>
<h4 class="font-semibold text-gray-900 dark:text-white mb-2 mt-6">VSCode Configuration (Cline
Extension):</h4>
<p class="text-gray-700 dark:text-gray-300 mb-3">If using VSCode with the Cline extension, add
to
<code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "php",
"args": ["artisan", "mcp:start", "fivem"],
"cwd": "/path/to/fivem-mcp"
}
}
}
}</code></pre>
"mcp": {
"servers": {
"fivem": {
"command": "php",
"args": ["artisan", "mcp:start", "fivem"],
"cwd": "/path/to/fivem-mcp"
}
}
}
}</code></pre>
<p class="text-gray-700 mb-3 mt-4"><strong>Or use the full PHP path:</strong></p>
<p class="text-gray-700 dark:text-gray-300 mb-3 mt-4"><strong>Or use the full PHP path:</strong>
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "/path/to/php",
"args": ["/path/to/fivem-mcp/artisan", "mcp:start", "fivem"]
}
}
}
}</code></pre>
"mcp": {
"servers": {
"fivem": {
"command": "/path/to/php",
"args": ["/path/to/fivem-mcp/artisan", "mcp:start", "fivem"]
}
}
}
}</code></pre>
</div>
</div>
</div>
<div class="bg-blue-50 border-l-4 border-blue-500 p-4 mt-6">
<p class="text-sm text-blue-800">
<strong>💡 Tip:</strong> After configuring Claude Desktop, completely quit and restart the application for changes to take effect.
<div class="bg-blue-50 dark:bg-blue-900/20 border-l-4 border-blue-500 p-4 mt-6">
<p class="text-sm text-blue-800 dark:text-blue-200">
<strong>💡 Tip:</strong> After configuring Claude Desktop, completely quit and restart the
application
for
changes to take effect.
</p>
</div>
</section>
<!-- Available Tools -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-6">Available Tools</h2>
<p class="text-gray-700 mb-6">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-6">Available Tools</h2>
<p class="text-gray-700 dark:text-gray-300 mb-6">
The FiveM MCP Server provides {{ count($tools) }} tools organized by category.
These tools allow AI assistants to search documentation, generate code, and lookup framework functions.
</p>
@@ -166,146 +187,174 @@
@foreach ($groupedTools as $category => $categoryTools)
<div class="mb-8">
<h3 class="text-xl font-bold text-gray-800 mb-4 flex items-center">
<h3 class="text-xl font-bold text-gray-800 dark:text-gray-200 mb-4 flex items-center">
<span class="inline-block w-1 h-6 bg-indigo-500 mr-3"></span>
{{ $category }} Tools
<span class="ml-3 text-sm font-normal text-gray-500">({{ count($categoryTools) }})</span>
<span
class="ml-3 text-sm font-normal text-gray-500 dark:text-gray-400">({{ count($categoryTools) }})</span>
</h3>
@foreach ($categoryTools as $index => $tool)
<div class="mb-6 border-l-4 border-indigo-500 pl-6">
<h4 class="text-lg font-semibold text-gray-900 mb-2">{{ $tool['name'] }}</h4>
<p class="text-gray-700">{{ $tool['description'] }}</p>
<h4 class="text-lg font-semibold text-gray-900 dark:text-white mb-2">{{ $tool['name'] }}</h4>
<p class="text-gray-700 dark:text-gray-300">{{ $tool['description'] }}</p>
</div>
@endforeach
</div>
@endforeach
</section>
</section>
<!-- Available Resources -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-6">Available Resources</h2>
<p class="text-gray-700 mb-6">
MCP Resources provide read-only reference documentation that AI assistants can access.
Currently available: {{ count($resources) }} resources.
</p>
<!-- Available Resources -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-6">Available Resources</h2>
<p class="text-gray-700 dark:text-gray-300 mb-6">
MCP Resources provide read-only reference documentation that AI assistants can access.
Currently available: {{ count($resources) }} resources.
</p>
@forelse ($resources as $index => $resource)
<div class="mb-6 border-l-4 border-green-500 pl-6">
<h3 class="text-lg font-semibold text-gray-900 mb-2">{{ $index + 1 }}. {{ $resource['name'] }}</h3>
<p class="text-gray-700">{{ $resource['description'] }}</p>
</div>
@empty
<p class="text-gray-500 italic">No resources configured.</p>
@endforelse
</section>
@forelse ($resources as $index => $resource)
<div class="mb-6 border-l-4 border-green-500 pl-6">
<h3 class="text-lg font-semibold text-gray-900 dark:text-white mb-2">{{ $index + 1 }}.
{{ $resource['name'] }}
</h3>
<p class="text-gray-700 dark:text-gray-300">{{ $resource['description'] }}</p>
</div>
@empty
<p class="text-gray-500 dark:text-gray-400 italic">No resources configured.</p>
@endforelse
</section>
<!-- Available Prompts -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-6">Available Prompts</h2>
<p class="text-gray-700 mb-6">
MCP Prompts are pre-built prompt templates for common tasks.
Currently available: {{ count($prompts) }} prompts.
</p>
<!-- Available Prompts -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-6">Available Prompts</h2>
<p class="text-gray-700 dark:text-gray-300 mb-6">
MCP Prompts are pre-built prompt templates for common tasks.
Currently available: {{ count($prompts) }} prompts.
</p>
@forelse ($prompts as $index => $prompt)
<div class="mb-6 border-l-4 border-purple-500 pl-6">
<h3 class="text-lg font-semibold text-gray-900 mb-2">{{ $index + 1 }}. {{ $prompt['name'] }}</h3>
<p class="text-gray-700">{{ $prompt['description'] }}</p>
</div>
@empty
<p class="text-gray-500 italic">No prompts configured.</p>
@endforelse
@forelse ($prompts as $index => $prompt)
<div class="mb-6 border-l-4 border-purple-500 pl-6">
<h3 class="text-lg font-semibold text-gray-900 dark:text-white mb-2">{{ $index + 1 }}.
{{ $prompt['name'] }}
</h3>
<p class="text-gray-700 dark:text-gray-300">{{ $prompt['description'] }}</p>
</div>
@empty
<p class="text-gray-500 dark:text-gray-400 italic">No prompts configured.</p>
@endforelse
</section>
<!-- Testing -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Testing the Server</h2>
<p class="text-gray-700 mb-4">You can test the MCP server locally using the inspector:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>php artisan mcp:inspector fivem</code></pre>
<p class="text-gray-600 text-sm mt-2">This will open the MCP Inspector in your browser where you can test all the tools interactively.</p>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Testing the Server</h2>
<p class="text-gray-700 dark:text-gray-300 mb-4">You can test the MCP server locally using the inspector:
</p>
<pre
class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>php artisan mcp:inspector fivem</code></pre>
<p class="text-gray-600 dark:text-gray-400 text-sm mt-2">This will open the MCP Inspector in your browser
where
you
can test all the tools interactively.</p>
</section>
<!-- Development -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Development</h2>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Development</h2>
<h3 class="text-xl font-semibold text-gray-900 mb-3">Adding New Tools</h3>
<p class="text-gray-700 mb-4">1. Create a new tool class in <code class="bg-gray-100 px-2 py-1 rounded text-sm">app/Mcp/Tools/</code>:</p>
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">Adding New Tools</h3>
<p class="text-gray-700 dark:text-gray-300 mb-4">1. Create a new tool class in <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">app/Mcp/Tools/</code>:
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>&lt;?php
namespace App\Mcp\Tools;
namespace App\Mcp\Tools;
use Illuminate\Contracts\JsonSchema\JsonSchema;
use Laravel\Mcp\Request;
use Laravel\Mcp\Response;
use Laravel\Mcp\Server\Attributes\Description;
use Laravel\Mcp\Server\Tool;
use Illuminate\Contracts\JsonSchema\JsonSchema;
use Laravel\Mcp\Request;
use Laravel\Mcp\Response;
use Laravel\Mcp\Server\Attributes\Description;
use Laravel\Mcp\Server\Tool;
#[Description('Your tool description')]
class YourTool extends Tool
{
public function handle(Request $request): Response
{
// Tool logic here
return Response::text('Result');
}
#[Description('Your tool description')]
class YourTool extends Tool
{
public function handle(Request $request): Response
{
// Tool logic here
return Response::text('Result');
}
public function schema(JsonSchema $schema): array
{
return [
'param' => $schema->string()->required(),
];
}
}</code></pre>
public function schema(JsonSchema $schema): array
{
return [
'param' => $schema->string()->required(),
];
}
}</code></pre>
<p class="text-gray-700 mb-4">2. Register the tool in <code class="bg-gray-100 px-2 py-1 rounded text-sm">app/Mcp/Servers/FiveMServer.php</code>:</p>
<p class="text-gray-700 dark:text-gray-300 mb-4">2. Register the tool in <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">app/Mcp/Servers/FiveMServer.php</code>:
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>protected array $tools = [
// ... existing tools
\App\Mcp\Tools\YourTool::class,
];</code></pre>
// ... existing tools
\App\Mcp\Tools\YourTool::class,
];</code></pre>
<h3 class="text-xl font-semibold text-gray-900 mb-3 mt-6">Code Formatting</h3>
<p class="text-gray-700 mb-4">Format code with Laravel Pint:</p>
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3 mt-6">Code Formatting</h3>
<p class="text-gray-700 dark:text-gray-300 mb-4">Format code with Laravel Pint:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>vendor/bin/pint</code></pre>
</section>
<!-- Frameworks & Languages -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Supported Frameworks</h2>
<ul class="list-disc list-inside text-gray-700 space-y-2 ml-4">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Supported Frameworks</h2>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li><strong>Standalone:</strong> Basic FiveM resources without framework dependencies</li>
<li><strong>ESX:</strong> ESX Framework (es_extended)</li>
<li><strong>QBCore:</strong> QBCore Framework (qb-core)</li>
</ul>
<h2 class="text-2xl font-bold text-gray-900 mb-4 mt-6">Scripting Languages</h2>
<p class="text-gray-700">Both Lua and JavaScript are fully supported across all tools and generators.</p>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4 mt-6">Scripting Languages</h2>
<p class="text-gray-700 dark:text-gray-300">Both Lua and JavaScript are fully supported across all tools and
generators.</p>
</section>
<!-- Resources -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Resources</h2>
<ul class="list-disc list-inside text-gray-700 space-y-2 ml-4">
<li><a href="https://docs.fivem.net/docs/" class="text-indigo-600 hover:text-indigo-500">FiveM Documentation</a></li>
<li><a href="https://docs.fivem.net/natives/" class="text-indigo-600 hover:text-indigo-500">FiveM Natives Reference</a></li>
<li><a href="https://coxdocs.dev/" class="text-indigo-600 hover:text-indigo-500">COX MySQL Documentation</a> - Required
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Resources</h2>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li><a href="https://docs.fivem.net/docs/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM
Documentation</a></li>
<li><a href="https://docs.fivem.net/natives/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM
Natives Reference</a></li>
<li><a href="https://coxdocs.dev/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">COX
MySQL
Documentation</a> - Required
for database operations</li>
<li><a href="https://docs.qbcore.org/" class="text-indigo-600 hover:text-indigo-500">QBCore Documentation</a></li>
<li><a href="https://laravel.com/docs/mcp" class="text-indigo-600 hover:text-indigo-500">Laravel MCP Documentation</a></li>
<li><a href="https://modelcontextprotocol.io/" class="text-indigo-600 hover:text-indigo-500">Model Context Protocol</a></li>
<li><a href="https://docs.qbcore.org/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">QBCore
Documentation</a></li>
<li><a href="https://laravel.com/docs/mcp"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Laravel
MCP Documentation</a></li>
<li><a href="https://modelcontextprotocol.io/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Model
Context Protocol</a></li>
</ul>
</section>
<!-- Contributing -->
<section class="mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Contributing</h2>
<p class="text-gray-700 mb-4">Contributions are welcome! Areas for expansion:</p>
<ul class="list-disc list-inside text-gray-700 space-y-2 ml-4">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Contributing</h2>
<p class="text-gray-700 dark:text-gray-300 mb-4">Contributions are welcome! Areas for expansion:</p>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li>More native functions in the database</li>
<li>Additional framework support (vRP, etc.)</li>
<li>More event types</li>
@@ -316,46 +365,9 @@
<!-- License -->
<section>
<h2 class="text-2xl font-bold text-gray-900 mb-4">License</h2>
<p class="text-gray-700">MIT License</p>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">License</h2>
<p class="text-gray-700 dark:text-gray-300">MIT License</p>
</section>
</div>
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const tabButtons = document.querySelectorAll('.tab-button');
const tabContents = document.querySelectorAll('.tab-content');
tabButtons.forEach(button => {
button.addEventListener('click', function() {
const targetTab = this.dataset.tab;
// Remove active class from all buttons
tabButtons.forEach(btn => {
btn.classList.remove('active', 'border-indigo-500', 'text-indigo-600');
btn.classList.add('border-transparent', 'text-gray-500');
});
// Add active class to clicked button
this.classList.remove('border-transparent', 'text-gray-500');
this.classList.add('active', 'border-indigo-500', 'text-indigo-600');
// Hide all tab contents
tabContents.forEach(content => {
content.classList.add('hidden');
content.classList.remove('active');
});
// Show target tab content
const targetContent = document.querySelector(`[data-tab-content="${targetTab}"]`);
if (targetContent) {
targetContent.classList.remove('hidden');
targetContent.classList.add('active');
}
});
});
});
</script>
@endsection
+217 -193
View File
@@ -1,213 +1,237 @@
@extends('docs.layout')
@extends('layouts.app')
@section('title', 'FiveM MCP Server')
@section('content')
<div class="max-w-7xl mx-auto py-12 px-4 sm:px-6 lg:px-8">
<!-- Hero Section -->
<div class="text-center mb-12">
<h1 class="text-4xl font-extrabold text-gray-900 sm:text-5xl sm:tracking-tight lg:text-6xl">
FiveM Development MCP Server
</h1>
<p class="mt-5 max-w-xl mx-auto text-xl text-gray-500">
A comprehensive Model Context Protocol server for FiveM development with 5 tools, 3 resources, and 5 prompts.
</p>
</div>
<div class="max-w-7xl mx-auto py-12 px-4 sm:px-6 lg:px-8">
<!-- Hero Section -->
<div class="text-center mb-12">
<h1 class="text-4xl font-extrabold text-gray-900 dark:text-white sm:text-5xl sm:tracking-tight lg:text-6xl">
FiveM Development MCP Server
</h1>
<p class="mt-5 max-w-xl mx-auto text-xl text-gray-500 dark:text-gray-400">
A comprehensive Model Context Protocol server for FiveM development with 5 tools, 3 resources, and 5 prompts.
</p>
</div>
<!-- Features Grid -->
<div class="mt-12">
<h2 class="text-3xl font-extrabold text-gray-900 mb-8">Features</h2>
<div class="grid grid-cols-1 gap-8 sm:grid-cols-2 lg:grid-cols-3">
<!-- Documentation Search -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Documentation Search</h3>
<!-- Features Grid -->
<div class="mt-12">
<h2 class="text-3xl font-extrabold text-gray-900 dark:text-white mb-8">Features</h2>
<div class="grid grid-cols-1 gap-8 sm:grid-cols-2 lg:grid-cols-3">
<!-- Documentation Search -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Documentation Search</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Search FiveM documentation by topic and category. Get direct links to relevant documentation.
</p>
</div>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Search FiveM documentation by topic and category. Get direct links to relevant documentation.
<!-- Native Functions -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M10 20l4-16m4 4l4 4-4 4M6 16l-4-4 4-4"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Native Functions</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Look up GTA5/FiveM native functions with signatures, parameters, and code examples.
</p>
</div>
</div>
</div>
<!-- Manifest Generator -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M9 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z">
</path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Manifest Generator</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Generate fxmanifest.lua files automatically for any framework and scripting language.
</p>
</div>
</div>
</div>
<!-- Event Reference -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M13 10V3L4 14h7v7l9-11h-7z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Event Reference</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Complete database of FiveM events including core, ESX, and QBCore events with examples.
</p>
</div>
</div>
</div>
<!-- Boilerplate Generator -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M4 5a1 1 0 011-1h14a1 1 0 011 1v2a1 1 0 01-1 1H5a1 1 0 01-1-1V5zM4 13a1 1 0 011-1h6a1 1 0 011 1v6a1 1 0 01-1 1H5a1 1 0 01-1-1v-6zM16 13a1 1 0 011-1h2a1 1 0 011 1v6a1 1 0 01-1 1h-2a1 1 0 01-1-1v-6z">
</path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Boilerplate Generator</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Generate complete resource structures with client, server, config, and optional NUI files.
</p>
</div>
</div>
</div>
<!-- Framework Support -->
<div class="bg-white dark:bg-gray-800 overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
d="M9 3v2m6-2v2M9 19v2m6-2v2M5 9H3m2 6H3m18-6h-2m2 6h-2M7 19h10a2 2 0 002-2V7a2 2 0 00-2-2H7a2 2 0 00-2 2v10a2 2 0 002 2zM9 9h6v6H9V9z">
</path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900 dark:text-white">Framework Support</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500 dark:text-gray-400">
Full support for Standalone, ESX, and QBCore frameworks in both Lua and JavaScript.
</p>
</div>
</div>
</div>
</div>
</div>
<!-- Quick Actions -->
<div class="mt-16 bg-indigo-700 dark:bg-indigo-900 rounded-lg shadow-xl overflow-hidden">
<div class="px-6 py-12 sm:px-12">
<div class="text-center">
<h2 class="text-3xl font-extrabold text-white">Ready to get started?</h2>
<p class="mt-4 text-lg text-indigo-100 dark:text-indigo-200">
Set up the MCP server in just 5 minutes with our quick start guide.
</p>
<div class="mt-8 flex justify-center space-x-4">
<a href="{{ route('docs.quickstart') }}"
class="inline-flex items-center px-6 py-3 border border-transparent text-base font-medium rounded-md text-indigo-700 bg-white hover:bg-indigo-50 dark:text-indigo-900 dark:bg-white dark:hover:bg-gray-100">
Quick Start Guide
</a>
<a href="{{ route('docs.documentation') }}"
class="inline-flex items-center px-6 py-3 border border-transparent text-base font-medium rounded-md text-white bg-indigo-500 hover:bg-indigo-600 dark:bg-indigo-600 dark:hover:bg-indigo-700">
Full Documentation
</a>
</div>
</div>
</div>
</div>
<!-- Native Functions -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M10 20l4-16m4 4l4 4-4 4M6 16l-4-4 4-4"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Native Functions</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Look up GTA5/FiveM native functions with signatures, parameters, and code examples.
<!-- Resources -->
<div class="mt-16">
<h2 class="text-3xl font-extrabold text-gray-900 dark:text-white mb-8">Resources</h2>
<div class="grid grid-cols-1 gap-6 sm:grid-cols-2">
<div class="bg-white dark:bg-gray-800 shadow rounded-lg p-6">
<h3 class="text-lg font-medium text-gray-900 dark:text-white mb-4">MCP Server Configuration</h3>
<p class="text-sm text-gray-500 dark:text-gray-400 mb-4">
To connect to the FiveM MCP server, use the following configuration in your MCP client:
</p>
</div>
</div>
</div>
<!-- Manifest Generator -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Manifest Generator</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Generate fxmanifest.lua files automatically for any framework and scripting language.
</p>
</div>
</div>
</div>
<!-- Event Reference -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13 10V3L4 14h7v7l9-11h-7z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Event Reference</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Complete database of FiveM events including core, ESX, and QBCore events with examples.
</p>
</div>
</div>
</div>
<!-- Boilerplate Generator -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 5a1 1 0 011-1h14a1 1 0 011 1v2a1 1 0 01-1 1H5a1 1 0 01-1-1V5zM4 13a1 1 0 011-1h6a1 1 0 011 1v6a1 1 0 01-1 1H5a1 1 0 01-1-1v-6zM16 13a1 1 0 011-1h2a1 1 0 011 1v6a1 1 0 01-1 1h-2a1 1 0 01-1-1v-6z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Boilerplate Generator</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Generate complete resource structures with client, server, config, and optional NUI files.
</p>
</div>
</div>
</div>
<!-- Framework Support -->
<div class="bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<div class="flex items-center">
<div class="shrink-0 bg-indigo-500 rounded-md p-3">
<svg class="h-6 w-6 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 3v2m6-2v2M9 19v2m6-2v2M5 9H3m2 6H3m18-6h-2m2 6h-2M7 19h10a2 2 0 002-2V7a2 2 0 00-2-2H7a2 2 0 00-2 2v10a2 2 0 002 2zM9 9h6v6H9V9z"></path>
</svg>
</div>
<div class="ml-5">
<h3 class="text-lg font-medium text-gray-900">Framework Support</h3>
</div>
</div>
<div class="mt-4">
<p class="text-sm text-gray-500">
Full support for Standalone, ESX, and QBCore frameworks in both Lua and JavaScript.
</p>
</div>
</div>
</div>
</div>
</div>
<!-- Quick Actions -->
<div class="mt-16 bg-indigo-700 rounded-lg shadow-xl overflow-hidden">
<div class="px-6 py-12 sm:px-12">
<div class="text-center">
<h2 class="text-3xl font-extrabold text-white">Ready to get started?</h2>
<p class="mt-4 text-lg text-indigo-100">
Set up the MCP server in just 5 minutes with our quick start guide.
</p>
<div class="mt-8 flex justify-center space-x-4">
<a href="{{ route('docs.quickstart') }}" class="inline-flex items-center px-6 py-3 border border-transparent text-base font-medium rounded-md text-indigo-700 bg-white hover:bg-indigo-50">
Quick Start Guide
</a>
<a href="{{ route('docs.documentation') }}" class="inline-flex items-center px-6 py-3 border border-transparent text-base font-medium rounded-md text-white bg-indigo-500 hover:bg-indigo-600">
Full Documentation
</a>
</div>
</div>
</div>
</div>
<!-- Resources -->
<div class="mt-16">
<h2 class="text-3xl font-extrabold text-gray-900 mb-8">Resources</h2>
<div class="grid grid-cols-1 gap-6 sm:grid-cols-2">
<div class="bg-white shadow rounded-lg p-6">
<h3 class="text-lg font-medium text-gray-900 mb-4">MCP Server Configuration</h3>
<p class="text-sm text-gray-500 mb-4">
To connect to the FiveM MCP server, use the following configuration in your MCP client:
</p>
<pre class="bg-gray-50 rounded p-4 text-sm overflow-x-auto"><code>{
"servers": {
<pre
class="bg-gray-50 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-4 text-sm overflow-x-auto"><code>{
"servers": {
"fivem": {
"url": "{{ route('fivem') }}",
"type": "http"
"url": "{{ route('fivem') }}",
"type": "http"
}
}
}
}</code></pre>
</div>
<div class="bg-white shadow rounded-lg p-6">
<h3 class="text-lg font-medium text-gray-900 mb-4">External Links</h3>
<ul class="space-y-2 text-sm">
<li>
<a href="https://docs.fivem.net/docs/" class="text-indigo-600 hover:text-indigo-500">FiveM Documentation</a>
</li>
<li>
<a href="https://docs.fivem.net/natives/" class="text-indigo-600 hover:text-indigo-500">FiveM Natives Reference</a>
</li>
<li>
<a href="https://docs.qbcore.org/" class="text-indigo-600 hover:text-indigo-500">QBCore Documentation</a>
</li>
<li>
<a href="https://coxdocs.dev/" class="text-indigo-600 hover:text-indigo-500">COX MySQL Documentation</a>
</li>
<li>
<a href="https://laravel.com/docs/mcp" class="text-indigo-600 hover:text-indigo-500">Laravel MCP Documentation</a>
</li>
<li>
<a href="https://modelcontextprotocol.io/" class="text-indigo-600 hover:text-indigo-500">Model Context Protocol</a>
</li>
</ul>
</div>
<div class="bg-white dark:bg-gray-800 shadow rounded-lg p-6">
<h3 class="text-lg font-medium text-gray-900 dark:text-white mb-4">External Links</h3>
<ul class="space-y-2 text-sm">
<li>
<a href="https://docs.fivem.net/docs/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM
Documentation</a>
</li>
<li>
<a href="https://docs.fivem.net/natives/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM
Natives Reference</a>
</li>
<li>
<a href="https://docs.qbcore.org/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">QBCore
Documentation</a>
</li>
<li>
<a href="https://coxdocs.dev/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">COX
MySQL Documentation</a>
</li>
<li>
<a href="https://laravel.com/docs/mcp"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Laravel
MCP Documentation</a>
</li>
<li>
<a href="https://modelcontextprotocol.io/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Model
Context Protocol</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
@endsection
-50
View File
@@ -1,50 +0,0 @@
<!DOCTYPE html>
<html lang="en" class="h-full">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>@yield('title', 'FiveM MCP Server Documentation')</title>
@vite(['resources/css/app.css', 'resources/js/app.js'])
</head>
<body class="h-full bg-gray-50">
<div class="min-h-full">
<!-- Navigation -->
<nav class="bg-white shadow-sm">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex">
<div class="shrink-0 flex items-center">
<h1 class="text-xl font-bold text-gray-900">FiveM MCP Server</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a href="{{ route('docs.index') }}" class="{{ request()->routeIs('docs.index') ? 'border-indigo-500 text-gray-900' : 'border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Home
</a>
<a href="{{ route('docs.quickstart') }}" class="{{ request()->routeIs('docs.quickstart') ? 'border-indigo-500 text-gray-900' : 'border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Quick Start
</a>
<a href="{{ route('docs.documentation') }}" class="{{ request()->routeIs('docs.documentation') ? 'border-indigo-500 text-gray-900' : 'border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Documentation
</a>
</div>
</div>
</div>
</div>
</nav>
<!-- Main Content -->
<main>
@yield('content')
</main>
<!-- Footer -->
<footer class="bg-white border-t border-gray-200 mt-12">
<div class="max-w-7xl mx-auto py-6 px-4 sm:px-6 lg:px-8">
<p class="text-center text-sm text-gray-500">
Built with <a href="https://laravel.com/docs/mcp" class="text-indigo-600 hover:text-indigo-500">Laravel MCP</a> for <a href="https://docs.fivem.net" class="text-indigo-600 hover:text-indigo-500">FiveM</a> development
</p>
</div>
</footer>
</div>
</body>
</html>
+372 -364
View File
@@ -1,380 +1,388 @@
@extends('docs.layout')
@extends('layouts.app')
@section('title', 'Quick Start Guide - FiveM MCP Server')
@section('content')
<div class="max-w-4xl mx-auto py-12 px-4 sm:px-6 lg:px-8">
<div class="bg-white shadow rounded-lg p-8">
<h1 class="text-3xl font-extrabold text-gray-900 mb-6">FiveM MCP Quick Start Guide</h1>
<div class="max-w-4xl mx-auto py-12 px-4 sm:px-6 lg:px-8">
<div class="bg-white dark:bg-gray-800 shadow rounded-lg p-8">
<h1 class="text-3xl font-extrabold text-gray-900 dark:text-white mb-6">FiveM MCP Quick Start Guide</h1>
<!-- What is this -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 mb-4">What is this?</h2>
<p class="text-gray-700 mb-4">
This MCP server gives AI assistants (like Claude) access to FiveM development tools including:
</p>
<ul class="list-disc list-inside text-gray-700 space-y-2 ml-4">
<li>Documentation search</li>
<li>Native function lookups</li>
<li>Manifest generation</li>
<li>Event references</li>
<li>Resource boilerplate generation</li>
</ul>
</section>
<!-- Choose Setup Type -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Choose Your Setup</h2>
<!-- Tab Buttons -->
<div class="border-b border-gray-200 mb-6">
<nav class="-mb-px flex space-x-8">
<button
data-tab="remote"
class="tab-button active border-b-2 border-indigo-500 py-4 px-1 text-center text-sm font-medium text-indigo-600"
>
<span class="flex items-center">
<span class="mr-2">🌐</span>
Remote Server
<span class="ml-2 inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium bg-indigo-100 text-indigo-800">
Recommended
</span>
</span>
</button>
<button
data-tab="local"
class="tab-button border-b-2 border-transparent py-4 px-1 text-center text-sm font-medium text-gray-500 hover:text-gray-700 hover:border-gray-300"
>
<span class="flex items-center">
<span class="mr-2">💻</span>
Local Installation
</span>
</button>
</nav>
</div>
<!-- Tab Content Container -->
<div class="tab-content-container">
<!-- Remote Setup Tab -->
<div data-tab-content="remote" class="tab-content active">
<div class="bg-indigo-50 border-l-4 border-indigo-500 p-4 mb-6">
<p class="text-sm text-indigo-800">
<strong>Easy setup!</strong> Connect to a hosted MCP server. Works from anywhere without any local installation.
</p>
</div>
<p class="text-gray-700 mb-6">
If someone is hosting the FiveM MCP server for you, follow these steps to connect:
</p>
<!-- Step 1 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">1. Get the Server URL</h3>
<p class="text-gray-700 mb-3">
Ask your server administrator for the MCP server URL. It will look like:
</p>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>https://your-domain.com/fivem</code></pre>
<p class="text-gray-700 mb-3 mt-4">
If you're using the official hosted server, use this URL:
</p>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>{{ route('fivem') }}</code></pre>
</div>
<!-- Step 2 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">2. Configure Claude Desktop</h3>
<p class="text-gray-700 mb-3">Edit your Claude Desktop configuration file:</p>
<ul class="list-disc list-inside text-gray-700 mb-3 ml-4">
<li><strong>macOS:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code></li>
<li><strong>Windows:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code></li>
</ul>
<p class="text-gray-700 mb-3">Add this configuration (replace the URL with your actual server URL):</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcpServers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}</code></pre>
<p class="text-gray-700 mb-3 mt-6"><strong>For VSCode (Cline Extension):</strong></p>
<p class="text-gray-700 mb-3">Edit your VSCode <code class="bg-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}
}</code></pre>
</div>
<!-- Step 3 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">3. Restart Claude Desktop</h3>
<p class="text-gray-700">
Completely quit and restart Claude Desktop for changes to take effect.
</p>
</div>
<!-- Step 4 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">4. Verify Connection</h3>
<p class="text-gray-700">
In Claude Desktop, you should see a small 🔌 icon or indication that the FiveM MCP server is connected.
</p>
</div>
<div class="bg-green-50 border-l-4 border-green-500 p-4">
<p class="text-sm text-green-800">
<strong>That's it!</strong> You're now connected to the remote MCP server and can start using FiveM development tools with Claude.
</p>
</div>
</div>
<!-- Local Setup Tab -->
<div data-tab-content="local" class="tab-content hidden">
<div class="bg-gray-50 border-l-4 border-gray-400 p-4 mb-6">
<p class="text-sm text-gray-700">
<strong>Advanced setup.</strong> Run the MCP server on your own machine. Requires PHP and Laravel installation.
</p>
</div>
<p class="text-gray-700 mb-6">
If you want to run the MCP server on your own machine:
</p>
<!-- Step 1 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">1. Test the Server</h3>
<p class="text-gray-700 mb-3">First, verify the server works:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>cd /path/to/fivem-mcp
php artisan mcp:inspector fivem</code></pre>
<p class="text-gray-600 text-sm mt-2">This opens a web inspector where you can test all tools.</p>
</div>
<!-- Step 2 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">2. Configure Claude Desktop</h3>
<p class="text-gray-700 mb-3">Edit your Claude Desktop configuration file:</p>
<ul class="list-disc list-inside text-gray-700 mb-3 ml-4">
<li><strong>macOS:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code></li>
<li><strong>Windows:</strong> <code class="bg-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code></li>
</ul>
<p class="text-gray-700 mb-3">Add this configuration:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>{
"mcpServers": {
"fivem": {
"command": "php",
"args": [
"artisan",
"mcp:start",
"fivem"
],
"cwd": "/path/to/fivem-mcp"
}
}
}</code></pre>
<p class="text-gray-700 mb-3"><strong>Or use the full PHP path (e.g., for Herd):</strong></p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcpServers": {
"fivem": {
"command": "/path/to/php",
"args": [
"/path/to/fivem-mcp/artisan",
"mcp:start",
"fivem"
]
}
}
}</code></pre>
<p class="text-gray-700 mb-3 mt-6"><strong>For VSCode (Cline Extension):</strong></p>
<p class="text-gray-700 mb-3">Edit your VSCode <code class="bg-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "php",
"args": ["artisan", "mcp:start", "fivem"],
"cwd": "/path/to/fivem-mcp"
}
}
}
}</code></pre>
<p class="text-gray-700 mb-3"><strong>Or with full paths:</strong></p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "/path/to/php",
"args": ["/path/to/fivem-mcp/artisan", "mcp:start", "fivem"]
}
}
}
}</code></pre>
</div>
<!-- Step 3 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">3. Restart Claude Desktop</h3>
<p class="text-gray-700">
Completely quit and restart Claude Desktop for changes to take effect.
</p>
</div>
<!-- Step 4 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">4. Verify Connection</h3>
<p class="text-gray-700">
In Claude Desktop, you should see a small 🔌 icon or indication that the FiveM MCP server is connected.
</p>
</div>
</div>
</div>
</section>
<!-- Quick Examples -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Quick Examples</h2>
<p class="text-gray-700 mb-4">Once connected, try these prompts in Claude:</p>
<div class="space-y-4">
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 mb-2">Example 1: Search Documentation</h4>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>Search FiveM docs for "state bags"</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 mb-2">Example 2: Look Up a Native</h4>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>What does the GetPlayerPed native function do? Show me an example.</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 mb-2">Example 3: Generate a Manifest</h4>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>Generate a fxmanifest.lua for my resource called "vehicle-shop" using ESX framework</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 mb-2">Example 4: List Events</h4>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>Show me all FiveM core server events</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 mb-2">Example 5: Create Boilerplate</h4>
<pre class="bg-gray-100 rounded p-3 text-sm"><code>Create a complete resource structure for a QBCore script called "bank-heist" with NUI</code></pre>
</div>
</div>
</section>
<!-- Troubleshooting -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Troubleshooting</h2>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">Server Not Connecting</h3>
<ol class="list-decimal list-inside text-gray-700 space-y-3 ml-4">
<li>
<strong>Check PHP Path:</strong> Make sure the PHP path in your config is correct
<pre class="bg-gray-900 text-gray-100 rounded p-3 mt-2 overflow-x-auto"><code>which php
# or for Herd:
ls -la "~/Library/Application Support/Herd/bin/"</code></pre>
</li>
<li>
<strong>Test Manually:</strong> Run the server command directly
<pre class="bg-gray-900 text-gray-100 rounded p-3 mt-2 overflow-x-auto"><code>cd /path/to/fivem-mcp
php artisan mcp:start fivem</code></pre>
</li>
<li>
<strong>Check Logs:</strong> Look at Claude Desktop logs
<ul class="list-disc list-inside ml-6 mt-2">
<li>macOS: <code class="bg-gray-100 px-2 py-1 rounded text-sm">~/Library/Logs/Claude/</code></li>
<li>Windows: Check Event Viewer or app logs</li>
</ul>
</li>
</ol>
</div>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">Permission Issues</h3>
<p class="text-gray-700 mb-3">If you get permission errors:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>cd /path/to/fivem-mcp
chmod +x artisan</code></pre>
</div>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">Path Issues</h3>
<p class="text-gray-700">
Make sure to use <strong>absolute paths</strong> in your config, not relative paths.
<!-- What is this -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">What is this?</h2>
<p class="text-gray-700 dark:text-gray-300 mb-4">
This MCP server gives AI assistants (like Claude) access to FiveM development tools including:
</p>
</div>
</section>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li>Documentation search</li>
<li>Native function lookups</li>
<li>Manifest generation</li>
<li>Event references</li>
<li>Resource boilerplate generation</li>
</ul>
</section>
<!-- Next Steps -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Next Steps</h2>
<ul class="list-disc list-inside text-gray-700 space-y-2 ml-4">
<li><a href="{{ route('docs.documentation') }}" class="text-indigo-600 hover:text-indigo-500">Read the full documentation</a></li>
<li>Explore all 5 tools in the MCP Inspector</li>
<li>Try creating a complete FiveM resource with AI assistance</li>
<li>Contribute new tools or improve existing ones</li>
</ul>
</section>
<!-- Choose Setup Type -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Choose Your Setup</h2>
<!-- Support -->
<section>
<h2 class="text-2xl font-bold text-gray-900 mb-4">Support</h2>
<p class="text-gray-700 mb-3">For issues:</p>
<ol class="list-decimal list-inside text-gray-700 space-y-2 ml-4">
<li>Check <a href="https://laravel.com/docs/mcp" class="text-indigo-600 hover:text-indigo-500">Laravel MCP Documentation</a></li>
<li>Check <a href="https://docs.fivem.net/" class="text-indigo-600 hover:text-indigo-500">FiveM Documentation</a></li>
<li>Review server logs</li>
<li>Open a GitHub issue</li>
</ol>
<p class="text-gray-700 mt-6 text-lg font-semibold">Happy coding! 🎮</p>
</section>
</div>
</div>
<!-- Tab Buttons -->
<div class="border-b border-gray-200 dark:border-gray-700 mb-6">
<nav class="-mb-px flex space-x-8">
<button data-tab="remote"
class="transition-all duration-200 ease-in-out active border-b-2 border-indigo-500 py-4 px-1 text-center text-sm font-medium text-indigo-600 dark:text-indigo-400">
<span class="flex items-center">
<span class="mr-2">🌐</span>
Remote Server
<span
class="ml-2 inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium bg-indigo-100 dark:bg-indigo-900 text-indigo-800 dark:text-indigo-200">
Recommended
</span>
</span>
</button>
<button data-tab="local"
class="transition-all duration-200 ease-in-out border-b-2 border-transparent py-4 px-1 text-center text-sm font-medium text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 hover:border-gray-300 dark:hover:border-gray-600">
<span class="flex items-center">
<span class="mr-2">💻</span>
Local Installation
</span>
</button>
</nav>
</div>
<script>
document.addEventListener('DOMContentLoaded', function() {
const tabButtons = document.querySelectorAll('.tab-button');
const tabContents = document.querySelectorAll('.tab-content');
<!-- Tab Content Container -->
<div class="tab-content-container">
<!-- Remote Setup Tab -->
<div data-tab-content="remote" class="animate-fade-in active">
<div class="bg-indigo-50 dark:bg-indigo-900/20 border-l-4 border-indigo-500 p-4 mb-6">
<p class="text-sm text-indigo-800 dark:text-indigo-200">
<strong>Easy setup!</strong> Connect to a hosted MCP server. Works from anywhere without any
local
installation.
</p>
</div>
tabButtons.forEach(button => {
button.addEventListener('click', function() {
const targetTab = this.dataset.tab;
<p class="text-gray-700 dark:text-gray-300 mb-6">
If someone is hosting the FiveM MCP server for you, follow these steps to connect:
</p>
// Remove active class from all buttons
tabButtons.forEach(btn => {
btn.classList.remove('active', 'border-indigo-500', 'text-indigo-600');
btn.classList.add('border-transparent', 'text-gray-500');
});
<!-- Step 1 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">1. Get the Server URL</h3>
<p class="text-gray-700 dark:text-gray-300 mb-3">
Ask your server administrator for the MCP server URL. It will look like:
</p>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>https://your-domain.com/fivem</code></pre>
<p class="text-gray-700 dark:text-gray-300 mb-3 mt-4">
If you're using the official hosted server, use this URL:
</p>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>{{ route('fivem') }}</code></pre>
</div>
// Add active class to clicked button
this.classList.remove('border-transparent', 'text-gray-500');
this.classList.add('active', 'border-indigo-500', 'text-indigo-600');
<!-- Step 2 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">2. Configure Claude Desktop
</h3>
<p class="text-gray-700 dark:text-gray-300 mb-3">Edit your Claude Desktop configuration file:
</p>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 mb-3 ml-4">
<li><strong>macOS:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code>
</li>
<li><strong>Windows:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code>
</li>
</ul>
// Hide all tab contents
tabContents.forEach(content => {
content.classList.add('hidden');
content.classList.remove('active');
});
// Show target tab content
const targetContent = document.querySelector(`[data-tab-content="${targetTab}"]`);
if (targetContent) {
targetContent.classList.remove('hidden');
targetContent.classList.add('active');
<p class="text-gray-700 dark:text-gray-300 mb-3">Add this configuration (replace the URL with
your actual server URL):
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcpServers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
});
});
});
</script>
}</code></pre>
<p class="text-gray-700 mb-3 mt-6"><strong>For VSCode (Cline Extension):</strong></p>
<p class="text-gray-700 mb-3">Edit your VSCode <code
class="bg-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"url": "https://your-domain.com/fivem"
}
}
}
}</code></pre>
</div>
<!-- Step 3 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">3. Restart Claude Desktop</h3>
<p class="text-gray-700">
Completely quit and restart Claude Desktop for changes to take effect.
</p>
</div>
<!-- Step 4 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 mb-3">4. Verify Connection</h3>
<p class="text-gray-700">
In Claude Desktop, you should see a small 🔌 icon or indication that the FiveM MCP server is
connected.
</p>
</div>
<div class="bg-green-50 dark:bg-green-900/20 border-l-4 border-green-500 p-4">
<p class="text-sm text-green-800 dark:text-green-200">
<strong>That's it!</strong> You're now connected to the remote MCP server and can start
using FiveM development
tools with Claude.
</p>
</div>
</div>
<!-- Local Setup Tab -->
<div data-tab-content="local" class="animate-fade-in hidden">
<div
class="bg-gray-50 dark:bg-gray-700/20 border-l-4 border-gray-400 dark:border-gray-500 p-4 mb-6">
<p class="text-sm text-gray-700 dark:text-gray-300">
<strong>Advanced setup.</strong> Run the MCP server on your own machine. Requires PHP and
Laravel
installation.
</p>
</div>
<p class="text-gray-700 dark:text-gray-300 mb-6">
If you want to run the MCP server on your own machine:
</p>
<!-- Step 1 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">1. Test the Server</h3>
<p class="text-gray-700 dark:text-gray-300 mb-3">First, verify the server works:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>cd /path/to/fivem-mcp
php artisan mcp:inspector fivem</code></pre>
<p class="text-gray-600 dark:text-gray-400 text-sm mt-2">This opens a web inspector where you
can test all tools.</p>
</div>
<!-- Step 2 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">2. Configure Claude Desktop
</h3>
<p class="text-gray-700 dark:text-gray-300 mb-3">Edit your Claude Desktop configuration file:
</p>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 mb-3 ml-4">
<li><strong>macOS:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">~/Library/Application Support/Claude/claude_desktop_config.json</code>
</li>
<li><strong>Windows:</strong> <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">%APPDATA%\Claude\claude_desktop_config.json</code>
</li>
</ul>
<p class="text-gray-700 dark:text-gray-300 mb-3">Add this configuration:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>{
"mcpServers": {
"fivem": {
"command": "php",
"args": [
"artisan",
"mcp:start",
"fivem"
],
"cwd": "/path/to/fivem-mcp"
}
}
}</code></pre>
<p class="text-gray-700 dark:text-gray-300 mb-3"><strong>Or use the full PHP path (e.g., for
Herd):</strong></p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcpServers": {
"fivem": {
"command": "/path/to/php",
"args": [
"/path/to/fivem-mcp/artisan",
"mcp:start",
"fivem"
]
}
}
}</code></pre>
<p class="text-gray-700 dark:text-gray-300 mb-3 mt-6"><strong>For VSCode (Cline
Extension):</strong></p>
<p class="text-gray-700 dark:text-gray-300 mb-3">Edit your VSCode <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">settings.json</code>:
</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto mb-4"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "php",
"args": ["artisan", "mcp:start", "fivem"],
"cwd": "/path/to/fivem-mcp"
}
}
}
}</code></pre>
<p class="text-gray-700 dark:text-gray-300 mb-3"><strong>Or with full paths:</strong></p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>{
"mcp": {
"servers": {
"fivem": {
"command": "/path/to/php",
"args": ["/path/to/fivem-mcp/artisan", "mcp:start", "fivem"]
}
}
}
}</code></pre>
</div>
<!-- Step 3 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">3. Restart Claude Desktop
</h3>
<p class="text-gray-700 dark:text-gray-300">
Completely quit and restart Claude Desktop for changes to take effect.
</p>
</div>
<!-- Step 4 -->
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">4. Verify Connection</h3>
<p class="text-gray-700 dark:text-gray-300">
In Claude Desktop, you should see a small 🔌 icon or indication that the FiveM MCP server is
connected.
</p>
</div>
</div>
</div>
</section>
<!-- Quick Examples -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Quick Examples</h2>
<p class="text-gray-700 dark:text-gray-300 mb-4">Once connected, try these prompts in Claude:</p>
<div class="space-y-4">
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Example 1: Search Documentation</h4>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>Search FiveM docs for "state bags"</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Example 2: Look Up a Native</h4>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>What does the GetPlayerPed native function do? Show me an example.</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Example 3: Generate a Manifest</h4>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>Generate a fxmanifest.lua for my resource called "vehicle-shop" using ESX framework</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Example 4: List Events</h4>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>Show me all FiveM core server events</code></pre>
</div>
<div class="border-l-4 border-indigo-500 pl-4">
<h4 class="font-semibold text-gray-900 dark:text-white mb-2">Example 5: Create Boilerplate</h4>
<pre
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 rounded p-3 text-sm"><code>Create a complete resource structure for a QBCore script called "bank-heist" with NUI</code></pre>
</div>
</div>
</section>
<!-- Troubleshooting -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Troubleshooting</h2>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">Server Not Connecting</h3>
<ol class="list-decimal list-inside text-gray-700 dark:text-gray-300 space-y-3 ml-4">
<li>
<strong>Check PHP Path:</strong> Make sure the PHP path in your config is correct
<pre class="bg-gray-900 text-gray-100 rounded p-3 mt-2 overflow-x-auto"><code>which php
# or for Herd:
ls -la "~/Library/Application Support/Herd/bin/"</code></pre>
</li>
<li>
<strong>Test Manually:</strong> Run the server command directly
<pre class="bg-gray-900 text-gray-100 rounded p-3 mt-2 overflow-x-auto"><code>cd /path/to/fivem-mcp
php artisan mcp:start fivem</code></pre>
</li>
<li>
<strong>Check Logs:</strong> Look at Claude Desktop logs
<ul class="list-disc list-inside ml-6 mt-2">
<li>macOS: <code
class="bg-gray-100 dark:bg-gray-700 text-gray-900 dark:text-gray-100 px-2 py-1 rounded text-sm">~/Library/Logs/Claude/</code>
</li>
<li>Windows: Check Event Viewer or app logs</li>
</ul>
</li>
</ol>
</div>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">Permission Issues</h3>
<p class="text-gray-700 dark:text-gray-300 mb-3">If you get permission errors:</p>
<pre class="bg-gray-900 text-gray-100 rounded p-4 overflow-x-auto"><code>cd /path/to/fivem-mcp
chmod +x artisan</code></pre>
</div>
<div class="mb-6">
<h3 class="text-xl font-semibold text-gray-900 dark:text-white mb-3">Path Issues</h3>
<p class="text-gray-700 dark:text-gray-300">
Make sure to use <strong>absolute paths</strong> in your config, not relative paths.
</p>
</div>
</section>
<!-- Next Steps -->
<section class="mb-8">
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Next Steps</h2>
<ul class="list-disc list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li><a href="{{ route('docs.documentation') }}"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Read
the full
documentation</a></li>
<li>Explore all 5 tools in the MCP Inspector</li>
<li>Try creating a complete FiveM resource with AI assistance</li>
<li>Contribute new tools or improve existing ones</li>
</ul>
</section>
<!-- Support -->
<section>
<h2 class="text-2xl font-bold text-gray-900 dark:text-white mb-4">Support</h2>
<p class="text-gray-700 dark:text-gray-300 mb-3">For issues:</p>
<ol class="list-decimal list-inside text-gray-700 dark:text-gray-300 space-y-2 ml-4">
<li>Check <a href="https://laravel.com/docs/mcp"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Laravel
MCP
Documentation</a></li>
<li>Check <a href="https://docs.fivem.net/"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM
Documentation</a></li>
<li>Review server logs</li>
<li>Open a GitHub issue</li>
</ol>
<p class="text-gray-700 dark:text-gray-300 mt-6 text-lg font-semibold">Happy coding! 🎮</p>
</section>
</div>
</div>
@endsection
+26
View File
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html lang="en" class="h-full">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>@yield('title', 'FiveM MCP Server Documentation')</title>
@vite(['resources/css/app.css', 'resources/js/app.js'])
</head>
<body class="h-full bg-gray-50 dark:bg-gray-900">
<div class="min-h-full">
<!-- Navigation -->
@include('layouts.partials.navigation')
<!-- Main Content -->
<main>
@yield('content')
</main>
<!-- Footer -->
@include('layouts.partials.footer')
</div>
</body>
</html>
@@ -0,0 +1,12 @@
<footer class="bg-white dark:bg-gray-800 border-t border-gray-200 dark:border-gray-700 mt-12">
<div class="max-w-7xl mx-auto py-6 px-4 sm:px-6 lg:px-8">
<p class="text-center text-sm text-gray-500 dark:text-gray-400">
Built with <a href="https://laravel.com/docs/mcp"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">Laravel
MCP</a>
for <a href="https://docs.fivem.net"
class="text-indigo-600 dark:text-indigo-400 hover:text-indigo-500 dark:hover:text-indigo-300">FiveM</a>
development
</p>
</div>
</footer>
@@ -0,0 +1,25 @@
<nav class="bg-white dark:bg-gray-800 shadow-sm">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex">
<div class="shrink-0 flex items-center">
<h1 class="text-xl font-bold text-gray-900 dark:text-white">FiveM MCP Server</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a href="{{ route('docs.index') }}"
class="{{ request()->routeIs('docs.index') ? 'border-indigo-500 text-gray-900 dark:text-white' : 'border-transparent text-gray-500 dark:text-gray-400 hover:border-gray-300 dark:hover:border-gray-600 hover:text-gray-700 dark:hover:text-gray-300' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Home
</a>
<a href="{{ route('docs.quickstart') }}"
class="{{ request()->routeIs('docs.quickstart') ? 'border-indigo-500 text-gray-900 dark:text-white' : 'border-transparent text-gray-500 dark:text-gray-400 hover:border-gray-300 dark:hover:border-gray-600 hover:text-gray-700 dark:hover:text-gray-300' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Quick Start
</a>
<a href="{{ route('docs.documentation') }}"
class="{{ request()->routeIs('docs.documentation') ? 'border-indigo-500 text-gray-900 dark:text-white' : 'border-transparent text-gray-500 dark:text-gray-400 hover:border-gray-300 dark:hover:border-gray-600 hover:text-gray-700 dark:hover:text-gray-300' }} inline-flex items-center px-1 pt-1 border-b-2 text-sm font-medium">
Documentation
</a>
</div>
</div>
</div>
</div>
</nav>
+16 -1
View File
@@ -8,7 +8,22 @@ export default defineConfig({
input: ['resources/css/app.css', 'resources/js/app.js'],
refresh: true,
}),
tailwindcss(),
tailwindcss({
theme: {
extend: {
colors: {
gta: {
dark: '#1a1a1a',
light: '#f8fafc',
orange: '#F57C00',
cyan: '#1de9b6',
gray: '#334155',
indigo: '#3b82f6',
},
},
},
},
}),
],
server: {
watch: {