diff --git a/app/Mcp/Servers/FiveMServer.php b/app/Mcp/Servers/FiveMServer.php index 94540bf..1b44c24 100644 --- a/app/Mcp/Servers/FiveMServer.php +++ b/app/Mcp/Servers/FiveMServer.php @@ -11,15 +11,21 @@ use App\Mcp\Resources\BestPractices; use App\Mcp\Resources\CodeSnippets; use App\Mcp\Resources\DatabaseQueries; use App\Mcp\Resources\FrameworkComparison; -use App\Mcp\Tools\GenerateManifest; -use App\Mcp\Tools\GenerateResourceBoilerplate; -use App\Mcp\Tools\GetCOXEventReference; -use App\Mcp\Tools\GetCOXFunction; -use App\Mcp\Tools\GetEventReference; -use App\Mcp\Tools\GetNativeFunction; -use App\Mcp\Tools\GetQBCoreEventReference; -use App\Mcp\Tools\GetQBCoreFunction; -use App\Mcp\Tools\SearchFiveMDocs; +use App\Mcp\Tools\COX\Inventory\Client\GetInventoryClientFunction; +use App\Mcp\Tools\COX\Inventory\Server\GetInventoryServerFunction; +use App\Mcp\Tools\COX\MySQL\GetCOXEventReference; +use App\Mcp\Tools\COX\MySQL\GetCOXFunction; +use App\Mcp\Tools\FiveM\Client\GetEventClientReference; +use App\Mcp\Tools\FiveM\Client\GetNativeClientFunction; +use App\Mcp\Tools\FiveM\GenerateManifest; +use App\Mcp\Tools\FiveM\GenerateResourceBoilerplate; +use App\Mcp\Tools\FiveM\SearchFiveMDocs; +use App\Mcp\Tools\FiveM\Server\GetEventServerReference; +use App\Mcp\Tools\FiveM\Server\GetNativeServerFunction; +use App\Mcp\Tools\QBCore\Client\GetQBCoreClientEventReference; +use App\Mcp\Tools\QBCore\Client\GetQBCoreClientFunction; +use App\Mcp\Tools\QBCore\Server\GetQBCoreServerEventReference; +use App\Mcp\Tools\QBCore\Server\GetQBCoreServerFunction; use Laravel\Mcp\Server; use Laravel\Mcp\Server\Attributes\Instructions; use Laravel\Mcp\Server\Attributes\Name; @@ -44,14 +50,20 @@ class FiveMServer extends Server { protected array $tools = [ SearchFiveMDocs::class, - GetNativeFunction::class, GenerateManifest::class, - GetEventReference::class, GenerateResourceBoilerplate::class, - GetQBCoreEventReference::class, - GetQBCoreFunction::class, + GetNativeClientFunction::class, + GetNativeServerFunction::class, + GetEventClientReference::class, + GetEventServerReference::class, + GetQBCoreServerFunction::class, + GetQBCoreClientFunction::class, + GetQBCoreServerEventReference::class, + GetQBCoreClientEventReference::class, GetCOXEventReference::class, GetCOXFunction::class, + GetInventoryServerFunction::class, + GetInventoryClientFunction::class, ]; protected array $resources = [ diff --git a/app/Mcp/Tools/COX/Inventory/Client/GetInventoryClientFunction.php b/app/Mcp/Tools/COX/Inventory/Client/GetInventoryClientFunction.php new file mode 100644 index 0000000..8da27ae --- /dev/null +++ b/app/Mcp/Tools/COX/Inventory/Client/GetInventoryClientFunction.php @@ -0,0 +1,178 @@ +get('function_name'); + $language = $request->get('language', 'lua'); + + $function = $this->findFunction($functionName); + + if (! $function) { + return Response::text(sprintf("ox_inventory client function '%s' not found. Check ox_inventory documentation at https://coxdocs.dev/ox_inventory", $functionName)); + } + + $output = $this->formatFunctionInfo($function, $language); + + return Response::text($output); + } + + /** + * Find an ox_inventory client function. + */ + protected function findFunction(string $name): ?array + { + $functions = [ + 'openInventory' => [ + 'namespace' => 'Client', + 'description' => 'Opens an inventory using the passed data', + 'side' => 'client', + 'parameters' => [ + ['name' => 'invType', 'type' => 'string', 'description' => "Type: 'player', 'shop', 'stash', 'crafting', 'container', 'drop', 'glovebox', 'trunk', 'dumpster'"], + ['name' => 'data', 'type' => 'number|string|table', 'description' => 'Inventory data (playerId, stash name, etc.)'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "exports.ox_inventory:openInventory('player', 3)", + 'js_example' => "exports.ox_inventory.openInventory('player', 3);", + ], + 'SearchPlayer' => [ + 'namespace' => 'Client', + 'description' => 'Searches the player inventory for an item. Can return slots or count.', + 'side' => 'client', + 'parameters' => [ + ['name' => 'search', 'type' => 'string', 'description' => "'slots' or 'count'"], + ['name' => 'item', 'type' => 'table|string', 'description' => 'Item name or array of items'], + ['name' => 'metadata', 'type' => 'table|string|nil', 'description' => 'Metadata filter'], + ], + 'returns' => ['type' => 'table|number', 'description' => 'Slots or count depending on search type'], + 'lua_example' => "local count = exports.ox_inventory:SearchPlayer('count', 'water')\nprint('You have '..count..' water')", + 'js_example' => "const count = exports.ox_inventory.SearchPlayer('count', 'water');\nconsole.log(`You have \${count} water`);", + ], + 'GetCurrentWeapon' => [ + 'namespace' => 'Client', + 'description' => 'Get data for the currently equipped weapon', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'table|nil', 'description' => 'Weapon data or nil if no weapon equipped'], + 'lua_example' => "local weapon = exports.ox_inventory:GetCurrentWeapon()\nif weapon then\n print('Current weapon: '..weapon.name)\nend", + 'js_example' => "const weapon = exports.ox_inventory.GetCurrentWeapon();\nif (weapon) {\n console.log('Current weapon: ' + weapon.name);\n}", + ], + 'closeInventory' => [ + 'namespace' => 'Client', + 'description' => 'Closes the currently open inventory', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => 'exports.ox_inventory:closeInventory()', + 'js_example' => 'exports.ox_inventory.closeInventory();', + ], + 'useItem' => [ + 'namespace' => 'Client', + 'description' => 'Uses an item in the inventory. Triggers server-side item use callback.', + 'side' => 'client', + 'parameters' => [ + ['name' => 'item', 'type' => 'table', 'description' => 'Item data with slot and name'], + ['name' => 'cb', 'type' => 'function|nil', 'description' => 'Callback function after use'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "local item = {slot = 1, name = 'water'}\nexports.ox_inventory:useItem(item)", + 'js_example' => "const item = {slot: 1, name: 'water'};\nexports.ox_inventory.useItem(item);", + ], + 'displayMetadata' => [ + 'namespace' => 'Client', + 'description' => 'Shows metadata information for an item', + 'side' => 'client', + 'parameters' => [ + ['name' => 'metadata', 'type' => 'table', 'description' => 'Metadata table to display'], + ], + 'returns' => ['type' => 'table', 'description' => 'Formatted metadata for display'], + 'lua_example' => "local formatted = exports.ox_inventory:displayMetadata({serial = 'ABC123', owner = 'John'})", + 'js_example' => "const formatted = exports.ox_inventory.displayMetadata({serial: 'ABC123', owner: 'John'});", + ], + 'Items' => [ + 'namespace' => 'Client', + 'description' => 'Register client-side usable items with callbacks', + 'side' => 'client', + 'parameters' => [ + ['name' => 'itemName', 'type' => 'string', 'description' => 'Name of the item to register'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Function(data, slot) called when item is used'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "exports.ox_inventory:Items('bandage', function(data, slot)\n -- Apply bandage healing logic\n print('Used bandage from slot '..slot)\nend)", + 'js_example' => "exports.ox_inventory.Items('bandage', (data, slot) => {\n // Apply bandage healing logic\n console.log(`Used bandage from slot \${slot}`);\n});", + ], + 'getCurrentWeight' => [ + 'namespace' => 'Client', + 'description' => 'Returns the current total weight of the player inventory', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'number', 'description' => 'Current weight in grams'], + 'lua_example' => "local weight = exports.ox_inventory:getCurrentWeight()\nprint('Current inventory weight: '..weight..'g')", + 'js_example' => "const weight = exports.ox_inventory.getCurrentWeight();\nconsole.log(`Current inventory weight: \${weight}g`);", + ], + 'getPlayerInventory' => [ + 'namespace' => 'Client', + 'description' => 'Returns the full player inventory data', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'table', 'description' => 'Complete inventory data'], + 'lua_example' => "local inventory = exports.ox_inventory:getPlayerInventory()\nprint(json.encode(inventory, {indent=true}))", + 'js_example' => "const inventory = exports.ox_inventory.getPlayerInventory();\nconsole.log(JSON.stringify(inventory, null, 2));", + ], + ]; + + $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.cox-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 ox_inventory client function to look up (e.g., "openInventory", "SearchPlayer", "useItem", "closeInventory")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/COX/Inventory/Server/GetInventoryServerFunction.php b/app/Mcp/Tools/COX/Inventory/Server/GetInventoryServerFunction.php new file mode 100644 index 0000000..60bf47a --- /dev/null +++ b/app/Mcp/Tools/COX/Inventory/Server/GetInventoryServerFunction.php @@ -0,0 +1,337 @@ +get('function_name'); + $language = $request->get('language', 'lua'); + + $function = $this->findFunction($functionName); + + if (! $function) { + return Response::text(sprintf("ox_inventory server function '%s' not found. Check ox_inventory documentation at https://coxdocs.dev/ox_inventory", $functionName)); + } + + $output = $this->formatFunctionInfo($function, $language); + + return Response::text($output); + } + + /** + * Find an ox_inventory server function. + */ + protected function findFunction(string $name): ?array + { + $functions = [ + 'AddItem' => [ + 'namespace' => 'Server', + 'description' => 'Adds an item into the specified inventory. Should be used alongside CanCarryItem.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory unique id, playerId, or table with id and owner'], + ['name' => 'item', 'type' => 'string', 'description' => 'Name of the item to add'], + ['name' => 'count', 'type' => 'number', 'description' => 'Number of items to add'], + ['name' => 'metadata', 'type' => 'table|string|nil', 'description' => 'Unique data to attach to item. String creates table with "type" field'], + ['name' => 'slot', 'type' => 'number|nil', 'description' => 'Specific slot to add item to'], + ['name' => 'cb', 'type' => 'function|nil', 'description' => 'Callback function(success, response)'], + ], + 'returns' => ['type' => 'boolean, string|table', 'description' => 'success and response (or via callback)'], + 'lua_example' => "local success, response = exports.ox_inventory:AddItem('gloveVGH283', 'bread', 4)\nif not success then\n return print(response) -- 'invalid_item', 'invalid_inventory', 'inventory_full'\nend\nprint(json.encode(response, {indent=true}))", + 'js_example' => "const [success, response] = exports.ox_inventory.AddItem('gloveVGH283', 'bread', 4);\nif (!success) {\n return console.log(response);\n}\nconsole.log(JSON.stringify(response, null, 2));", + ], + 'RemoveItem' => [ + 'namespace' => 'Server', + 'description' => 'Removes the specified item from the specified inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory unique id, playerId, or table'], + ['name' => 'item', 'type' => 'string', 'description' => 'Name of the item to remove'], + ['name' => 'count', 'type' => 'number', 'description' => 'Number of items to remove'], + ['name' => 'metadata', 'type' => 'table|string|nil', 'description' => 'Only remove items with matching metadata'], + ['name' => 'slot', 'type' => 'number|nil', 'description' => 'Specific slot to remove from'], + ['name' => 'ignoreTotal', 'type' => 'boolean|nil', 'description' => 'Removes as many as possible up to count'], + ['name' => 'strict', 'type' => 'boolean|nil', 'description' => 'Exact match on metadata (default true)'], + ], + 'returns' => ['type' => 'boolean, string', 'description' => 'success and optional error message'], + 'lua_example' => "local success = exports.ox_inventory:RemoveItem('gloveVGH283', 'water', 2)\nif not success then\n print('Failed to remove item')\nend", + 'js_example' => "const success = exports.ox_inventory.RemoveItem('gloveVGH283', 'water', 2);\nif (!success) {\n console.log('Failed to remove item');\n}", + ], + 'GetItem' => [ + 'namespace' => 'Server', + 'description' => 'Returns generic item data from the specified inventory with total count', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'item', 'type' => 'table|string', 'description' => 'Item name or array of item names'], + ['name' => 'metadata', 'type' => 'any|nil', 'description' => 'Only count items matching metadata'], + ['name' => 'returnsCount', 'type' => 'boolean|nil', 'description' => 'If true, returns count only'], + ], + 'returns' => ['type' => 'table|number', 'description' => 'Item data with count, or just count if returnsCount=true'], + 'lua_example' => "local item = ox_inventory:GetItem(source, 'water', nil, false)\nprint(json.encode(item, {indent=true}))", + 'js_example' => "const item = ox_inventory.GetItem(source, 'water', null, false);\nconsole.log(JSON.stringify(item, null, 2));", + ], + 'CanCarryItem' => [ + 'namespace' => 'Server', + 'description' => 'Returns true or false depending if inventory can carry the specified item. Checks weight and slots.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'item', 'type' => 'table|string', 'description' => 'Item name or array of items'], + ['name' => 'count', 'type' => 'number', 'description' => 'Number of items'], + ['name' => 'metadata', 'type' => 'table|string|nil', 'description' => 'Item metadata'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'True if can carry, false otherwise'], + 'lua_example' => "if exports.ox_inventory:CanCarryItem(source, 'water', 3) then\n -- Do stuff if can carry\nelse\n -- Do stuff if can't carry\nend", + 'js_example' => "if (exports.ox_inventory.CanCarryItem(source, 'water', 3)) {\n // Do stuff if can carry\n} else {\n // Do stuff if can't carry\n}", + ], + 'GetInventory' => [ + 'namespace' => 'Server', + 'description' => 'Returns the inventory associated with the ID and owner. Returns null if not found.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'number|table', 'description' => 'Inventory identifier'], + ['name' => 'owner', 'type' => 'string|boolean|nil', 'description' => 'Owner identifier'], + ], + 'returns' => ['type' => 'table|nil', 'description' => 'Inventory data or nil'], + 'lua_example' => "local inventory = exports.ox_inventory:GetInventory('example_stash', false)\nprint(json.encode(inventory, {indent = true}))", + 'js_example' => "const inventory = exports.ox_inventory.GetInventory('example_stash', false);\nconsole.log(JSON.stringify(inventory, null, 2));", + ], + 'RegisterStash' => [ + 'namespace' => 'Server', + 'description' => 'Creates a new custom stash. Must be called before player can open the stash.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'id', 'type' => 'string|number', 'description' => 'Stash identifier for database'], + ['name' => 'label', 'type' => 'string', 'description' => 'Display name when inventory is open'], + ['name' => 'slots', 'type' => 'number', 'description' => 'Number of slots'], + ['name' => 'maxWeight', 'type' => 'number', 'description' => 'Maximum weight in grams'], + ['name' => 'owner', 'type' => 'string|boolean|nil', 'description' => 'Owner: string=specific, true=per-player, nil=shared'], + ['name' => 'groups', 'type' => 'table|nil', 'description' => 'Table of jobs with minimum grades'], + ['name' => 'coords', 'type' => 'vector3|table|nil', 'description' => 'Coordinates for proximity check'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "exports.ox_inventory:RegisterStash('policestash', 'Police Storage', 50, 100000, false, {['police'] = 0})", + 'js_example' => "exports.ox_inventory.RegisterStash('policestash', 'Police Storage', 50, 100000, false, {police: 0});", + ], + 'Search' => [ + 'namespace' => 'Server', + 'description' => 'Searches an inventory for a specified item. Can return slots or count.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'search', 'type' => 'string', 'description' => "'slots' or 'count'"], + ['name' => 'item', 'type' => 'table|string', 'description' => 'Item name or array of names'], + ['name' => 'metadata', 'type' => 'table|string|nil', 'description' => 'Item metadata filter'], + ], + 'returns' => ['type' => 'table|number', 'description' => 'Slots data or count depending on search type'], + 'lua_example' => "local slots = exports.ox_inventory:Search(source, 'slots', 'water')\nfor k, v in pairs(slots) do\n print(v.slot..' contains '..v.count..' water')\nend", + 'js_example' => "const slots = exports.ox_inventory.Search(source, 'slots', 'water');\nfor (const [k, v] of Object.entries(slots)) {\n console.log(`\${v.slot} contains \${v.count} water`);\n}", + ], + 'SetItem' => [ + 'namespace' => 'Server', + 'description' => 'Sets data for a specific item slot in an inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'slot', 'type' => 'number', 'description' => 'Slot number to modify'], + ['name' => 'item', 'type' => 'table', 'description' => 'Item data to set'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "exports.ox_inventory:SetItem(source, 1, {name = 'water', count = 5})", + 'js_example' => "exports.ox_inventory.SetItem(source, 1, {name: 'water', count: 5});", + ], + 'ClearInventory' => [ + 'namespace' => 'Server', + 'description' => 'Removes all items from the specified inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'filterItem', 'type' => 'string|nil', 'description' => 'Optional item name to keep'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "exports.ox_inventory:ClearInventory(source) -- Clear all items\nexports.ox_inventory:ClearInventory(source, 'id_card') -- Clear all except id_card", + 'js_example' => "exports.ox_inventory.ClearInventory(source); // Clear all items\nexports.ox_inventory.ClearInventory(source, 'id_card'); // Clear all except id_card", + ], + 'ConfiscateInventory' => [ + 'namespace' => 'Server', + 'description' => 'Temporarily removes all items from inventory and stores them for later return', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local success = exports.ox_inventory:ConfiscateInventory(source)\nif success then\n print('Inventory confiscated')\nend", + 'js_example' => "const success = exports.ox_inventory.ConfiscateInventory(source);\nif (success) {\n console.log('Inventory confiscated');\n}", + ], + 'ReturnInventory' => [ + 'namespace' => 'Server', + 'description' => 'Returns previously confiscated items to the inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local success = exports.ox_inventory:ReturnInventory(source)\nif success then\n print('Inventory returned')\nend", + 'js_example' => "const success = exports.ox_inventory.ReturnInventory(source);\nif (success) {\n console.log('Inventory returned');\n}", + ], + 'SetDurability' => [ + 'namespace' => 'Server', + 'description' => 'Sets the durability value for an item in a specific slot', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'slot', 'type' => 'number', 'description' => 'Slot number'], + ['name' => 'durability', 'type' => 'number', 'description' => 'Durability value (0-100)'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => 'exports.ox_inventory:SetDurability(source, 1, 50) -- Set to 50% durability', + 'js_example' => 'exports.ox_inventory.SetDurability(source, 1, 50); // Set to 50% durability', + ], + 'SetMetadata' => [ + 'namespace' => 'Server', + 'description' => 'Updates metadata for an item in a specific slot', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'slot', 'type' => 'number', 'description' => 'Slot number'], + ['name' => 'metadata', 'type' => 'table', 'description' => 'New metadata table'], + ], + 'returns' => ['type' => 'boolean, table', 'description' => 'Success status and updated item data'], + 'lua_example' => "local success, item = exports.ox_inventory:SetMetadata(source, 1, {serial = 'ABC123', registered = 'John Doe'})", + 'js_example' => "const [success, item] = exports.ox_inventory.SetMetadata(source, 1, {serial: 'ABC123', registered: 'John Doe'});", + ], + 'SwapSlots' => [ + 'namespace' => 'Server', + 'description' => 'Swaps items between two slots in an inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'fromSlot', 'type' => 'number', 'description' => 'Source slot number'], + ['name' => 'toSlot', 'type' => 'number', 'description' => 'Destination slot number'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => 'exports.ox_inventory:SwapSlots(source, 1, 5) -- Swap items in slots 1 and 5', + 'js_example' => 'exports.ox_inventory.SwapSlots(source, 1, 5); // Swap items in slots 1 and 5', + ], + 'SetMaxWeight' => [ + 'namespace' => 'Server', + 'description' => 'Sets the maximum weight capacity for an inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'maxWeight', 'type' => 'number', 'description' => 'Maximum weight in grams'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => 'exports.ox_inventory:SetMaxWeight(source, 50000) -- Set max weight to 50kg', + 'js_example' => 'exports.ox_inventory.SetMaxWeight(source, 50000); // Set max weight to 50kg', + ], + 'GetItemCount' => [ + 'namespace' => 'Server', + 'description' => 'Returns the total count of a specific item in an inventory', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], + ['name' => 'metadata', 'type' => 'table|nil', 'description' => 'Optional metadata filter'], + ], + 'returns' => ['type' => 'number', 'description' => 'Total count of the item'], + 'lua_example' => "local count = exports.ox_inventory:GetItemCount(source, 'water')\nprint('Player has '..count..' water')", + 'js_example' => "const count = exports.ox_inventory.GetItemCount(source, 'water');\nconsole.log(`Player has \${count} water`);", + ], + 'GetSlotWeight' => [ + 'namespace' => 'Server', + 'description' => 'Returns the weight of an item in a specific slot', + 'side' => 'server', + 'parameters' => [ + ['name' => 'inv', 'type' => 'table|string|number', 'description' => 'Inventory identifier'], + ['name' => 'slot', 'type' => 'number', 'description' => 'Slot number'], + ], + 'returns' => ['type' => 'number', 'description' => 'Weight in grams'], + 'lua_example' => "local weight = exports.ox_inventory:GetSlotWeight(source, 1)\nprint('Slot 1 weight: '..weight..'g')", + 'js_example' => "const weight = exports.ox_inventory.GetSlotWeight(source, 1);\nconsole.log(`Slot 1 weight: \${weight}g`);", + ], + 'CustomDrop' => [ + 'namespace' => 'Server', + 'description' => 'Creates a custom drop inventory at specific coordinates', + 'side' => 'server', + 'parameters' => [ + ['name' => 'prefix', 'type' => 'string', 'description' => 'Prefix for drop ID'], + ['name' => 'items', 'type' => 'table', 'description' => 'Array of items to add'], + ['name' => 'coords', 'type' => 'vector3', 'description' => 'Drop coordinates'], + ['name' => 'slots', 'type' => 'number|nil', 'description' => 'Number of slots (default config)'], + ['name' => 'maxWeight', 'type' => 'number|nil', 'description' => 'Max weight (default config)'], + ['name' => 'model', 'type' => 'string|number|nil', 'description' => 'Model hash for drop'], + ], + 'returns' => ['type' => 'string', 'description' => 'Drop inventory ID'], + 'lua_example' => "local dropId = exports.ox_inventory:CustomDrop('evidence', {{name='phone', count=1}}, vector3(100.0, 200.0, 30.0))", + 'js_example' => "const dropId = exports.ox_inventory.CustomDrop('evidence', [{name: 'phone', count: 1}], [100.0, 200.0, 30.0]);", + ], + 'ConvertItems' => [ + 'namespace' => 'Server', + 'description' => 'Converts old items to new items with metadata (for migration)', + 'side' => 'server', + 'parameters' => [ + ['name' => 'playerId', 'type' => 'number', 'description' => 'Player server ID'], + ['name' => 'items', 'type' => 'table', 'description' => 'Array of items to convert'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'Success status'], + 'lua_example' => "local items = {{name='old_phone', count=1, info={}}}\nexports.ox_inventory:ConvertItems(source, items)", + 'js_example' => "const items = [{name: 'old_phone', count: 1, info: {}}];\nexports.ox_inventory.ConvertItems(source, items);", + ], + ]; + + $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.cox-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 ox_inventory server function to look up (e.g., "AddItem", "RemoveItem", "GetItem", "RegisterStash", "SetDurability", "SetMetadata")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/GetCOXEventReference.php b/app/Mcp/Tools/COX/MySQL/GetCOXEventReference.php similarity index 99% rename from app/Mcp/Tools/GetCOXEventReference.php rename to app/Mcp/Tools/COX/MySQL/GetCOXEventReference.php index f0a2a8f..cb9baa0 100644 --- a/app/Mcp/Tools/GetCOXEventReference.php +++ b/app/Mcp/Tools/COX/MySQL/GetCOXEventReference.php @@ -1,6 +1,6 @@ get('function_name'); + $language = $request->get('language', 'lua'); + + $function = $this->findFunction($functionName); + + if (! $function) { + return Response::text(sprintf("COX function '%s' not found. Check COX documentation at https://coxdocs.dev/", $functionName)); + } + + $output = $this->formatFunctionInfo($function, $language); + + return Response::text($output); + } + + /** + * Find a COX function. + */ + protected function findFunction(string $name): ?array + { + $functions = [ + // Query Methods + 'MySQL.query' => [ + 'namespace' => 'Query', + 'description' => 'Execute a MySQL query with optional parameters. When selecting data, returns all matching rows; otherwise returns data like insertId, affectedRows, etc.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query with ? placeholders for prepared statements'], + ['name' => 'params', 'type' => 'table|nil', 'description' => 'Array of parameters to bind to placeholders'], + ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback function that receives the query result'], + ], + 'returns' => ['type' => 'table|nil', 'description' => 'Query result (rows for SELECT, or metadata for INSERT/UPDATE/DELETE)'], + 'lua_example' => "MySQL.query('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {\n identifier\n}, function(response)\n if response then\n for i = 1, #response do\n local row = response[i]\n print(row.firstname, row.lastname)\n end\n end\nend)", + 'js_example' => "MySQL.query('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', [\n identifier\n], (response) => {\n if (response) {\n response.forEach(row => {\n console.log(row.firstname, row.lastname);\n });\n }\n});", + ], + 'MySQL.insert' => [ + 'namespace' => 'Query', + 'description' => 'Insert a row into the database and get the insert ID', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'INSERT SQL query with ? placeholders'], + ['name' => 'params', 'type' => 'table|nil', 'description' => 'Array of parameters to bind to placeholders'], + ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback function that receives the insert ID'], + ], + 'returns' => ['type' => 'number', 'description' => 'Insert ID (in callback mode) or awaitable insert ID (in promise mode)'], + 'lua_example' => "MySQL.insert('INSERT INTO `users` (identifier, firstname, lastname) VALUES (?, ?, ?)', {\n identifier, firstName, lastName\n}, function(id)\n print('Inserted with ID: ' .. id)\nend)", + 'js_example' => "MySQL.insert('INSERT INTO `users` (identifier, firstname, lastname) VALUES (?, ?, ?)', [\n identifier, firstName, lastName\n], (id) => {\n console.log('Inserted with ID: ' + id);\n});", + ], + 'MySQL.update' => [ + 'namespace' => 'Query', + 'description' => 'Update rows in the database and get the number of affected rows', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'UPDATE SQL query with ? placeholders'], + ['name' => 'params', 'type' => 'table|nil', 'description' => 'Array of parameters to bind to placeholders'], + ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback function that receives affected rows count'], + ], + 'returns' => ['type' => 'number', 'description' => 'Number of affected rows (in callback mode) or awaitable affected rows (in promise mode)'], + 'lua_example' => "MySQL.update('UPDATE users SET firstname = ? WHERE identifier = ?', {\n newName, identifier\n}, function(affectedRows)\n print('Updated ' .. affectedRows .. ' rows')\nend)", + 'js_example' => "MySQL.update('UPDATE users SET firstname = ? WHERE identifier = ?', [\n newName, identifier\n], (affectedRows) => {\n console.log(`Updated \${affectedRows} rows`);\n});", + ], + 'MySQL.scalar' => [ + 'namespace' => 'Query', + 'description' => 'Returns the first column for a single row', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query with ? placeholders'], + ['name' => 'params', 'type' => 'table|nil', 'description' => 'Query parameters'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Callback that receives the scalar value'], + ], + 'returns' => ['type' => 'any', 'description' => 'Single value from the first column of the first row'], + 'lua_example' => "MySQL.scalar('SELECT `firstname` FROM `users` WHERE `identifier` = ? LIMIT 1', {\n identifier\n}, function(firstName)\n print(firstName)\nend)", + 'js_example' => "MySQL.scalar('SELECT `firstname` FROM `users` WHERE `identifier` = ? LIMIT 1', [\n identifier\n], (firstName) => {\n console.log(firstName);\n});", + ], + 'MySQL.single' => [ + 'namespace' => 'Query', + 'description' => 'Returns all selected columns for a single row', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query with ? placeholders'], + ['name' => 'params', 'type' => 'table|nil', 'description' => 'Query parameters'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Callback that receives the row data'], + ], + 'returns' => ['type' => 'table|nil', 'description' => 'Single row object or nil if no results'], + 'lua_example' => "MySQL.single('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ? LIMIT 1', {\n identifier\n}, function(row)\n if not row then return end\n print(row.firstname, row.lastname)\nend)", + 'js_example' => "MySQL.single('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ? LIMIT 1', [\n identifier\n], (row) => {\n if (!row) return;\n console.log(row.firstname, row.lastname);\n});", + ], + + // Transaction Methods + 'MySQL.transaction' => [ + 'namespace' => 'Transaction', + 'description' => 'Execute multiple queries as a transaction. If one fails, none are committed. Returns boolean indicating success.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'queries', 'type' => 'table', 'description' => 'Array of query objects with query and values/parameters'], + ['name' => 'values', 'type' => 'table|function|nil', 'description' => 'Shared parameters for all queries (optional) or callback function'], + ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback that receives boolean success result'], + ], + 'returns' => ['type' => 'boolean', 'description' => 'True if transaction succeeded, false otherwise'], + 'lua_example' => "-- Specific format (unique params per query)\nlocal queries = {\n { query = 'INSERT INTO `test` (id) VALUES (?)', values = { 1 } },\n { query = 'INSERT INTO `test` (id, name) VALUES (?, ?)', values = { 2, 'bob' } },\n}\nMySQL.transaction(queries, function(success)\n print(success)\nend)", + 'js_example' => "// Specific format (unique params per query)\nconst queries = [\n { query: 'INSERT INTO `test` (id) VALUES (?)', values: [1] },\n { query: 'INSERT INTO `test` (id, name) VALUES (?, ?)', values: [2, 'bob'] },\n];\nMySQL.transaction(queries, (success) => {\n console.log(success);\n});", + ], + + // Prepared Statements + 'MySQL.prepare' => [ + 'namespace' => 'Prepared', + 'description' => 'Execute frequently called queries faster. Accepts multiple sets of parameters. Only supports ? value placeholders. Return format matches query/single/scalar based on result shape.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'SQL with ? value placeholders (no ?? column or named placeholders)'], + ['name' => 'params', 'type' => 'table', 'description' => 'Parameters to bind'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Callback that receives results'], + ], + 'returns' => ['type' => 'any', 'description' => 'Returns column, row, or array of rows depending on SELECT result shape'], + 'lua_example' => "MySQL.prepare('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {\n identifier\n}, function(response)\n print(json.encode(response, { indent = true, sort_keys = true }))\nend)", + 'js_example' => "MySQL.prepare('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', [\n identifier\n], (response) => {\n console.log(JSON.stringify(response, null, 2));\n});", + ], + 'MySQL.rawExecute' => [ + 'namespace' => 'Prepared', + 'description' => 'Execute frequently called queries faster. Unlike prepare, SELECT always returns array of rows. Only supports ? value placeholders. Date and TINYINT/BIT types are not converted.', + 'side' => 'server', + 'parameters' => [ + ['name' => 'sql', 'type' => 'string', 'description' => 'SQL with ? value placeholders only'], + ['name' => 'params', 'type' => 'table', 'description' => 'Parameters to bind'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Callback that receives results'], + ], + 'returns' => ['type' => 'table', 'description' => 'Always returns array of rows for SELECT'], + 'lua_example' => "MySQL.rawExecute('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {\n identifier\n}, function(response)\n print(json.encode(response, { indent = true, sort_keys = true }))\nend)", + 'js_example' => "MySQL.rawExecute('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', [\n identifier\n], (response) => {\n console.log(JSON.stringify(response, null, 2));\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.cox-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 COX function to look up (e.g., "MySQL.query", "MySQL.insert", "MySQL.transaction.begin")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/GetEventReference.php b/app/Mcp/Tools/FiveM/Client/GetEventClientReference.php similarity index 70% rename from app/Mcp/Tools/GetEventReference.php rename to app/Mcp/Tools/FiveM/Client/GetEventClientReference.php index f01b12b..e866d29 100644 --- a/app/Mcp/Tools/GetEventReference.php +++ b/app/Mcp/Tools/FiveM/Client/GetEventClientReference.php @@ -1,6 +1,6 @@ 'onResourceStart', 'type' => 'core', - 'side' => 'both', - 'description' => 'Triggered when a resource starts', + 'side' => 'client', + 'description' => 'Triggered when a resource starts (client-side)', 'parameters' => [ ['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that started'], ], - 'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started!')\n end\nend)", - 'js_example' => "on('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started!');\n }\n});", + 'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started on client!')\n end\nend)", + 'js_example' => "on('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started on client!');\n }\n});", 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStart/', ], [ 'name' => 'onResourceStop', 'type' => 'core', - 'side' => 'both', - 'description' => 'Triggered when a resource stops', + 'side' => 'client', + 'description' => 'Triggered when a resource stops (client-side)', 'parameters' => [ ['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that stopped'], ], - 'lua_example' => "AddEventHandler('onResourceStop', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource stopping!')\n end\nend)", - 'js_example' => "on('onResourceStop', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource stopping!');\n }\n});", + 'lua_example' => "AddEventHandler('onResourceStop', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource stopped on client!')\n end\nend)", + 'js_example' => "on('onResourceStop', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource stopped on client!');\n }\n});", 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/', ], - [ - 'name' => 'playerConnecting', - 'type' => 'core', - 'side' => 'server', - 'description' => 'Triggered when a player is connecting to the server', - 'parameters' => [ - ['name' => 'name', 'type' => 'string', 'description' => 'Player name'], - ['name' => 'setKickReason', 'type' => 'function', 'description' => 'Function to deny connection'], - ['name' => 'deferrals', 'type' => 'object', 'description' => 'Deferrals object for async connection'], - ], - 'lua_example' => "AddEventHandler('playerConnecting', function(name, setKickReason, deferrals)\n local source = source\n deferrals.defer()\n -- Check player\n deferrals.done()\nend)", - 'js_example' => "on('playerConnecting', (name, setKickReason, deferrals) => {\n const source = global.source;\n deferrals.defer();\n // Check player\n deferrals.done();\n});", - 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerConnecting/', - ], - [ - 'name' => 'playerDropped', - 'type' => 'core', - 'side' => 'server', - 'description' => 'Triggered when a player disconnects from the server', - 'parameters' => [ - ['name' => 'reason', 'type' => 'string', 'description' => 'Disconnect reason'], - ], - 'lua_example' => "AddEventHandler('playerDropped', function(reason)\n local source = source\n print('Player ' .. GetPlayerName(source) .. ' dropped: ' .. reason)\nend)", - 'js_example' => "on('playerDropped', (reason) => {\n const source = global.source;\n console.log(`Player \${GetPlayerName(source)} dropped: \${reason}`);\n});", - 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerDropped/', - ], - // ESX Events + // ESX Client Events [ 'name' => 'esx:playerLoaded', 'type' => 'esx', @@ -157,7 +131,7 @@ class GetEventReference extends Tool 'lua_example' => "RegisterNetEvent('esx:setJob', function(job)\n ESX.PlayerData.job = job\n print('Job changed to: ' .. job.name)\nend)", 'js_example' => "RegisterNetEvent('esx:setJob', (job) => {\n ESX.PlayerData.job = job;\n console.log(`Job changed to: \${job.name}`);\n});", ], - // QBCore Events + // QBCore Client Events [ 'name' => 'QBCore:Client:OnPlayerLoaded', 'type' => 'qbcore', @@ -191,7 +165,7 @@ class GetEventReference extends Tool return [ 'event_name' => $schema ->string() - ->description('Specific event name to look up (optional, leave empty to list all events)'), + ->description('Specific client event name to look up (optional, leave empty to list all events)'), 'event_type' => $schema ->string() ->enum(['all', 'core', 'esx', 'qbcore']) diff --git a/app/Mcp/Tools/GetNativeFunction.php b/app/Mcp/Tools/FiveM/Client/GetNativeClientFunction.php similarity index 67% rename from app/Mcp/Tools/GetNativeFunction.php rename to app/Mcp/Tools/FiveM/Client/GetNativeClientFunction.php index e7df1c6..4174fbb 100644 --- a/app/Mcp/Tools/GetNativeFunction.php +++ b/app/Mcp/Tools/FiveM/Client/GetNativeClientFunction.php @@ -1,6 +1,6 @@ findNative($functionName); if (! $native) { - return Response::text(sprintf("Native function '%s' not found. Try searching at https://docs.fivem.net/natives/", $functionName)); + return Response::text(sprintf("Client native function '%s' not found. Try searching at https://docs.fivem.net/natives/", $functionName)); } $output = $this->formatNativeInfo($native, $language); @@ -31,16 +31,17 @@ class GetNativeFunction extends Tool } /** - * Find a native function. + * Find a client native function. */ protected function findNative(string $name): ?array { - // Common FiveM/GTA5 natives database + // Client-side only FiveM natives $natives = [ // Player/Ped natives 'GetPlayerPed' => [ 'namespace' => 'PLAYER', 'description' => 'Gets the local or specified player\'s ped handle', + 'side' => 'client', 'parameters' => [ ['name' => 'playerId', 'type' => 'int', 'description' => 'The player ID, or -1 for local player'], ], @@ -48,9 +49,19 @@ class GetNativeFunction extends Tool 'lua_example' => 'local playerPed = GetPlayerPed(-1)', 'js_example' => 'const playerPed = GetPlayerPed(-1);', ], + 'PlayerPedId' => [ + 'namespace' => 'PLAYER', + 'description' => 'Returns the ped ID of the local player', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'int', 'description' => 'The local player ped ID'], + 'lua_example' => 'local playerPed = PlayerPedId()', + 'js_example' => 'const playerPed = PlayerPedId();', + ], 'GetPlayerName' => [ 'namespace' => 'PLAYER', - 'description' => 'Returns the name of a player', + 'description' => 'Returns the name of a player (client-side lookup)', + 'side' => 'client', 'parameters' => [ ['name' => 'playerId', 'type' => 'int', 'description' => 'The player ID'], ], @@ -58,9 +69,19 @@ class GetNativeFunction extends Tool 'lua_example' => 'local name = GetPlayerName(PlayerId())', 'js_example' => 'const name = GetPlayerName(PlayerId());', ], + 'PlayerId' => [ + 'namespace' => 'PLAYER', + 'description' => 'Gets the local player ID on client', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'int', 'description' => 'The local player ID'], + 'lua_example' => 'local playerId = PlayerId()', + 'js_example' => 'const playerId = PlayerId();', + ], 'SetEntityCoords' => [ 'namespace' => 'ENTITY', - 'description' => 'Sets the coordinates of an entity', + 'description' => 'Sets the coordinates of an entity (client-side)', + 'side' => 'client', 'parameters' => [ ['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle'], ['name' => 'x', 'type' => 'float', 'description' => 'X coordinate'], @@ -78,6 +99,7 @@ class GetNativeFunction extends Tool 'GetEntityCoords' => [ 'namespace' => 'ENTITY', 'description' => 'Gets the coordinates of an entity', + 'side' => 'client', 'parameters' => [ ['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle'], ['name' => 'alive', 'type' => 'boolean', 'description' => 'Whether to get alive coordinates only'], @@ -86,19 +108,21 @@ class GetNativeFunction extends Tool 'lua_example' => 'local coords = GetEntityCoords(PlayerPedId(), true)', 'js_example' => 'const coords = GetEntityCoords(PlayerPedId(), true);', ], - 'RegisterNetEvent' => [ - 'namespace' => 'CFX', - 'description' => 'Registers a network event handler (FiveM-specific)', + 'DeleteEntity' => [ + 'namespace' => 'ENTITY', + 'description' => 'Deletes an entity (network delete for networked entities)', + 'side' => 'client', 'parameters' => [ - ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle to delete'], ], 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "RegisterNetEvent('myResource:eventName', function(param1, param2)\n -- Handle event\nend)", - 'js_example' => "RegisterNetEvent('myResource:eventName', (param1, param2) => {\n // Handle event\n});", + 'lua_example' => 'DeleteEntity(ped)', + 'js_example' => 'DeleteEntity(ped);', ], 'TriggerServerEvent' => [ 'namespace' => 'CFX', 'description' => 'Triggers an event on the server from client', + 'side' => 'client', 'parameters' => [ ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], @@ -107,21 +131,21 @@ class GetNativeFunction extends Tool 'lua_example' => "TriggerServerEvent('myResource:serverEvent', arg1, arg2)", 'js_example' => "TriggerServerEvent('myResource:serverEvent', arg1, arg2);", ], - 'TriggerClientEvent' => [ + 'RegisterNetEvent' => [ 'namespace' => 'CFX', - 'description' => 'Triggers an event on a client from server', + 'description' => 'Registers a network event handler (client-side)', + 'side' => 'client', 'parameters' => [ ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], - ['name' => 'playerId', 'type' => 'int|string', 'description' => 'The player server ID or -1 for all'], - ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], ], 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "TriggerClientEvent('myResource:clientEvent', playerId, arg1, arg2)", - 'js_example' => "TriggerClientEvent('myResource:clientEvent', playerId, arg1, arg2);", + 'lua_example' => "RegisterNetEvent('myResource:clientEvent')\nAddEventHandler('myResource:clientEvent', function(param1, param2)\n -- Handle event\nend)", + 'js_example' => "RegisterNetEvent('myResource:clientEvent');\nAddEventHandler('myResource:clientEvent', (param1, param2) => {\n // Handle event\n});", ], 'AddEventHandler' => [ 'namespace' => 'CFX', 'description' => 'Adds an event handler for local events', + 'side' => 'client', 'parameters' => [ ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], ['name' => 'callback', 'type' => 'function', 'description' => 'The handler function'], @@ -130,25 +154,26 @@ class GetNativeFunction extends Tool 'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started!')\n end\nend)", 'js_example' => "AddEventHandler('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started!');\n }\n});", ], - 'ESX.GetPlayerFromId' => [ - 'namespace' => 'ESX', - 'description' => 'Get ESX player object from server ID (server-side)', - 'parameters' => [ - ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], - ], - 'returns' => ['type' => 'table', 'description' => 'ESX player object'], - 'lua_example' => 'local xPlayer = ESX.GetPlayerFromId(source)', - 'js_example' => 'const xPlayer = ESX.GetPlayerFromId(source);', + 'GetCurrentResourceName' => [ + 'namespace' => 'CFX', + 'description' => 'Returns the name of the currently executing resource', + 'side' => 'client', + 'parameters' => [], + 'returns' => ['type' => 'string', 'description' => 'The resource name'], + 'lua_example' => "local resName = GetCurrentResourceName()\nprint('Current resource: ' .. resName)", + 'js_example' => "const resName = GetCurrentResourceName();\nconsole.log('Current resource: ' + resName);", ], - 'QBCore.Functions.GetPlayer' => [ - 'namespace' => 'QBCore', - 'description' => 'Get QBCore player object from server ID (server-side)', + 'TriggerEvent' => [ + 'namespace' => 'CFX', + 'description' => 'Triggers a local event on the current client', + 'side' => 'client', 'parameters' => [ - ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], ], - 'returns' => ['type' => 'table', 'description' => 'QBCore player object'], - 'lua_example' => 'local Player = QBCore.Functions.GetPlayer(source)', - 'js_example' => 'const Player = QBCore.Functions.GetPlayer(source);', + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "TriggerEvent('myEvent', 'arg1', 'arg2')", + 'js_example' => "TriggerEvent('myEvent', 'arg1', 'arg2');", ], ]; @@ -184,7 +209,7 @@ class GetNativeFunction extends Tool return [ 'function_name' => $schema ->string() - ->description('The name of the native function to look up (e.g., "GetPlayerPed", "SetEntityCoords")') + ->description('The name of the client-side native function to look up (e.g., "PlayerPedId", "SetEntityCoords", "TriggerServerEvent")') ->required(), 'language' => $schema ->string() diff --git a/app/Mcp/Tools/GenerateManifest.php b/app/Mcp/Tools/FiveM/GenerateManifest.php similarity index 98% rename from app/Mcp/Tools/GenerateManifest.php rename to app/Mcp/Tools/FiveM/GenerateManifest.php index fe4ccb4..b173b33 100644 --- a/app/Mcp/Tools/GenerateManifest.php +++ b/app/Mcp/Tools/FiveM/GenerateManifest.php @@ -1,6 +1,6 @@ get('event_name'); + $eventType = $request->get('event_type', 'all'); + $language = $request->get('language', 'lua'); + + if ($eventName) { + return $this->getEventInfo($eventName, $language); + } + + return $this->listEvents($eventType, $language); + } + + /** + * Get specific event information. + */ + protected function getEventInfo(string $eventName, string $language): Response + { + $events = $this->getEventsDatabase(); + + foreach ($events as $event) { + if (strtolower($event['name']) === strtolower($eventName)) { + return Response::text($this->formatEventInfo($event, $language)); + } + } + + return Response::text(sprintf("Server event '%s' not found in the database.", $eventName)); + } + + /** + * List events by type. + */ + protected function listEvents(string $type, string $language): Response + { + $events = $this->getEventsDatabase(); + + if ($type !== 'all') { + $events = array_filter($events, fn ($e) => $e['type'] === $type); + } + + $eventsByType = []; + foreach ($events as $event) { + $eventsByType[$event['type']][] = $event; + } + + return Response::text( + view('mcp.event-list', [ + 'eventsByType' => $eventsByType, + ])->render() + ); + } + + /** + * Format event information. + */ + protected function formatEventInfo(array $event, string $language): string + { + return view('mcp.event-reference', [ + 'event' => $event, + 'language' => $language, + ])->render(); + } + + /** + * Get server events database. + */ + protected function getEventsDatabase(): array + { + return [ + // Core FiveM Server Events + [ + 'name' => 'onResourceStart', + 'type' => 'core', + 'side' => 'server', + 'description' => 'Triggered when a resource starts (server-side)', + 'parameters' => [ + ['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that started'], + ], + 'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started on server!')\n end\nend)", + 'js_example' => "on('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started on server!');\n }\n});", + 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStart/', + ], + [ + 'name' => 'onResourceStop', + 'type' => 'core', + 'side' => 'server', + 'description' => 'Triggered when a resource stops (server-side)', + 'parameters' => [ + ['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that stopped'], + ], + 'lua_example' => "AddEventHandler('onResourceStop', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource stopped on server!')\n end\nend)", + 'js_example' => "on('onResourceStop', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource stopped on server!');\n }\n});", + 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/', + ], + [ + 'name' => 'playerConnecting', + 'type' => 'core', + 'side' => 'server', + 'description' => 'Triggered when a player is connecting to the server', + 'parameters' => [ + ['name' => 'name', 'type' => 'string', 'description' => 'Player name'], + ['name' => 'setKickReason', 'type' => 'function', 'description' => 'Function to deny connection'], + ['name' => 'deferrals', 'type' => 'object', 'description' => 'Deferrals object for async connection'], + ], + 'lua_example' => "AddEventHandler('playerConnecting', function(name, setKickReason, deferrals)\n local source = source\n deferrals.defer()\n -- Check player\n deferrals.done()\nend)", + 'js_example' => "on('playerConnecting', (name, setKickReason, deferrals) => {\n const source = global.source;\n deferrals.defer();\n // Check player\n deferrals.done();\n});", + 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerConnecting/', + ], + [ + 'name' => 'playerDropped', + 'type' => 'core', + 'side' => 'server', + 'description' => 'Triggered when a player disconnects from the server', + 'parameters' => [ + ['name' => 'reason', 'type' => 'string', 'description' => 'Disconnect reason'], + ], + 'lua_example' => "AddEventHandler('playerDropped', function(reason)\n local source = source\n print('Player ' .. GetPlayerName(source) .. ' dropped: ' .. reason)\nend)", + 'js_example' => "on('playerDropped', (reason) => {\n const source = global.source;\n console.log(`Player \${GetPlayerName(source)} dropped: \${reason}`);\n});", + 'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerDropped/', + ], + // ESX Server Events + [ + 'name' => 'esx:playerLoaded', + 'type' => 'esx', + 'side' => 'server', + 'description' => 'Triggered on server when ESX player loads', + 'parameters' => [ + ['name' => 'xPlayer', 'type' => 'table', 'description' => 'ESX player object'], + ], + 'lua_example' => "AddEventHandler('esx:playerLoaded', function(source, xPlayer)\n -- Server-side player loaded\nend)", + 'js_example' => "on('esx:playerLoaded', (source, xPlayer) => {\n // Server-side player loaded\n});", + ], + // QBCore Server Events + [ + 'name' => 'QBCore:Server:PlayerLoaded', + 'type' => 'qbcore', + 'side' => 'server', + 'description' => 'Triggered on server when QBCore player loads', + 'parameters' => [ + ['name' => 'Player', 'type' => 'table', 'description' => 'QBCore player object'], + ], + 'lua_example' => "AddEventHandler('QBCore:Server:PlayerLoaded', function(Player)\n -- Server-side player loaded\nend)", + 'js_example' => "on('QBCore:Server:PlayerLoaded', (Player) => {\n // Server-side player loaded\n});", + ], + ]; + } + + /** + * Get the tool's input schema. + * + * @return array + */ + public function schema(JsonSchema $schema): array + { + return [ + 'event_name' => $schema + ->string() + ->description('Specific server event name to look up (optional, leave empty to list all events)'), + 'event_type' => $schema + ->string() + ->enum(['all', 'core', 'esx', 'qbcore']) + ->description('Filter events by type') + ->default('all'), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/FiveM/Server/GetNativeServerFunction.php b/app/Mcp/Tools/FiveM/Server/GetNativeServerFunction.php new file mode 100644 index 0000000..b9336b7 --- /dev/null +++ b/app/Mcp/Tools/FiveM/Server/GetNativeServerFunction.php @@ -0,0 +1,210 @@ +get('function_name'); + $language = $request->get('language', 'lua'); + + $native = $this->findNative($functionName); + + if (! $native) { + return Response::text(sprintf("Server native function '%s' not found. Try searching at https://docs.fivem.net/natives/", $functionName)); + } + + $output = $this->formatNativeInfo($native, $language); + + return Response::text($output); + } + + /** + * Find a server native function. + */ + protected function findNative(string $name): ?array + { + // Server-side only FiveM natives + $natives = [ + 'TriggerClientEvent' => [ + 'namespace' => 'CFX', + 'description' => 'Triggers an event on a client from server', + 'side' => 'server', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => 'playerId', 'type' => 'int|string', 'description' => 'The player server ID or -1 for all'], + ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "TriggerClientEvent('myResource:clientEvent', playerId, arg1, arg2)", + 'js_example' => "TriggerClientEvent('myResource:clientEvent', playerId, arg1, arg2);", + ], + 'TriggerClientEventReliable' => [ + 'namespace' => 'CFX', + 'description' => 'Triggers an event on a client with guaranteed delivery', + 'side' => 'server', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => 'playerId', 'type' => 'int|string', 'description' => 'The player server ID'], + ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "TriggerClientEventReliable('myResource:clientEvent', playerId, arg1, arg2)", + 'js_example' => "TriggerClientEventReliable('myResource:clientEvent', playerId, arg1, arg2);", + ], + 'GetPlayerName' => [ + 'namespace' => 'PLAYER', + 'description' => 'Returns the name of a player (server-side)', + 'side' => 'server', + 'parameters' => [ + ['name' => 'playerId', 'type' => 'int', 'description' => 'The player server ID'], + ], + 'returns' => ['type' => 'string', 'description' => 'The player name'], + 'lua_example' => 'local name = GetPlayerName(source)', + 'js_example' => 'const name = GetPlayerName(global.source);', + ], + 'GetPlayerIdentifier' => [ + 'namespace' => 'PLAYER', + 'description' => 'Gets a specific identifier for a player', + 'side' => 'server', + 'parameters' => [ + ['name' => 'playerId', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'type', 'type' => 'int', 'description' => 'Identifier type (0 = license, 1 = steam, etc.)'], + ], + 'returns' => ['type' => 'string', 'description' => 'The player identifier'], + 'lua_example' => "local license = GetPlayerIdentifier(source, 0)\nlocal steam = GetPlayerIdentifier(source, 1)", + 'js_example' => "const license = GetPlayerIdentifier(global.source, 0);\nconst steam = GetPlayerIdentifier(global.source, 1);", + ], + 'GetPlayerPing' => [ + 'namespace' => 'PLAYER', + 'description' => 'Gets the ping of a player in milliseconds', + 'side' => 'server', + 'parameters' => [ + ['name' => 'playerId', 'type' => 'int', 'description' => 'The player server ID'], + ], + 'returns' => ['type' => 'int', 'description' => 'Player ping in ms'], + 'lua_example' => 'local ping = GetPlayerPing(source)', + 'js_example' => 'const ping = GetPlayerPing(global.source);', + ], + 'DropPlayer' => [ + 'namespace' => 'PLAYER', + 'description' => 'Disconnects a player from the server', + 'side' => 'server', + 'parameters' => [ + ['name' => 'playerId', 'type' => 'int', 'description' => 'The player server ID'], + ['name' => 'reason', 'type' => 'string', 'description' => 'Reason for dropping the player'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "DropPlayer(source, 'You were kicked by admin')", + 'js_example' => "DropPlayer(global.source, 'You were kicked by admin');", + ], + 'GetPlayers' => [ + 'namespace' => 'PLAYER', + 'description' => 'Gets a list of all player server IDs on the server', + 'side' => 'server', + 'parameters' => [], + 'returns' => ['type' => 'table', 'description' => 'Array of player IDs'], + 'lua_example' => "local players = GetPlayers()\nfor _, playerId in ipairs(players) do\n print('Player: ' .. playerId)\nend", + 'js_example' => "const players = GetPlayers();\nfor (const playerId of players) {\n console.log('Player: ' + playerId);\n}", + ], + 'AddEventHandler' => [ + 'namespace' => 'CFX', + 'description' => 'Adds a server-side event handler', + 'side' => 'server', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => 'callback', 'type' => 'function', 'description' => 'The handler function'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "AddEventHandler('playerConnecting', function(name, setKickReason, deferrals)\n -- Handle player connecting\nend)", + 'js_example' => "AddEventHandler('playerConnecting', (name, setKickReason, deferrals) => {\n // Handle player connecting\n});", + ], + 'TriggerEvent' => [ + 'namespace' => 'CFX', + 'description' => 'Triggers a server-side event', + 'side' => 'server', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'], + ['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'], + ], + 'returns' => ['type' => 'void', 'description' => 'No return value'], + 'lua_example' => "TriggerEvent('myEvent', arg1, arg2)", + 'js_example' => "TriggerEvent('myEvent', arg1, arg2);", + ], + 'ESX.GetPlayerFromId' => [ + 'namespace' => 'ESX', + 'description' => 'Get ESX player object from server ID (server-side only)', + 'side' => 'server', + 'parameters' => [ + ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], + ], + 'returns' => ['type' => 'table', 'description' => 'ESX player object'], + 'lua_example' => 'local xPlayer = ESX.GetPlayerFromId(source)', + 'js_example' => 'const xPlayer = ESX.GetPlayerFromId(global.source);', + ], + 'QBCore.Functions.GetPlayer' => [ + 'namespace' => 'QBCore', + 'description' => 'Get 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'], + 'lua_example' => 'local Player = QBCore.Functions.GetPlayer(source)', + 'js_example' => 'const Player = QBCore.Functions.GetPlayer(global.source);', + ], + ]; + + $nameLower = strtolower($name); + + foreach ($natives as $nativeName => $nativeData) { + if (strtolower($nativeName) === $nameLower) { + return array_merge(['name' => $nativeName], $nativeData); + } + } + + return null; + } + + /** + * Format native function info. + */ + protected function formatNativeInfo(array $native, string $language): string + { + return view('mcp.native-function', [ + 'native' => $native, + '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 server-side native function to look up (e.g., "TriggerClientEvent", "GetPlayers", "DropPlayer")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/GetCOXFunction.php b/app/Mcp/Tools/GetCOXFunction.php deleted file mode 100644 index 89eb13d..0000000 --- a/app/Mcp/Tools/GetCOXFunction.php +++ /dev/null @@ -1,230 +0,0 @@ -get('function_name'); - $language = $request->get('language', 'lua'); - - $function = $this->findFunction($functionName); - - if (! $function) { - return Response::text(sprintf("COX function '%s' not found. Check COX documentation at https://coxdocs.dev/", $functionName)); - } - - $output = $this->formatFunctionInfo($function, $language); - - return Response::text($output); - } - - /** - * Find a COX function. - */ - protected function findFunction(string $name): ?array - { - $functions = [ - // Query Methods - 'MySQL.query' => [ - 'namespace' => 'Query', - 'description' => 'Execute a MySQL query with optional parameters (prepared statement)', - 'side' => 'server', - 'parameters' => [ - ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query with ? placeholders for prepared statements'], - ['name' => 'params', 'type' => 'table|nil', 'description' => 'Array of parameters to bind to placeholders'], - ], - 'returns' => ['type' => 'boolean', 'description' => 'True if query succeeded, false otherwise'], - 'lua_example' => "MySQL.query('SELECT * FROM users WHERE id = ?', { 1 }, function(result)\n if result then\n for i = 1, #result do\n print(result[i].name)\n end\n end\nend)", - 'js_example' => "MySQL.query('SELECT * FROM users WHERE id = ?', [1], (result) => {\n if (result) {\n result.forEach(row => console.log(row.name));\n }\n});", - ], - 'MySQL.insert' => [ - 'namespace' => 'Query', - 'description' => 'Insert a row into the database and get the insert ID', - 'side' => 'server', - 'parameters' => [ - ['name' => 'tableName', 'type' => 'string', 'description' => 'Name of the table'], - ['name' => 'data', 'type' => 'table', 'description' => 'Table with column names as keys and values'], - ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback function'], - ], - 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "MySQL.insert('users', {\n username = 'player',\n money = 500\n}, function(id)\n print('Inserted with ID: ' .. id)\nend)", - 'js_example' => "MySQL.insert('users', {\n username: 'player',\n money: 500\n}, (id) => {\n console.log('Inserted with ID: ' + id);\n});", - ], - 'MySQL.update' => [ - 'namespace' => 'Query', - 'description' => 'Update rows in the database where a condition matches', - 'side' => 'server', - 'parameters' => [ - ['name' => 'tableName', 'type' => 'string', 'description' => 'Name of the table'], - ['name' => 'data', 'type' => 'table', 'description' => 'Column names and new values'], - ['name' => 'conditions', 'type' => 'string|table', 'description' => 'WHERE clause or conditions table'], - ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback function'], - ], - 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "MySQL.update('users', {\n money = 1000\n}, { id = 5 }, function(affectedRows)\n print('Updated ' .. affectedRows .. ' rows')\nend)", - 'js_example' => "MySQL.update('users', {\n money: 1000\n}, { id: 5 }, (affectedRows) => {\n console.log(`Updated \${affectedRows} rows`);\n});", - ], - 'MySQL.scalar' => [ - 'namespace' => 'Query', - 'description' => 'Get a single scalar value from the database (single result)', - 'side' => 'server', - 'parameters' => [ - ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query'], - ['name' => 'params', 'type' => 'table|nil', 'description' => 'Query parameters'], - ['name' => 'callback', 'type' => 'function', 'description' => 'Callback with the scalar value'], - ], - 'returns' => ['type' => 'void', 'description' => 'Callback receives the value'], - 'lua_example' => "MySQL.scalar('SELECT COUNT(*) as count FROM users', {}, function(count)\n print('Total users: ' .. (count or 0))\nend)", - 'js_example' => "MySQL.scalar('SELECT COUNT(*) as count FROM users', [], (count) => {\n console.log('Total users: ' + (count || 0));\n});", - ], - 'MySQL.single' => [ - 'namespace' => 'Query', - 'description' => 'Get a single row from the database', - 'side' => 'server', - 'parameters' => [ - ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query'], - ['name' => 'params', 'type' => 'table|nil', 'description' => 'Query parameters'], - ['name' => 'callback', 'type' => 'function', 'description' => 'Callback with the row data'], - ], - 'returns' => ['type' => 'void', 'description' => 'Callback receives a single row or nil'], - 'lua_example' => "MySQL.single('SELECT * FROM users WHERE id = ?', { 1 }, function(user)\n if user then\n print('User: ' .. user.username)\n end\nend)", - 'js_example' => "MySQL.single('SELECT * FROM users WHERE id = ?', [1], (user) => {\n if (user) {\n console.log('User: ' + user.username);\n }\n});", - ], - - // Transaction Methods - 'MySQL.transaction.begin' => [ - 'namespace' => 'Transaction', - 'description' => 'Begin a new database transaction', - 'side' => 'server', - 'parameters' => [], - 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "MySQL.transaction.begin()\nMySQL.update('users', { money = money - 500 }, { id = 1 })\nMySQL.update('users', { money = money + 500 }, { id = 2 })\nMySQL.transaction.commit()", - 'js_example' => "MySQL.transaction.begin();\nMySQL.update('users', { money: 'money - 500' }, { id: 1 });\nMySQL.update('users', { money: 'money + 500' }, { id: 2 });\nMySQL.transaction.commit();", - ], - 'MySQL.transaction.commit' => [ - 'namespace' => 'Transaction', - 'description' => 'Commit the current transaction', - 'side' => 'server', - 'parameters' => [ - ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback after commit'], - ], - 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "MySQL.transaction.commit(function(success)\n if success then\n print('Transaction committed successfully')\n else\n print('Transaction commit failed')\n end\nend)", - 'js_example' => "MySQL.transaction.commit((success) => {\n if (success) {\n console.log('Transaction committed successfully');\n } else {\n console.log('Transaction commit failed');\n }\n});", - ], - 'MySQL.transaction.rollback' => [ - 'namespace' => 'Transaction', - 'description' => 'Rollback the current transaction', - 'side' => 'server', - 'parameters' => [ - ['name' => 'callback', 'type' => 'function|nil', 'description' => 'Optional callback after rollback'], - ], - 'returns' => ['type' => 'void', 'description' => 'No return value'], - 'lua_example' => "if error then\n MySQL.transaction.rollback(function(success)\n print('Transaction rolled back')\n end)\nend", - 'js_example' => "if (error) {\n MySQL.transaction.rollback((success) => {\n console.log('Transaction rolled back');\n });\n}", - ], - - // Connection Methods - 'MySQL.ready' => [ - 'namespace' => 'Connection', - 'description' => 'Check if the database connection is ready', - 'side' => 'server', - 'parameters' => [], - 'returns' => ['type' => 'boolean', 'description' => 'True if connection is ready'], - 'lua_example' => "if MySQL.ready then\n MySQL.query('SELECT 1', function(result)\n print('Database is connected!')\n end)\nend", - 'js_example' => "if (MySQL.ready) {\n MySQL.query('SELECT 1', (result) => {\n console.log('Database is connected!');\n });\n}", - ], - 'MySQL.getStatus' => [ - 'namespace' => 'Connection', - 'description' => 'Get the current MySQL connection status', - 'side' => 'server', - 'parameters' => [], - 'returns' => ['type' => 'string', 'description' => 'Status string (connected, connecting, disconnected, etc.)'], - 'lua_example' => "local status = MySQL.getStatus()\nprint('Connection status: ' .. status)", - 'js_example' => "const status = MySQL.getStatus();\nconsole.log('Connection status: ' + status);", - ], - - // Prepared Statements - 'MySQL.prepare' => [ - 'namespace' => 'Prepared', - 'description' => 'Prepare a query for execution with bound parameters (prevents SQL injection)', - 'side' => 'server', - 'parameters' => [ - ['name' => 'sql', 'type' => 'string', 'description' => 'SQL with ? placeholders'], - ['name' => 'params', 'type' => 'table', 'description' => 'Parameters to bind'], - ['name' => 'callback', 'type' => 'function', 'description' => 'Callback with results'], - ], - 'returns' => ['type' => 'void', 'description' => 'Callback receives prepared statement result'], - 'lua_example' => "MySQL.prepare('INSERT INTO logs (user_id, action) VALUES (?, ?)', { 5, 'joined' }, function(success)\n if success then\n print('Log inserted')\n end\nend)", - 'js_example' => "MySQL.prepare('INSERT INTO logs (user_id, action) VALUES (?, ?)', [5, 'joined'], (success) => {\n if (success) {\n console.log('Log inserted');\n }\n});", - ], - - // Async Methods - 'MySQL.async.query' => [ - 'namespace' => 'Async', - 'description' => 'Execute an async query (returns promise-like structure)', - 'side' => 'server', - 'parameters' => [ - ['name' => 'sql', 'type' => 'string', 'description' => 'SQL query'], - ['name' => 'params', 'type' => 'table|nil', 'description' => 'Query parameters'], - ], - 'returns' => ['type' => 'table', 'description' => 'Awaitable result table'], - 'lua_example' => "local result = MySQL.async.query('SELECT * FROM users WHERE banned = ?', { 0 })\nprint('Query completed')", - 'js_example' => "const result = MySQL.async.query('SELECT * FROM users WHERE banned = ?', [0]);\nconsole.log('Query completed');", - ], - ]; - - $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.cox-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 COX function to look up (e.g., "MySQL.query", "MySQL.insert", "MySQL.transaction.begin")') - ->required(), - 'language' => $schema - ->string() - ->enum(['lua', 'js']) - ->description('The scripting language for code examples') - ->default('lua'), - ]; - } -} diff --git a/app/Mcp/Tools/GetQBCoreEventReference.php b/app/Mcp/Tools/GetQBCoreEventReference.php deleted file mode 100644 index 89485f6..0000000 --- a/app/Mcp/Tools/GetQBCoreEventReference.php +++ /dev/null @@ -1,277 +0,0 @@ -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/QBCore/Client/GetQBCoreClientEventReference.php b/app/Mcp/Tools/QBCore/Client/GetQBCoreClientEventReference.php new file mode 100644 index 0000000..96ab0ed --- /dev/null +++ b/app/Mcp/Tools/QBCore/Client/GetQBCoreClientEventReference.php @@ -0,0 +1,160 @@ +get('event_name', ''); + + $events = $this->getClientEvents(); + + if ($eventName) { + $event = collect($events)->firstWhere('name', $eventName); + if ($event) { + return Response::text($this->formatEvent($event)); + } + + return Response::text("Client-side event '$eventName' not found."); + } + + return Response::text($this->formatEventList($events, 'QBCore Client Events')); + } + + /** + * Get all client-side events. + */ + protected function getClientEvents(): array + { + return [ + [ + 'name' => 'QBCore:Client:OnPlayerLoad', + 'side' => 'client', + 'description' => 'Fired when the player loads on the client (character selected)', + 'parameters' => ['PlayerData' => 'The player data table'], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoad')\nAddEventHandler('QBCore:Client:OnPlayerLoad', function()\n local playerData = QBCore.Functions.GetPlayerData()\n print('Player loaded: ' .. playerData.charinfo.firstname)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoad');\nAddEventHandler('QBCore:Client:OnPlayerLoad', function() {\n const playerData = QBCore.Functions.GetPlayerData();\n console.log(`Player loaded: \${playerData.charinfo.firstname}`);\n});", + ], + [ + 'name' => 'QBCore:Client:OnPlayerUnload', + 'side' => 'client', + 'description' => 'Fired when the player unloads (leaving character/logging out)', + 'parameters' => [], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerUnload')\nAddEventHandler('QBCore:Client:OnPlayerUnload', function()\n print('Player unloaded')\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerUnload');\nAddEventHandler('QBCore:Client:OnPlayerUnload', function() {\n console.log('Player unloaded');\n});", + ], + [ + 'name' => 'QBCore:Client:OnJobUpdate', + 'side' => 'client', + 'description' => 'Fired when the player\'s job is updated locally', + 'parameters' => ['JobInfo' => 'The job table with name, grade, etc'], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate')\nAddEventHandler('QBCore:Client:OnJobUpdate', function(JobInfo)\n print('Job updated: ' .. JobInfo.name)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate');\nAddEventHandler('QBCore:Client:OnJobUpdate', function(JobInfo) {\n console.log(`Job updated: \${JobInfo.name}`);\n});", + ], + [ + 'name' => 'QBCore:Client:OnMoneyChange', + 'side' => 'client', + 'description' => 'Fired when the player\'s money amount changes', + 'parameters' => ['MoneyType' => 'Type of money changed', 'Amount' => 'New amount', 'ChangedAmount' => 'Amount changed'], + 'lua_example' => "AddEventHandler('QBCore:Client:OnMoneyChange', function(MoneyType, Amount, ChangedAmount)\n print('Money changed: ' .. ChangedAmount .. ' (' .. MoneyType .. ')')\nend)", + 'js_example' => "AddEventHandler('QBCore:Client:OnMoneyChange', function(MoneyType, Amount, ChangedAmount) {\n console.log(`Money changed: \${ChangedAmount} (\${MoneyType})`);\n});", + ], + [ + 'name' => 'QBCore:Client:OnItemUpdate', + 'side' => 'client', + 'description' => 'Fired when an item in the player\'s inventory updates', + 'parameters' => ['inventory' => 'Updated inventory table'], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnItemUpdate')\nAddEventHandler('QBCore:Client:OnItemUpdate', function(inventory)\n print('Inventory updated')\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnItemUpdate');\nAddEventHandler('QBCore:Client:OnItemUpdate', function(inventory) {\n console.log('Inventory updated');\n});", + ], + [ + 'name' => 'QBCore:Notify', + 'side' => 'client', + 'description' => 'Send a notification to the player client', + 'parameters' => ['message' => 'Notification message', 'type' => 'Type (success, error, info)', 'duration' => 'Duration in milliseconds'], + 'lua_example' => "TriggerEvent('QBCore:Notify', 'Hello World!', 'success')\n-- Server trigger:\n-- TriggerClientEvent('QBCore:Notify', source, 'Hello World!', 'success')", + 'js_example' => "TriggerEvent('QBCore:Notify', 'Hello World!', 'success');\n// Server trigger:\n// TriggerClientEvent('QBCore:Notify', global.source, 'Hello World!', 'success');", + ], + ]; + } + + /** + * Format a single event. + */ + protected function formatEvent(array $event): string + { + return <<formatParameters($event['parameters'])} + +**Lua Example:** +\`\`\`lua +{$event['lua_example']} +\`\`\` + +**JavaScript Example:** +\`\`\`javascript +{$event['js_example']} +\`\`\` +EOT; + } + + /** + * Format event list. + */ + protected function formatEventList(array $events, string $title): string + { + $list = "# {$title}\n\n"; + + foreach ($events as $event) { + $list .= "- **{$event['name']}**: {$event['description']}\n"; + } + + return $list; + } + + /** + * Format parameters list. + */ + protected function formatParameters(array $parameters): string + { + $formatted = ''; + foreach ($parameters as $name => $description) { + $formatted .= "- `{$name}`: {$description}\n"; + } + + return $formatted; + } + + /** + * Get the tool's input schema. + * + * @return array + */ + public function schema(JsonSchema $schema): array + { + return [ + 'event_name' => $schema + ->string() + ->description('Specific event name to look up, or leave empty to list all client events') + ->default(''), + ]; + } +} diff --git a/app/Mcp/Tools/QBCore/Client/GetQBCoreClientFunction.php b/app/Mcp/Tools/QBCore/Client/GetQBCoreClientFunction.php new file mode 100644 index 0000000..7423526 --- /dev/null +++ b/app/Mcp/Tools/QBCore/Client/GetQBCoreClientFunction.php @@ -0,0 +1,159 @@ +get('function_name'); + $language = $request->get('language', 'lua'); + + $function = $this->findFunction($functionName); + + if (! $function) { + return Response::text(sprintf("QBCore client 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 client function. + */ + protected function findFunction(string $name): ?array + { + $functions = [ + 'QBCore.Functions.GetPlayerData' => [ + 'namespace' => 'Core', + 'description' => 'Get the local player data (client-side only). Contains all player information.', + 'side' => 'client', + 'parameters' => [], + 'returns' => [ + 'type' => 'table', + 'description' => 'Player data table with keys: source, charinfo, job, gang, money, items, inventory, licenses, etc.', + ], + 'lua_example' => "local playerData = QBCore.Functions.GetPlayerData()\nif playerData then\n print('Name: ' .. playerData.charinfo.firstname .. ' ' .. playerData.charinfo.lastname)\n print('Job: ' .. playerData.job.name)\nend", + 'js_example' => "const playerData = QBCore.Functions.GetPlayerData();\nif (playerData) {\n console.log(`Name: \${playerData.charinfo.firstname} \${playerData.charinfo.lastname}`);\n console.log(`Job: \${playerData.job.name}`);\n}", + ], + 'QBCore.Functions.TriggerCallback' => [ + 'namespace' => 'Core', + 'description' => 'Call a server-side callback from the client and wait for response (client-side only)', + 'side' => 'client', + 'parameters' => [ + ['name' => 'name', 'type' => 'string', 'description' => 'The callback name'], + ['name' => 'function', 'type' => 'function', 'description' => 'Callback function to execute with result'], + ['name' => '...', 'type' => 'any', 'description' => 'Arguments to pass to server callback'], + ], + 'returns' => ['type' => 'void', 'description' => 'Result passed to callback function'], + 'lua_example' => "QBCore.Functions.TriggerCallback('myResource:getPlayerInfo', function(result)\n if result then\n print('Got result: ' .. result.name)\n end\nend, playerId)", + 'js_example' => "QBCore.Functions.TriggerCallback('myResource:getPlayerInfo', function(result) {\n if (result) {\n console.log(`Got result: \${result.name}`);\n }\n}, playerId);", + ], + 'QBCore.Commands.Add' => [ + 'namespace' => 'Client', + 'description' => 'Register a client-side command (client-side only)', + 'side' => 'client', + 'parameters' => [ + ['name' => 'name', 'type' => 'string', 'description' => 'Command name (without slash)'], + ['name' => 'help', 'type' => 'string', 'description' => 'Help text for command'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Function to execute when command runs'], + ['name' => 'restricted', 'type' => 'boolean|nil', 'description' => 'Whether command requires admin'], + ], + 'returns' => ['type' => 'void', 'description' => ''], + 'lua_example' => "QBCore.Commands.Add('testcmd', 'Test Command', {}, false, function(args)\n print('Command executed!')\nend)", + 'js_example' => "QBCore.Commands.Add('testcmd', 'Test Command', {}, false, function(args) {\n console.log('Command executed!');\n});", + ], + 'QBCore.UI.DrawText3D' => [ + 'namespace' => 'UI', + 'description' => 'Draw 3D text in the game world (client-side only)', + 'side' => 'client', + 'parameters' => [ + ['name' => 'x', 'type' => 'number', 'description' => 'World X coordinate'], + ['name' => 'y', 'type' => 'number', 'description' => 'World Y coordinate'], + ['name' => 'z', 'type' => 'number', 'description' => 'World Z coordinate'], + ['name' => 'text', 'type' => 'string', 'description' => 'Text to display'], + ], + 'returns' => ['type' => 'void', 'description' => ''], + 'lua_example' => "QBCore.UI.DrawText3D(100.0, 200.0, 50.0, 'Press [E] to interact')", + 'js_example' => "QBCore.UI.DrawText3D(100.0, 200.0, 50.0, 'Press [E] to interact');", + ], + 'TriggerEvent' => [ + 'namespace' => 'FiveM Core', + 'description' => 'Trigger a local client-side event (client-side only)', + 'side' => 'client', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'The event name to trigger'], + ['name' => '...', 'type' => 'any', 'description' => 'Arguments to pass to event listeners'], + ], + 'returns' => ['type' => 'void', 'description' => ''], + 'lua_example' => "TriggerEvent('playerLoaded', playerData)\n-- Listen with:\n-- RegisterNetEvent('playerLoaded', function(playerData)\n-- print('Player loaded!')\n-- end)", + 'js_example' => "TriggerEvent('playerLoaded', playerData);\n// Listen with:\n// on('playerLoaded', (playerData) => {\n// console.log('Player loaded!');\n// });", + ], + 'RegisterNetEvent' => [ + 'namespace' => 'FiveM Core', + 'description' => 'Register an event listener from the server (client-side only)', + 'side' => 'client', + 'parameters' => [ + ['name' => 'eventName', 'type' => 'string', 'description' => 'Event name to listen for'], + ['name' => 'callback', 'type' => 'function', 'description' => 'Function to call when event fires'], + ], + 'returns' => ['type' => 'void', 'description' => ''], + 'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoad')\nAddEventHandler('QBCore:Client:OnPlayerLoad', function()\n local playerData = QBCore.Functions.GetPlayerData()\n print('Player loaded: ' .. playerData.charinfo.firstname)\nend)", + 'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoad');\nAddEventHandler('QBCore:Client:OnPlayerLoad', function() {\n const playerData = QBCore.Functions.GetPlayerData();\n console.log(`Player loaded: \${playerData.charinfo.firstname}`);\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 client function to look up (e.g., "QBCore.Functions.GetPlayerData", "QBCore.Commands.Add")') + ->required(), + 'language' => $schema + ->string() + ->enum(['lua', 'js']) + ->description('The scripting language for code examples') + ->default('lua'), + ]; + } +} diff --git a/app/Mcp/Tools/QBCore/Server/GetQBCoreServerEventReference.php b/app/Mcp/Tools/QBCore/Server/GetQBCoreServerEventReference.php new file mode 100644 index 0000000..38965a8 --- /dev/null +++ b/app/Mcp/Tools/QBCore/Server/GetQBCoreServerEventReference.php @@ -0,0 +1,160 @@ +get('event_name', ''); + + $events = $this->getServerEvents(); + + if ($eventName) { + $event = collect($events)->firstWhere('name', $eventName); + if ($event) { + return Response::text($this->formatEvent($event)); + } + + return Response::text("Server-side event '$eventName' not found."); + } + + return Response::text($this->formatEventList($events, 'QBCore Server Events')); + } + + /** + * Get all server-side events. + */ + protected function getServerEvents(): array + { + return [ + [ + 'name' => 'QBCore:Server:PlayerLoaded', + 'side' => 'server', + 'description' => 'Fired when a player fully loads on the server', + 'parameters' => ['source' => 'Player server ID'], + 'lua_example' => "AddEventHandler('QBCore:Server:PlayerLoaded', function(source)\n print('Player ' .. source .. ' loaded')\nend)", + 'js_example' => "AddEventHandler('QBCore:Server:PlayerLoaded', function(source) {\n console.log('Player ' + source + ' loaded');\n});", + ], + [ + 'name' => 'QBCore:Server:playerDropped', + 'side' => 'server', + 'description' => 'Fired when a player disconnects from the server', + 'parameters' => ['source' => 'Player server ID', 'reason' => 'Disconnect reason string'], + 'lua_example' => "AddEventHandler('QBCore:Server:playerDropped', function(source, reason)\n print('Player ' .. source .. ' dropped: ' .. reason)\nend)", + 'js_example' => "AddEventHandler('QBCore:Server:playerDropped', function(source, reason) {\n console.log('Player ' + source + ' dropped: ' + reason);\n});", + ], + [ + 'name' => 'QBCore:Server:PlayerDataChanged', + 'side' => 'server', + 'description' => 'Fired when a player\'s data changes (job, money, items, etc)', + 'parameters' => ['source' => 'Player server ID', 'dataName' => 'Name of changed data'], + 'lua_example' => "AddEventHandler('QBCore:Server:PlayerDataChanged', function(source, dataName)\n if dataName == 'money' then\n print('Player money changed')\n end\nend)", + 'js_example' => "AddEventHandler('QBCore:Server:PlayerDataChanged', function(source, dataName) {\n if (dataName === 'money') {\n console.log('Player money changed');\n }\n});", + ], + [ + 'name' => 'QBCore:Server:OnJobUpdate', + 'side' => 'server', + 'description' => 'Fired when a player\'s job is updated', + 'parameters' => ['source' => 'Player server ID', 'job' => 'New job table'], + 'lua_example' => "AddEventHandler('QBCore:Server:OnJobUpdate', function(source, job)\n print('Player job: ' .. job.name)\nend)", + 'js_example' => "AddEventHandler('QBCore:Server:OnJobUpdate', function(source, job) {\n console.log('Player job: ' + job.name);\n});", + ], + [ + 'name' => 'QBCore:Server:SyncPlayerData', + 'side' => 'server', + 'description' => 'Sync player data across server (triggered internally)', + 'parameters' => ['source' => 'Player server ID'], + 'lua_example' => "TriggerEvent('QBCore:Server:SyncPlayerData', source)", + 'js_example' => "TriggerEvent('QBCore:Server:SyncPlayerData', global.source);", + ], + [ + 'name' => 'QBCore:Server:SavePlayer', + 'side' => 'server', + 'description' => 'Save a player\'s data to database', + 'parameters' => ['source' => 'Player server ID'], + 'lua_example' => "TriggerEvent('QBCore:Server:SavePlayer', source)", + 'js_example' => "TriggerEvent('QBCore:Server:SavePlayer', global.source);", + ], + ]; + } + + /** + * Format a single event. + */ + protected function formatEvent(array $event): string + { + return <<formatParameters($event['parameters'])} + +**Lua Example:** +\`\`\`lua +{$event['lua_example']} +\`\`\` + +**JavaScript Example:** +\`\`\`javascript +{$event['js_example']} +\`\`\` +EOT; + } + + /** + * Format event list. + */ + protected function formatEventList(array $events, string $title): string + { + $list = "# {$title}\n\n"; + + foreach ($events as $event) { + $list .= "- **{$event['name']}**: {$event['description']}\n"; + } + + return $list; + } + + /** + * Format parameters list. + */ + protected function formatParameters(array $parameters): string + { + $formatted = ''; + foreach ($parameters as $name => $description) { + $formatted .= "- `{$name}`: {$description}\n"; + } + + return $formatted; + } + + /** + * Get the tool's input schema. + * + * @return array + */ + public function schema(JsonSchema $schema): array + { + return [ + 'event_name' => $schema + ->string() + ->description('Specific event name to look up, or leave empty to list all server events') + ->default(''), + ]; + } +} diff --git a/app/Mcp/Tools/GetQBCoreFunction.php b/app/Mcp/Tools/QBCore/Server/GetQBCoreServerFunction.php similarity index 78% rename from app/Mcp/Tools/GetQBCoreFunction.php rename to app/Mcp/Tools/QBCore/Server/GetQBCoreServerFunction.php index 10487a3..0954a54 100644 --- a/app/Mcp/Tools/GetQBCoreFunction.php +++ b/app/Mcp/Tools/QBCore/Server/GetQBCoreServerFunction.php @@ -1,6 +1,6 @@ findFunction($functionName); if (! $function) { - return Response::text(sprintf("QBCore function '%s' not found. Check QBCore documentation at https://docs.qbcore.org/", $functionName)); + return Response::text(sprintf("QBCore server function '%s' not found. Check QBCore documentation at https://docs.qbcore.org/", $functionName)); } $output = $this->formatFunctionInfo($function, $language); @@ -31,12 +31,11 @@ class GetQBCoreFunction extends Tool } /** - * Find a QBCore function. + * Find a QBCore server 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)', @@ -59,20 +58,9 @@ class GetQBCoreFunction extends Tool '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', + 'description' => 'Add an item to a player\'s inventory (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], @@ -86,7 +74,7 @@ class GetQBCoreFunction extends Tool ], 'RemoveItem' => [ 'namespace' => 'Player', - 'description' => 'Remove an item from a player\'s inventory', + 'description' => 'Remove an item from a player\'s inventory (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], @@ -99,7 +87,7 @@ class GetQBCoreFunction extends Tool ], 'GetItemByName' => [ 'namespace' => 'Player', - 'description' => 'Get item data from a player\'s inventory', + 'description' => 'Get item data from a player\'s inventory (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name to search for'], @@ -108,11 +96,9 @@ class GetQBCoreFunction extends Tool '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', + 'description' => 'Add money to a player\'s account (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], @@ -120,12 +106,12 @@ class GetQBCoreFunction extends Tool ['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}", + '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', + 'description' => 'Remove money from a player\'s account (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], @@ -138,20 +124,18 @@ class GetQBCoreFunction extends Tool ], 'GetMoney' => [ 'namespace' => 'Player', - 'description' => 'Get a player\'s money amount', + 'description' => 'Get a player\'s money amount (server-side)', '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}", + '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', + 'description' => 'Set a player\'s job (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'jobName', 'type' => 'string', 'description' => 'The job name'], @@ -163,18 +147,16 @@ class GetQBCoreFunction extends Tool ], 'GetJob' => [ 'namespace' => 'Player', - 'description' => 'Get a player\'s job information', + 'description' => 'Get a player\'s job information (server-side)', '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', + 'description' => 'Add a vehicle to a player\'s garage (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'modelName', 'type' => 'string', 'description' => 'Vehicle model name (e.g., "adder")'], @@ -187,7 +169,7 @@ class GetQBCoreFunction extends Tool ], 'DeleteVehicle' => [ 'namespace' => 'Player', - 'description' => 'Remove a vehicle from a player\'s garage', + 'description' => 'Remove a vehicle from a player\'s garage (server-side)', 'side' => 'server', 'parameters' => [ ['name' => 'plate', 'type' => 'string', 'description' => 'License plate of vehicle to remove'], @@ -196,34 +178,6 @@ class GetQBCoreFunction extends Tool '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); @@ -258,7 +212,7 @@ class GetQBCoreFunction extends Tool return [ 'function_name' => $schema ->string() - ->description('The name of the QBCore function to look up (e.g., "QBCore.Functions.GetPlayer", "AddMoney")') + ->description('The name of the QBCore server function to look up (e.g., "QBCore.Functions.GetPlayer", "AddMoney", "SetJob")') ->required(), 'language' => $schema ->string() diff --git a/resources/views/docs/index.blade.php b/resources/views/docs/index.blade.php index 9880d6d..c9aadb9 100644 --- a/resources/views/docs/index.blade.php +++ b/resources/views/docs/index.blade.php @@ -186,6 +186,12 @@
  • FiveM Natives Reference
  • +
  • + QBCore Documentation +
  • +
  • + COX MySQL Documentation +
  • Laravel MCP Documentation
  • diff --git a/tests/Feature/GenerateManifestToolTest.php b/tests/Feature/GenerateManifestToolTest.php index a1862ed..f9dda46 100644 --- a/tests/Feature/GenerateManifestToolTest.php +++ b/tests/Feature/GenerateManifestToolTest.php @@ -1,10 +1,10 @@ 'test-resource']); $response = $tool->handle($request); @@ -14,7 +14,7 @@ it('generate manifest returns response with content', function () { }); it('generate manifest includes required fields', function () { - $tool = new GenerateManifest(); + $tool = new GenerateManifest; $request = new Request(['resource_name' => 'my-test-resource']); $response = $tool->handle($request); diff --git a/tests/Feature/GenerateResourceBoilerplateToolTest.php b/tests/Feature/GenerateResourceBoilerplateToolTest.php index c11ff7f..3d1d8f6 100644 --- a/tests/Feature/GenerateResourceBoilerplateToolTest.php +++ b/tests/Feature/GenerateResourceBoilerplateToolTest.php @@ -1,10 +1,10 @@ 'test-resource']); $response = $tool->handle($request); @@ -14,7 +14,7 @@ it('generate resource boilerplate returns response with content', function () { }); it('generate resource boilerplate includes resource name', function () { - $tool = new GenerateResourceBoilerplate(); + $tool = new GenerateResourceBoilerplate; $request = new Request(['resource_name' => 'my-boilerplate']); $response = $tool->handle($request); diff --git a/tests/Feature/GetCOXEventReferenceToolTest.php b/tests/Feature/GetCOXEventReferenceToolTest.php index f1a0ada..e4f2d30 100644 --- a/tests/Feature/GetCOXEventReferenceToolTest.php +++ b/tests/Feature/GetCOXEventReferenceToolTest.php @@ -1,6 +1,6 @@ 'MySQL.transaction.begin']); + $request = new Request(['function_name' => 'MySQL.transaction']); $response = $tool->handle($request); diff --git a/tests/Feature/GetEventClientReferenceToolTest.php b/tests/Feature/GetEventClientReferenceToolTest.php new file mode 100644 index 0000000..24337e1 --- /dev/null +++ b/tests/Feature/GetEventClientReferenceToolTest.php @@ -0,0 +1,49 @@ + 'onResourceStart']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('onResourceStart'); +}); + +it('returns not found for invalid event', function () { + $tool = new GetEventClientReference; + $request = new Request(['event_name' => 'InvalidEvent']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('lists all client events when empty event name', function () { + $tool = new GetEventClientReference; + $request = new Request(['event_name' => '']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('handles case insensitive event names', function () { + $tool = new GetEventClientReference; + $request = new Request(['event_name' => 'onresourcestart']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('onResourceStart'); +}); + +it('contains lua examples', function () { + $tool = new GetEventClientReference; + $request = new Request(['event_name' => 'onResourceStart']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetEventReferenceToolTest.php b/tests/Feature/GetEventReferenceToolTest.php deleted file mode 100644 index 91d7cef..0000000 --- a/tests/Feature/GetEventReferenceToolTest.php +++ /dev/null @@ -1,24 +0,0 @@ - 'playerSpawned']); - - $response = $tool->handle($request); - - expect($response)->not()->toBeNull(); - expect($response->content())->not()->toBeNull(); -}); - -it('get event reference handles unknown event', function () { - $tool = new GetEventReference(); - $request = new Request(['event_name' => 'NonExistentEvent123']); - - $response = $tool->handle($request); - $content = (string) $response->content(); - - expect($content)->toContain('not found') || expect($content)->toContain('Event'); -}); diff --git a/tests/Feature/GetEventServerReferenceToolTest.php b/tests/Feature/GetEventServerReferenceToolTest.php new file mode 100644 index 0000000..cae689f --- /dev/null +++ b/tests/Feature/GetEventServerReferenceToolTest.php @@ -0,0 +1,49 @@ + 'playerConnecting']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('playerConnecting'); +}); + +it('returns not found for invalid server event', function () { + $tool = new GetEventServerReference; + $request = new Request(['event_name' => 'InvalidServerEvent']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('lists all server events when empty event name', function () { + $tool = new GetEventServerReference; + $request = new Request(['event_name' => '']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('handles case insensitive server event names', function () { + $tool = new GetEventServerReference; + $request = new Request(['event_name' => 'playerdropped']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('playerDropped'); +}); + +it('contains examples for server events', function () { + $tool = new GetEventServerReference; + $request = new Request(['event_name' => 'playerConnecting']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetInventoryClientFunctionToolTest.php b/tests/Feature/GetInventoryClientFunctionToolTest.php new file mode 100644 index 0000000..63766f9 --- /dev/null +++ b/tests/Feature/GetInventoryClientFunctionToolTest.php @@ -0,0 +1,64 @@ + 'openInventory']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory client function handles unknown function', function () { + $tool = new GetInventoryClientFunction; + $request = new Request(['function_name' => 'NonExistentFunction123']); + + $response = $tool->handle($request); + $content = (string) $response->content(); + + expect($content)->toContain('not found'); +}); + +it('get inventory client function works with SearchPlayer', function () { + $tool = new GetInventoryClientFunction; + $request = new Request(['function_name' => 'SearchPlayer']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory client function works with useItem', function () { + $tool = new GetInventoryClientFunction; + $request = new Request(['function_name' => 'useItem']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory client function supports javascript examples', function () { + $tool = new GetInventoryClientFunction; + $request = new Request(['function_name' => 'GetCurrentWeapon', 'language' => 'js']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory client function works with getCurrentWeight', function () { + $tool = new GetInventoryClientFunction; + $request = new Request(['function_name' => 'getCurrentWeight']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); diff --git a/tests/Feature/GetInventoryServerFunctionToolTest.php b/tests/Feature/GetInventoryServerFunctionToolTest.php new file mode 100644 index 0000000..2e32aef --- /dev/null +++ b/tests/Feature/GetInventoryServerFunctionToolTest.php @@ -0,0 +1,64 @@ + 'AddItem']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory server function handles unknown function', function () { + $tool = new GetInventoryServerFunction; + $request = new Request(['function_name' => 'NonExistentFunction123']); + + $response = $tool->handle($request); + $content = (string) $response->content(); + + expect($content)->toContain('not found'); +}); + +it('get inventory server function works with RemoveItem', function () { + $tool = new GetInventoryServerFunction; + $request = new Request(['function_name' => 'RemoveItem']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory server function works with RegisterStash', function () { + $tool = new GetInventoryServerFunction; + $request = new Request(['function_name' => 'RegisterStash']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory server function supports javascript examples', function () { + $tool = new GetInventoryServerFunction; + $request = new Request(['function_name' => 'GetItem', 'language' => 'js']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); + +it('get inventory server function works with SetDurability', function () { + $tool = new GetInventoryServerFunction; + $request = new Request(['function_name' => 'SetDurability']); + + $response = $tool->handle($request); + + expect($response)->not()->toBeNull(); + expect($response->content())->not()->toBeNull(); +}); diff --git a/tests/Feature/GetNativeClientFunctionToolTest.php b/tests/Feature/GetNativeClientFunctionToolTest.php new file mode 100644 index 0000000..521981a --- /dev/null +++ b/tests/Feature/GetNativeClientFunctionToolTest.php @@ -0,0 +1,49 @@ + 'PlayerPedId', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('PlayerPedId'); +}); + +it('returns not found for invalid function', function () { + $tool = new GetNativeClientFunction; + $request = new Request(['function_name' => 'InvalidFunction', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('supports javascript examples', function () { + $tool = new GetNativeClientFunction; + $request = new Request(['function_name' => 'GetEntityCoords', 'language' => 'js']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('js'); +}); + +it('handles case insensitive function names', function () { + $tool = new GetNativeClientFunction; + $request = new Request(['function_name' => 'playerpedid', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('PlayerPedId'); +}); + +it('lists all client functions when no name provided', function () { + $tool = new GetNativeClientFunction; + $request = new Request(['function_name' => '', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetNativeFunctionToolTest.php b/tests/Feature/GetNativeFunctionToolTest.php deleted file mode 100644 index b4bba69..0000000 --- a/tests/Feature/GetNativeFunctionToolTest.php +++ /dev/null @@ -1,34 +0,0 @@ - 'GetPlayerPed']); - - $response = $tool->handle($request); - - expect($response)->not()->toBeNull(); - expect($response->content())->not()->toBeNull(); -}); - -it('get native function finds known function', function () { - $tool = new GetNativeFunction(); - $request = new Request(['function_name' => 'GetPlayerPed']); - - $response = $tool->handle($request); - $content = (string) $response->content(); - - expect($content)->toContain('GetPlayerPed') || expect($content)->toContain('player'); -}); - -it('get native function handles unknown function', function () { - $tool = new GetNativeFunction(); - $request = new Request(['function_name' => 'UnknownFunction123']); - - $response = $tool->handle($request); - $content = (string) $response->content(); - - expect($content)->toContain('not found'); -}); diff --git a/tests/Feature/GetNativeServerFunctionToolTest.php b/tests/Feature/GetNativeServerFunctionToolTest.php new file mode 100644 index 0000000..e63007f --- /dev/null +++ b/tests/Feature/GetNativeServerFunctionToolTest.php @@ -0,0 +1,49 @@ + 'TriggerClientEvent', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('TriggerClientEvent'); +}); + +it('returns not found for invalid function', function () { + $tool = new GetNativeServerFunction; + $request = new Request(['function_name' => 'InvalidServerFunction', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('supports javascript examples for server natives', function () { + $tool = new GetNativeServerFunction; + $request = new Request(['function_name' => 'GetPlayerName', 'language' => 'js']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('handles case insensitive server function names', function () { + $tool = new GetNativeServerFunction; + $request = new Request(['function_name' => 'getplayername', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('GetPlayerName'); +}); + +it('lists all server functions when no name provided', function () { + $tool = new GetNativeServerFunction; + $request = new Request(['function_name' => '', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetQBCoreClientEventReferenceToolTest.php b/tests/Feature/GetQBCoreClientEventReferenceToolTest.php new file mode 100644 index 0000000..47d767a --- /dev/null +++ b/tests/Feature/GetQBCoreClientEventReferenceToolTest.php @@ -0,0 +1,49 @@ + 'QBCore:Client:OnPlayerLoad']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('OnPlayerLoad'); +}); + +it('returns not found for invalid client event', function () { + $tool = new GetQBCoreClientEventReference; + $request = new Request(['event_name' => 'InvalidClientEvent']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('lists all client events when empty event name', function () { + $tool = new GetQBCoreClientEventReference; + $request = new Request(['event_name' => '']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('searches by client event short names', function () { + $tool = new GetQBCoreClientEventReference; + $request = new Request(['event_name' => 'QBCore:Client:OnPlayerLoad']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('OnPlayerLoad'); +}); + +it('includes notification event', function () { + $tool = new GetQBCoreClientEventReference; + $request = new Request(['event_name' => 'QBCore:Notify']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('Notify'); +}); diff --git a/tests/Feature/GetQBCoreClientFunctionToolTest.php b/tests/Feature/GetQBCoreClientFunctionToolTest.php new file mode 100644 index 0000000..a53ddf3 --- /dev/null +++ b/tests/Feature/GetQBCoreClientFunctionToolTest.php @@ -0,0 +1,49 @@ + 'QBCore.Functions.GetPlayerData', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('GetPlayerData'); +}); + +it('returns not found for invalid client function', function () { + $tool = new GetQBCoreClientFunction; + $request = new Request(['function_name' => 'InvalidClientFunction', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('supports javascript examples for client functions', function () { + $tool = new GetQBCoreClientFunction; + $request = new Request(['function_name' => 'QBCore.Commands.Add', 'language' => 'js']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('handles case insensitive client function names', function () { + $tool = new GetQBCoreClientFunction; + $request = new Request(['function_name' => 'qbcore.functions.getplayerdata', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('GetPlayerData'); +}); + +it('includes command registration function', function () { + $tool = new GetQBCoreClientFunction; + $request = new Request(['function_name' => 'QBCore.Commands.Add', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetQBCoreEventReferenceToolTest.php b/tests/Feature/GetQBCoreEventReferenceToolTest.php deleted file mode 100644 index f187dfd..0000000 --- a/tests/Feature/GetQBCoreEventReferenceToolTest.php +++ /dev/null @@ -1,34 +0,0 @@ - '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 deleted file mode 100644 index 3204420..0000000 --- a/tests/Feature/GetQBCoreFunctionToolTest.php +++ /dev/null @@ -1,44 +0,0 @@ - '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(); -}); diff --git a/tests/Feature/GetQBCoreServerEventReferenceToolTest.php b/tests/Feature/GetQBCoreServerEventReferenceToolTest.php new file mode 100644 index 0000000..a2b60d7 --- /dev/null +++ b/tests/Feature/GetQBCoreServerEventReferenceToolTest.php @@ -0,0 +1,49 @@ + 'QBCore:Server:PlayerLoaded']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('PlayerLoaded'); +}); + +it('returns not found for invalid server event', function () { + $tool = new GetQBCoreServerEventReference; + $request = new Request(['event_name' => 'InvalidServerEvent']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('lists all server events when empty event name', function () { + $tool = new GetQBCoreServerEventReference; + $request = new Request(['event_name' => '']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('searches by server event short names', function () { + $tool = new GetQBCoreServerEventReference; + $request = new Request(['event_name' => 'QBCore:Server:PlayerLoaded']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('PlayerLoaded'); +}); + +it('contains examples for server events', function () { + $tool = new GetQBCoreServerEventReference; + $request = new Request(['event_name' => 'QBCore:Server:playerDropped']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); diff --git a/tests/Feature/GetQBCoreServerFunctionToolTest.php b/tests/Feature/GetQBCoreServerFunctionToolTest.php new file mode 100644 index 0000000..25db1c2 --- /dev/null +++ b/tests/Feature/GetQBCoreServerFunctionToolTest.php @@ -0,0 +1,49 @@ + 'QBCore.Functions.GetPlayer', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('GetPlayer'); +}); + +it('returns not found for invalid server function', function () { + $tool = new GetQBCoreServerFunction; + $request = new Request(['function_name' => 'InvalidQBFunction', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('not found'); +}); + +it('supports javascript examples for server functions', function () { + $tool = new GetQBCoreServerFunction; + $request = new Request(['function_name' => 'AddMoney', 'language' => 'js']); + + $response = $tool->handle($request); + + expect((string) $response->content())->not()->toBeEmpty(); +}); + +it('handles case insensitive server function names', function () { + $tool = new GetQBCoreServerFunction; + $request = new Request(['function_name' => 'addmoney', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('AddMoney'); +}); + +it('includes player data structure', function () { + $tool = new GetQBCoreServerFunction; + $request = new Request(['function_name' => 'GetMoney', 'language' => 'lua']); + + $response = $tool->handle($request); + + expect((string) $response->content())->toContain('GetMoney'); +}); diff --git a/tests/Feature/SearchFivemdocsToolTest.php b/tests/Feature/SearchFivemdocsToolTest.php index 1aa8e6c..563ea9d 100644 --- a/tests/Feature/SearchFivemdocsToolTest.php +++ b/tests/Feature/SearchFivemdocsToolTest.php @@ -1,10 +1,10 @@ 'networking']); $response = $tool->handle($request); @@ -14,7 +14,7 @@ it('search fivem docs returns response with content', function () { }); it('search fivem docs handles empty results', function () { - $tool = new SearchFiveMDocs(); + $tool = new SearchFiveMDocs; $request = new Request(['query' => 'nonexistent_topic_xyz']); $response = $tool->handle($request);