diff --git a/app/Mcp/Tools/GetQBCoreEventReference.php b/app/Mcp/Tools/GetQBCoreEventReference.php new file mode 100644 index 0000000..89485f6 --- /dev/null +++ b/app/Mcp/Tools/GetQBCoreEventReference.php @@ -0,0 +1,277 @@ +get('event_name'); + $eventCategory = $request->get('event_category', 'all'); + $language = $request->get('language', 'lua'); + + if ($eventName) { + return $this->getEventInfo($eventName, $language); + } + + return $this->listEvents($eventCategory, $language); + } + + /** + * Get specific event information. + */ + protected function getEventInfo(string $eventName, string $language): Response + { + $events = $this->getQBCoreEventsDatabase(); + + foreach ($events as $event) { + if (strtolower($event['name']) === strtolower($eventName)) { + return Response::text($this->formatEventInfo($event, $language)); + } + } + + return Response::text(sprintf("QBCore event '%s' not found in the database.", $eventName)); + } + + /** + * List events by category. + */ + protected function listEvents(string $category, string $language): Response + { + $events = $this->getQBCoreEventsDatabase(); + + if ($category !== 'all') { + $events = array_filter($events, fn ($e) => $e['category'] === $category); + } + + $eventsByCategory = []; + foreach ($events as $event) { + $eventsByCategory[$event['category']][] = $event; + } + + return Response::text( + view('mcp.qbcore-event-list', [ + 'eventsByCategory' => $eventsByCategory, + ])->render() + ); + } + + /** + * Format event information. + */ + protected function formatEventInfo(array $event, string $language): string + { + return view('mcp.qbcore-event-reference', [ + 'event' => $event, + 'language' => $language, + ])->render(); + } + + /** + * Get QBCore events database. + */ + protected function getQBCoreEventsDatabase(): array + { + return [ + // Player Events + [ + 'name' => 'QBCore:Client:OnPlayerLoaded', + 'category' => 'player', + 'side' => 'client', + 'description' => 'Triggered when a player\'s data is loaded on the client.', + 'parameters' => [], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoaded', function()\n local PlayerData = QBCore.Functions.GetPlayerData()\n print('Player loaded: ' .. PlayerData.charinfo.firstname)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoaded', () => {\n const PlayerData = QBCore.Functions.GetPlayerData();\n console.log('Player loaded: ' + PlayerData.charinfo.firstname);\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + ], + [ + 'name' => 'QBCore:Client:OnPlayerUnload', + 'category' => 'player', + 'side' => 'client', + 'description' => 'Triggered when a player\'s data is unloaded (before character switch or logout).', + 'parameters' => [], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerUnload', function()\n print('Player unloaded')\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerUnload', () => {\n console.log('Player unloaded');\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + ], + [ + 'name' => 'QBCore:Server:OnPlayerLoaded', + 'category' => 'player', + 'side' => 'server', + 'description' => 'Triggered on the server when a player\'s data is successfully loaded.', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ], + 'lua_example' => "RegisterNetEvent('QBCore:Server:OnPlayerLoaded', function()\n local Player = QBCore.Functions.GetPlayer(source)\n if Player then\n print('Server: Player loaded - ' .. Player.PlayerData.charinfo.firstname)\n end\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Server:OnPlayerLoaded', () => {\n const Player = QBCore.Functions.GetPlayer(global.source);\n if (Player) {\n console.log('Server: Player loaded - ' + Player.PlayerData.charinfo.firstname);\n }\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + ], + + // Job Events + [ + 'name' => 'QBCore:Client:OnJobUpdate', + 'category' => 'job', + 'side' => 'client', + 'description' => 'Triggered when a player\'s job is updated.', + 'parameters' => [ + ['name' => 'job', 'type' => 'table', 'description' => 'The job data table'], + ], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate', function(job)\n PlayerData.job = job\n print('Job changed to: ' .. job.name .. ' - Grade: ' .. job.grade.name)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate', (job) => {\n PlayerData.job = job;\n console.log(`Job changed to: \${job.name} - Grade: \${job.grade.name}`);\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/jobs', + ], + [ + 'name' => 'QBCore:Server:SetJob', + 'category' => 'job', + 'side' => 'server', + 'description' => 'Set a player\'s job on the server (requires permission).', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'job', 'type' => 'string', 'description' => 'The job name'], + ['name' => 'grade', 'type' => 'int', 'description' => 'The job grade level'], + ], + 'lua_example' => "TriggerServerEvent('QBCore:Server:SetJob', source, 'police', 2)", + 'js_example' => "TriggerServerEvent('QBCore:Server:SetJob', global.source, 'police', 2);", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/jobs', + ], + + // Inventory Events + [ + 'name' => 'QBCore:Client:OnItemAdd', + 'category' => 'inventory', + 'side' => 'client', + 'description' => 'Triggered when an item is added to the player inventory.', + 'parameters' => [ + ['name' => 'itemName', 'type' => 'string', 'description' => 'The item name'], + ['name' => 'amount', 'type' => 'int', 'description' => 'The amount added'], + ], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnItemAdd', function(itemName, amount)\n print('Added ' .. amount .. 'x ' .. itemName)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnItemAdd', (itemName, amount) => {\n console.log(`Added \${amount}x \${itemName}`);\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/items', + ], + [ + 'name' => 'QBCore:Client:OnItemRemove', + 'category' => 'inventory', + 'side' => 'client', + 'description' => 'Triggered when an item is removed from the player inventory.', + 'parameters' => [ + ['name' => 'itemName', 'type' => 'string', 'description' => 'The item name'], + ['name' => 'amount', 'type' => 'int', 'description' => 'The amount removed'], + ], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnItemRemove', function(itemName, amount)\n print('Removed ' .. amount .. 'x ' .. itemName)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnItemRemove', (itemName, amount) => {\n console.log(`Removed \${amount}x \${itemName}`);\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/items', + ], + [ + 'name' => 'QBCore:Server:AddItem', + 'category' => 'inventory', + 'side' => 'server', + 'description' => 'Add an item to a player\'s inventory.', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'item', 'type' => 'string', 'description' => 'The item name'], + ['name' => 'amount', 'type' => 'int', 'description' => 'The amount to add'], + ['name' => 'slot', 'type' => 'int', 'description' => 'Optional inventory slot'], + ['name' => 'info', 'type' => 'table', 'description' => 'Optional item info'], + ], + 'lua_example' => "exports['qb-core']:GetPlayer(source):AddItem('water', 1)", + 'js_example' => "exports['qb-core']:GetPlayer(global.source).AddItem('water', 1);", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/items', + ], + + // Vehicle Events + [ + 'name' => 'QBCore:Server:AddVehicle', + 'category' => 'vehicle', + 'side' => 'server', + 'description' => 'Add a vehicle to a player\'s garage.', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'modelName', 'type' => 'string', 'description' => 'The vehicle model name'], + ['name' => 'plate', 'type' => 'string', 'description' => 'The vehicle license plate'], + ], + 'lua_example' => "TriggerServerEvent('QBCore:Server:AddVehicle', 'adder', 'QBTEST123')", + 'js_example' => "TriggerServerEvent('QBCore:Server:AddVehicle', 'adder', 'QBTEST123');", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/vehicles', + ], + [ + 'name' => 'QBCore:Server:DeleteVehicle', + 'category' => 'vehicle', + 'side' => 'server', + 'description' => 'Remove a vehicle from a player\'s garage.', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'plate', 'type' => 'string', 'description' => 'The vehicle license plate'], + ], + 'lua_example' => "TriggerServerEvent('QBCore:Server:DeleteVehicle', 'QBTEST123')", + 'js_example' => "TriggerServerEvent('QBCore:Server:DeleteVehicle', 'QBTEST123');", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/vehicles', + ], + + // Money Events + [ + 'name' => 'QBCore:Client:OnMoneyChange', + 'category' => 'money', + 'side' => 'client', + 'description' => 'Triggered when a player\'s money amount changes.', + 'parameters' => [ + ['name' => 'type', 'type' => 'string', 'description' => 'Money type (cash, bank, etc.)'], + ['name' => 'amount', 'type' => 'int', 'description' => 'The new amount'], + ['name' => 'difference', 'type' => 'int', 'description' => 'The amount changed'], + ], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnMoneyChange', function(type, amount, difference)\n print('Money changed: ' .. type .. ' = ' .. amount)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnMoneyChange', (type, amount, difference) => {\n console.log(`Money changed: \${type} = \${amount}`);\n});", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + ], + [ + 'name' => 'QBCore:Server:AddMoney', + 'category' => 'money', + 'side' => 'server', + 'description' => 'Add money to a player\'s account.', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'moneyType', 'type' => 'string', 'description' => 'Money type (cash, bank)'], + ['name' => 'amount', 'type' => 'int', 'description' => 'The amount to add'], + ['name' => 'reason', 'type' => 'string', 'description' => 'Optional reason for log'], + ], + 'lua_example' => "exports['qb-core']:AddMoney(source, 'cash', 500, 'Job Payment')", + 'js_example' => "exports['qb-core']:AddMoney(global.source, 'cash', 500, 'Job Payment');", + 'documentation' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + ], + ]; + } + + /** + * Get the tool's input schema. + * + * @return array + */ + public function schema(JsonSchema $schema): array + { + return [ + 'event_name' => $schema + ->string() + ->description('Specific QBCore event name to look up (optional, leave empty to list all events)'), + 'event_category' => $schema + ->string() + ->enum(['all', 'player', 'job', 'inventory', 'vehicle', 'money']) + ->description('Filter events by category') + ->default('all'), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/GetQBCoreFunction.php b/app/Mcp/Tools/GetQBCoreFunction.php new file mode 100644 index 0000000..10487a3 --- /dev/null +++ b/app/Mcp/Tools/GetQBCoreFunction.php @@ -0,0 +1,270 @@ +get('function_name'); + $language = $request->get('language', 'lua'); + + $function = $this->findFunction($functionName); + + if (! $function) { + return Response::text(sprintf("QBCore function '%s' not found. Check QBCore documentation at https://docs.qbcore.org/", $functionName)); + } + + $output = $this->formatFunctionInfo($function, $language); + + return Response::text($output); + } + + /** + * Find a QBCore function. + */ + protected function findFunction(string $name): ?array + { + $functions = [ + // Player Functions + 'QBCore.Functions.GetPlayer' => [ + 'namespace' => 'Core', + 'description' => 'Get a QBCore player object from server ID (server-side only)', + 'side' => 'server', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ], + 'returns' => ['type' => 'table', 'description' => 'QBCore player object or nil'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n print('Player: ' .. Player.PlayerData.charinfo.firstname)\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n console.log('Player: ' + Player.PlayerData.charinfo.firstname);\n}", + ], + 'QBCore.Functions.GetPlayerByCitizenId' => [ + 'namespace' => 'Core', + 'description' => 'Get a player object by their citizen ID (server-side only)', + 'side' => 'server', + 'parameters' => [ + ['name' => 'citizenId', 'type' => 'string', 'description' => 'The player citizen ID'], + ], + 'returns' => ['type' => 'table', 'description' => 'QBCore player object or nil'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayerByCitizenId('ABC12345')\nif Player then\n TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, 'Hello!')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayerByCitizenId('ABC12345');\nif (Player) {\n TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, 'Hello!');\n}", + ], + 'QBCore.Functions.GetPlayerData' => [ + 'namespace' => 'Core', + 'description' => 'Get the current player data (client-side only)', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'table', 'description' => 'Current player data table'], + 'lua_example' => "local PlayerData = QBCore.Functions.GetPlayerData()\nprint('Job: ' .. PlayerData.job.name)", + 'js_example' => "const PlayerData = QBCore.Functions.GetPlayerData();\nconsole.log('Job: ' + PlayerData.job.name);", + ], + + // Item Functions + 'AddItem' => [ + 'namespace' => 'Player', + 'description' => 'Add an item to a player\'s inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], + ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to add (default 1)'], + ['name' => 'slot', 'type' => 'int|nil', 'description' => 'Optional specific slot'], + ['name' => 'info', 'type' => 'table|nil', 'description' => 'Optional item metadata/info'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local success = Player.Functions.AddItem('water', 1)\n if success then\n TriggerClientEvent('QBCore:Notify', source, 'Item added')\n end\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const success = Player.Functions.AddItem('water', 1);\n if (success) {\n TriggerClientEvent('QBCore:Notify', global.source, 'Item added');\n }\n}", + ], + 'RemoveItem' => [ + 'namespace' => 'Player', + 'description' => 'Remove an item from a player\'s inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], + ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to remove (default 1)'], + ['name' => 'slot', 'type' => 'int|nil', 'description' => 'Optional specific slot'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local success = Player.Functions.RemoveItem('water', 1)\n if success then\n TriggerClientEvent('QBCore:Notify', source, 'Item removed')\n end\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const success = Player.Functions.RemoveItem('water', 1);\n if (success) {\n TriggerClientEvent('QBCore:Notify', global.source, 'Item removed');\n }\n}", + ], + 'GetItemByName' => [ + 'namespace' => 'Player', + 'description' => 'Get item data from a player\'s inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'item', 'type' => 'string', 'description' => 'Item name to search for'], + ], + 'returns' => ['type' => 'table|nil', 'description' => 'Item data table or nil if not found'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local item = Player.Functions.GetItemByName('water')\n if item then\n print('Found ' .. item.amount .. 'x ' .. item.name)\n end\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const item = Player.Functions.GetItemByName('water');\n if (item) {\n console.log(`Found \${item.amount}x \${item.name}`);\n }\n}", + ], + + // Money Functions + 'AddMoney' => [ + 'namespace' => 'Player', + 'description' => 'Add money to a player\'s account', + 'side' => 'server', + 'parameters' => [ + ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], + ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to add'], + ['name' => 'reason', 'type' => 'string|nil', 'description' => 'Optional reason for logging'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.AddMoney('cash', 500, 'Job Payment')\n TriggerClientEvent('QBCore:Notify', source, 'You earned $500')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.AddMoney('cash', 500, 'Job Payment');\n TriggerClientEvent('QBCore:Notify', global.source, 'You earned $500');\n}", + ], + 'RemoveMoney' => [ + 'namespace' => 'Player', + 'description' => 'Remove money from a player\'s account', + 'side' => 'server', + 'parameters' => [ + ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], + ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to remove'], + ['name' => 'reason', 'type' => 'string|nil', 'description' => 'Optional reason for logging'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.RemoveMoney('cash', 500, 'Shop Purchase')\n TriggerClientEvent('QBCore:Notify', source, 'Payment successful')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.RemoveMoney('cash', 500, 'Shop Purchase');\n TriggerClientEvent('QBCore:Notify', global.source, 'Payment successful');\n}", + ], + 'GetMoney' => [ + 'namespace' => 'Player', + 'description' => 'Get a player\'s money amount', + 'side' => 'server', + 'parameters' => [ + ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], + ], + 'returns' => ['type' => 'int', 'description' => 'Money amount'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local cashAmount = Player.Functions.GetMoney('cash')\n print('Cash: $' .. cashAmount)\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const cashAmount = Player.Functions.GetMoney('cash');\n console.log('Cash: $' + cashAmount);\n}", + ], + + // Job Functions + 'SetJob' => [ + 'namespace' => 'Player', + 'description' => 'Set a player\'s job', + 'side' => 'server', + 'parameters' => [ + ['name' => 'jobName', 'type' => 'string', 'description' => 'The job name'], + ['name' => 'grade', 'type' => 'int', 'description' => 'The job grade (usually 0 for basic)'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.SetJob('police', 0)\n TriggerClientEvent('QBCore:Notify', source, 'You are now a police officer', 'success')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.SetJob('police', 0);\n TriggerClientEvent('QBCore:Notify', global.source, 'You are now a police officer', 'success');\n}", + ], + 'GetJob' => [ + 'namespace' => 'Player', + 'description' => 'Get a player\'s job information', + 'side' => 'server', + 'parameters' => [], + 'returns' => ['type' => 'table', 'description' => 'Job data table with name, label, grade, etc.'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local job = Player.Functions.GetJob()\n print('Job: ' .. job.name .. ' (' .. job.grade.name .. ')')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const job = Player.Functions.GetJob();\n console.log(`Job: \${job.name} (\${job.grade.name})`);\n}", + ], + + // Vehicle Functions + 'AddVehicle' => [ + 'namespace' => 'Player', + 'description' => 'Add a vehicle to a player\'s garage', + 'side' => 'server', + 'parameters' => [ + ['name' => 'modelName', 'type' => 'string', 'description' => 'Vehicle model name (e.g., "adder")'], + ['name' => 'plate', 'type' => 'string', 'description' => 'License plate (usually unique identifier)'], + ['name' => 'properties', 'type' => 'table|nil', 'description' => 'Optional vehicle properties/customization'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.AddVehicle('adder', 'QBTEST')\n TriggerClientEvent('QBCore:Notify', source, 'Vehicle added to garage')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.AddVehicle('adder', 'QBTEST');\n TriggerClientEvent('QBCore:Notify', global.source, 'Vehicle added to garage');\n}", + ], + 'DeleteVehicle' => [ + 'namespace' => 'Player', + 'description' => 'Remove a vehicle from a player\'s garage', + 'side' => 'server', + 'parameters' => [ + ['name' => 'plate', 'type' => 'string', 'description' => 'License plate of vehicle to remove'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.DeleteVehicle('QBTEST')\n TriggerClientEvent('QBCore:Notify', source, 'Vehicle removed from garage')\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.DeleteVehicle('QBTEST');\n TriggerClientEvent('QBCore:Notify', global.source, 'Vehicle removed from garage');\n}", + ], + + // Utility Functions + 'Notify' => [ + 'namespace' => 'Utility', + 'description' => 'Send a notification to a player', + 'side' => 'client', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'Player server ID'], + ['name' => 'message', 'type' => 'string', 'description' => 'Notification message'], + ['name' => 'type', 'type' => 'string', 'description' => 'Type: "success", "error", "info" (default: info)'], + ['name' => 'length', 'type' => 'int|nil', 'description' => 'Duration in milliseconds'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "TriggerClientEvent('QBCore:Notify', source, 'Hello Player!', 'success', 5000)", + 'js_example' => "TriggerClientEvent('QBCore:Notify', global.source, 'Hello Player!', 'success', 5000);", + ], + 'HasItem' => [ + 'namespace' => 'Player', + 'description' => 'Check if a player has an item', + 'side' => 'server', + 'parameters' => [ + ['name' => 'item', 'type' => 'string', 'description' => 'Item name to check'], + ['name' => 'amount', 'type' => 'int|nil', 'description' => 'Minimum amount required'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'True if player has item'], + 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n if Player.Functions.GetItemByName('water') then\n print('Has water')\n end\nend", + 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n if (Player.Functions.GetItemByName('water')) {\n console.log('Has water');\n }\n}", + ], + ]; + + $nameLower = strtolower($name); + + foreach ($functions as $functionName => $functionData) { + if (strtolower($functionName) === $nameLower) { + return array_merge(['name' => $functionName], $functionData); + } + } + + return null; + } + + /** + * Format function info. + */ + protected function formatFunctionInfo(array $function, string $language): string + { + return view('mcp.qbcore-function', [ + 'function' => $function, + 'language' => $language, + ])->render(); + } + + /** + * Get the tool's input schema. + * + * @return array + */ + public function schema(JsonSchema $schema): array + { + return [ + 'function_name' => $schema + ->string() + ->description('The name of the QBCore function to look up (e.g., "QBCore.Functions.GetPlayer", "AddMoney")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/SearchFiveMDocs.php b/app/Mcp/Tools/SearchFiveMDocs.php index 7a2c13c..239213c 100644 --- a/app/Mcp/Tools/SearchFiveMDocs.php +++ b/app/Mcp/Tools/SearchFiveMDocs.php @@ -110,6 +110,56 @@ class SearchFiveMDocs extends Tool 'keywords' => ['structure', 'folder', 'organization', 'resource', 'files'], ], ], + 'qbcore' => [ + [ + 'title' => 'QBCore Documentation', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/', + 'description' => 'Official QBCore framework documentation and guides', + 'keywords' => ['qbcore', 'framework', 'documentation', 'guide'], + ], + [ + 'title' => 'QBCore Getting Started', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/get-started', + 'description' => 'Getting started with QBCore framework setup and basics', + 'keywords' => ['qbcore', 'getting started', 'setup', 'installation', 'begin'], + ], + [ + 'title' => 'QBCore Callbacks & Exports', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/callbacks-exports', + 'description' => 'Learn about QBCore callbacks and exports for inter-resource communication', + 'keywords' => ['qbcore', 'callback', 'export', 'function', 'communication'], + ], + [ + 'title' => 'QBCore Items & Inventory', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/items', + 'description' => 'Item system and inventory management in QBCore', + 'keywords' => ['qbcore', 'items', 'inventory', 'item', 'database'], + ], + [ + 'title' => 'QBCore Jobs & Grades', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/jobs', + 'description' => 'Job system and player grades in QBCore', + 'keywords' => ['qbcore', 'job', 'grades', 'employment', 'boss'], + ], + [ + 'title' => 'QBCore Player Management', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/player', + 'description' => 'Managing player data and interactions in QBCore', + 'keywords' => ['qbcore', 'player', 'data', 'management', 'character'], + ], + [ + 'title' => 'QBCore Vehicles', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/vehicles', + 'description' => 'Vehicle system and ownership in QBCore', + 'keywords' => ['qbcore', 'vehicle', 'car', 'ownership', 'garage'], + ], + [ + 'title' => 'QBCore Events', + 'url' => 'https://docs.qbcore.org/qbcore-documentation/core-concepts/events', + 'description' => 'QBCore framework events for player and game actions', + 'keywords' => ['qbcore', 'event', 'trigger', 'listener'], + ], + ], ]; $results = []; @@ -161,7 +211,7 @@ class SearchFiveMDocs extends Tool ->required(), 'category' => $schema ->string() - ->enum(['all', 'scripting', 'natives', 'networking', 'resources']) + ->enum(['all', 'scripting', 'natives', 'networking', 'resources', 'qbcore']) ->description('Filter results by documentation category') ->default('all'), ]; diff --git a/resources/views/mcp/qbcore-event-list.blade.php b/resources/views/mcp/qbcore-event-list.blade.php new file mode 100644 index 0000000..626b741 --- /dev/null +++ b/resources/views/mcp/qbcore-event-list.blade.php @@ -0,0 +1,10 @@ +# QBCore Events + +@foreach($eventsByCategory as $category => $events) +## {{ ucfirst($category) }} Events + +@foreach($events as $event) +- **{{ $event['name'] }}** ({{ ucfirst($event['side']) }}) - {{ $event['description'] }} +@endforeach + +@endforeach diff --git a/resources/views/mcp/qbcore-event-reference.blade.php b/resources/views/mcp/qbcore-event-reference.blade.php new file mode 100644 index 0000000..4376bcf --- /dev/null +++ b/resources/views/mcp/qbcore-event-reference.blade.php @@ -0,0 +1,35 @@ +# QBCore Event Reference + +## {{ $event['name'] }} + +**Category:** {{ $event['category'] }} +**Side:** {{ ucfirst($event['side']) }} + +### Description +{{ $event['description'] }} + +### Parameters +@if(count($event['parameters']) > 0) +@foreach($event['parameters'] as $param) +- **{{ $param['name'] }}** ({{ $param['type'] }}): {{ $param['description'] }} +@endforeach +@else +This event takes no parameters. +@endif + +### Code Examples + +**Lua:** +```lua +{{ $event['lua_example'] }} +``` + +**JavaScript:** +```javascript +{{ $event['js_example'] }} +``` + +@if(isset($event['documentation'])) +### Documentation +[View at docs.qbcore.org]({{ $event['documentation'] }}) +@endif diff --git a/resources/views/mcp/qbcore-function.blade.php b/resources/views/mcp/qbcore-function.blade.php new file mode 100644 index 0000000..f88ada8 --- /dev/null +++ b/resources/views/mcp/qbcore-function.blade.php @@ -0,0 +1,48 @@ +# QBCore Function: {{ $function['name'] }} + +**Namespace:** {{ $function['namespace'] }} +**Side:** {{ ucfirst($function['side']) }} + +### Description +{{ $function['description'] }} + +### Parameters +@if(count($function['parameters']) > 0) +@foreach($function['parameters'] as $param) +- **{{ $param['name'] }}** ({{ $param['type'] }}): {{ $param['description'] }} +@endforeach +@else +This function takes no parameters. +@endif + +### Returns +**Type:** {{ $function['returns']['type'] }} +{{ $function['returns']['description'] }} + +### Code Examples + +@if($language === 'js') +**JavaScript:** +```javascript +{{ $function['js_example'] }} +``` +@else +**Lua:** +```lua +{{ $function['lua_example'] }} +``` +@endif + +### Alternative Example + +@if($language === 'js') +**Lua (alternative):** +```lua +{{ $function['lua_example'] }} +``` +@else +**JavaScript (alternative):** +```javascript +{{ $function['js_example'] }} +``` +@endif diff --git a/tests/Feature/GetQBCoreEventReferenceToolTest.php b/tests/Feature/GetQBCoreEventReferenceToolTest.php new file mode 100644 index 0000000..f187dfd --- /dev/null +++ b/tests/Feature/GetQBCoreEventReferenceToolTest.php @@ -0,0 +1,34 @@ + 'QBCore:Client:OnPlayerLoaded']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get qbcore event reference handles unknown event', function () { + $tool = new GetQBCoreEventReference(); + $request = new Request(['event_name' => 'NonExistentQBCoreEvent123']); + + $response = $tool->handle($request); + $content = (string) $response->content(); + + expect($content)->toContain('not found') || expect($content)->toContain('QBCore event'); +}); + +it('get qbcore event reference filters by category', function () { + $tool = new GetQBCoreEventReference(); + $request = new Request(['event_category' => 'player']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); diff --git a/tests/Feature/GetQBCoreFunctionToolTest.php b/tests/Feature/GetQBCoreFunctionToolTest.php new file mode 100644 index 0000000..3204420 --- /dev/null +++ b/tests/Feature/GetQBCoreFunctionToolTest.php @@ -0,0 +1,44 @@ + 'QBCore.Functions.GetPlayer']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get qbcore function handles unknown function', function () { + $tool = new GetQBCoreFunction(); + $request = new Request(['function_name' => 'NonExistentFunction123']); + + $response = $tool->handle($request); + $content = (string) $response->content(); + + expect($content)->toContain('not found') || expect($content)->toContain('QBCore'); +}); + +it('get qbcore function works with shorthand names', function () { + $tool = new GetQBCoreFunction(); + $request = new Request(['function_name' => 'AddMoney']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get qbcore function supports javascript examples', function () { + $tool = new GetQBCoreFunction(); + $request = new Request(['function_name' => 'AddMoney', 'language' => 'js']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +});