- Introduced a new code snippets resource for common FiveM patterns in Lua and JavaScript. - Added a framework comparison document outlining Standalone, ESX, and QBCore features. - Created search results view for FiveM documentation queries. - Developed client and server template scripts for ESX and QBCore frameworks. - Implemented NUI templates including HTML, CSS, and JavaScript for user interfaces. - Established routes for documentation and console commands. - Added tests for various features including documentation routes and tool functionalities. - Configured Vite for asset management with Laravel. - Updated .gitignore files for storage and framework directories.
170 lines
6.7 KiB
PHP
170 lines
6.7 KiB
PHP
<?php
|
|
|
|
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;
|
|
|
|
#[Description('Search FiveM documentation for specific topics, concepts, or features. Returns relevant documentation URLs and summaries.')]
|
|
class SearchFiveMDocs extends Tool
|
|
{
|
|
/**
|
|
* Handle the tool request.
|
|
*/
|
|
public function handle(Request $request): Response
|
|
{
|
|
$query = $request->get('query');
|
|
$category = $request->get('category', 'all');
|
|
|
|
$results = $this->searchDocs($query, $category);
|
|
|
|
if (empty($results)) {
|
|
return Response::text(sprintf('No documentation found for query: %s', $query));
|
|
}
|
|
|
|
return Response::text(
|
|
view('mcp.search-results', [
|
|
'query' => $query,
|
|
'results' => $results,
|
|
])->render()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Search the FiveM documentation.
|
|
*/
|
|
protected function searchDocs(string $query, string $category): array
|
|
{
|
|
$baseUrl = 'https://docs.fivem.net/docs/';
|
|
|
|
// Common documentation pages organized by category
|
|
$docs = [
|
|
'scripting' => [
|
|
[
|
|
'title' => 'Scripting Introduction',
|
|
'url' => sprintf('%sscripting-manual/introduction/', $baseUrl),
|
|
'description' => 'Learn the basics of FiveM scripting with Lua and JavaScript',
|
|
'keywords' => ['script', 'introduction', 'basics', 'getting started', 'lua', 'javascript'],
|
|
],
|
|
[
|
|
'title' => 'Client Functions',
|
|
'url' => sprintf('%sscripting-reference/client-functions/', $baseUrl),
|
|
'description' => 'Client-side native functions for game interaction',
|
|
'keywords' => ['client', 'native', 'function', 'game', 'player'],
|
|
],
|
|
[
|
|
'title' => 'Server Functions',
|
|
'url' => sprintf('%sscripting-reference/server-functions/', $baseUrl),
|
|
'description' => 'Server-side functions for player management and game logic',
|
|
'keywords' => ['server', 'function', 'player', 'management'],
|
|
],
|
|
[
|
|
'title' => 'Resource Manifest',
|
|
'url' => sprintf('%sscripting-reference/resource-manifest/resource-manifest/', $baseUrl),
|
|
'description' => 'Configure your resource with fxmanifest.lua',
|
|
'keywords' => ['manifest', 'fxmanifest', 'resource', 'config', 'configuration'],
|
|
],
|
|
],
|
|
'natives' => [
|
|
[
|
|
'title' => 'Native Reference',
|
|
'url' => sprintf('%snatives/', $baseUrl),
|
|
'description' => 'Complete reference of GTA5 native functions',
|
|
'keywords' => ['native', 'reference', 'gta', 'function'],
|
|
],
|
|
[
|
|
'title' => 'CFX Natives',
|
|
'url' => sprintf('%snatives/?n_CFX', $baseUrl),
|
|
'description' => 'FiveM-specific native functions (CFX namespace)',
|
|
'keywords' => ['cfx', 'native', 'fivem', 'custom'],
|
|
],
|
|
],
|
|
'networking' => [
|
|
[
|
|
'title' => 'Network Events',
|
|
'url' => sprintf('%sscripting-manual/networking/events/', $baseUrl),
|
|
'description' => 'Client-server communication using events',
|
|
'keywords' => ['event', 'network', 'trigger', 'client', 'server', 'communication'],
|
|
],
|
|
[
|
|
'title' => 'State Bags',
|
|
'url' => sprintf('%sscripting-manual/networking/state-bags/', $baseUrl),
|
|
'description' => 'Synchronized state management across clients and server',
|
|
'keywords' => ['state', 'bag', 'sync', 'data', 'shared'],
|
|
],
|
|
],
|
|
'resources' => [
|
|
[
|
|
'title' => 'Creating Resources',
|
|
'url' => sprintf('%sscripting-manual/introduction/creating-your-first-script/', $baseUrl),
|
|
'description' => 'Step-by-step guide to creating your first FiveM resource',
|
|
'keywords' => ['create', 'resource', 'first', 'tutorial', 'guide'],
|
|
],
|
|
[
|
|
'title' => 'Resource Structure',
|
|
'url' => sprintf('%sscripting-manual/introduction/about-resources/', $baseUrl),
|
|
'description' => 'Understanding FiveM resource folder structure and organization',
|
|
'keywords' => ['structure', 'folder', 'organization', 'resource', 'files'],
|
|
],
|
|
],
|
|
];
|
|
|
|
$results = [];
|
|
$searchIn = $category === 'all' ? array_merge(...array_values($docs)) : ($docs[$category] ?? []);
|
|
$queryLower = strtolower($query);
|
|
|
|
foreach ($searchIn as $doc) {
|
|
$matchScore = 0;
|
|
|
|
// Check title
|
|
if (str_contains(strtolower($doc['title']), $queryLower)) {
|
|
$matchScore += 10;
|
|
}
|
|
|
|
// Check keywords
|
|
foreach ($doc['keywords'] as $keyword) {
|
|
if (str_contains(strtolower($keyword), $queryLower) || str_contains($queryLower, strtolower($keyword))) {
|
|
$matchScore += 5;
|
|
}
|
|
}
|
|
|
|
// Check description
|
|
if (str_contains(strtolower($doc['description']), $queryLower)) {
|
|
$matchScore += 3;
|
|
}
|
|
|
|
if ($matchScore > 0) {
|
|
$results[] = array_merge($doc, ['score' => $matchScore]);
|
|
}
|
|
}
|
|
|
|
// Sort by score descending
|
|
usort($results, fn ($a, $b) => $b['score'] <=> $a['score']);
|
|
|
|
return array_slice($results, 0, 5);
|
|
}
|
|
|
|
/**
|
|
* Get the tool's input schema.
|
|
*
|
|
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
|
*/
|
|
public function schema(JsonSchema $schema): array
|
|
{
|
|
return [
|
|
'query' => $schema
|
|
->string()
|
|
->description('The search query for FiveM documentation (e.g., "events", "natives", "manifest")')
|
|
->required(),
|
|
'category' => $schema
|
|
->string()
|
|
->enum(['all', 'scripting', 'natives', 'networking', 'resources'])
|
|
->description('Filter results by documentation category')
|
|
->default('all'),
|
|
];
|
|
}
|
|
}
|