Add Prodigy event and export documentation views, enhance tests
- Created new Blade views for displaying Prodigy events and exports, including detailed references. - Implemented tests for Prodigy client and server event/export reference tools to ensure correct functionality. - Updated Pest test configuration for improved test case handling.
This commit is contained in:
78 files changed
+4223
-809
No files matched your search
@@ -28,6 +28,10 @@ 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\Prodigy\Client\GetProdigyClientEventReference;
|
||||
use App\Mcp\Tools\Prodigy\Client\GetProdigyClientExport;
|
||||
use App\Mcp\Tools\Prodigy\Server\GetProdigyServerEventReference;
|
||||
use App\Mcp\Tools\Prodigy\Server\GetProdigyServerExport;
|
||||
use App\Mcp\Tools\QBCore\Client\GetQBCoreClientEventReference;
|
||||
use App\Mcp\Tools\QBCore\Client\GetQBCoreClientFunction;
|
||||
use App\Mcp\Tools\QBCore\GetQBCoreConfig;
|
||||
@@ -86,6 +90,10 @@ class FiveMServer extends Server
|
||||
GetOxDoorlockClientFunction::class,
|
||||
GetOxDoorlockServerFunction::class,
|
||||
GetOxDoorlockServerEvent::class,
|
||||
GetProdigyClientEventReference::class,
|
||||
GetProdigyServerEventReference::class,
|
||||
GetProdigyClientExport::class,
|
||||
GetProdigyServerExport::class,
|
||||
];
|
||||
|
||||
protected array $resources = [
|
||||
|
||||
@@ -90,7 +90,7 @@ class GetOxDoorlockClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -75,7 +75,7 @@ class GetOxDoorlockServerEvent extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -111,7 +111,7 @@ class GetOxDoorlockServerFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -74,7 +74,7 @@ class GetOxFuelClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -74,7 +74,7 @@ class GetOxFuelServerFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -159,7 +159,7 @@ class GetInventoryClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -318,7 +318,7 @@ class GetInventoryServerFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -190,7 +190,7 @@ class GetCOXEventReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -172,7 +172,7 @@ class GetCOXFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -241,7 +241,7 @@ class GetOxTargetClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -158,7 +158,7 @@ class GetEventClientReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -202,7 +202,7 @@ class GetNativeClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -42,7 +42,7 @@ class GenerateManifest extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -126,7 +126,7 @@ class GenerateResourceBoilerplate extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -262,7 +262,7 @@ class SearchFiveMDocs extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -164,7 +164,7 @@ class GetEventServerReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -191,7 +191,7 @@ class GetNativeServerFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
<?php
|
||||
|
||||
namespace App\Mcp\Tools\Prodigy\Client;
|
||||
|
||||
use Illuminate\Contracts\JsonSchema\JsonSchema;
|
||||
use Laravel\Mcp\Request;
|
||||
use Laravel\Mcp\Response;
|
||||
use Laravel\Mcp\Server\Attributes\Description;
|
||||
use Laravel\Mcp\Server\Tool;
|
||||
|
||||
#[Description('prp-bridge event reference for client-side events fired by the Prodigy Studios bridge resource. Includes notifications, sound, callbacks, allowlist, and medical events.')]
|
||||
class GetProdigyClientEventReference extends Tool
|
||||
{
|
||||
/**
|
||||
* Handle the tool request.
|
||||
*/
|
||||
public function handle(Request $request): Response
|
||||
{
|
||||
$eventName = $request->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("prp-bridge client-side event '$eventName' not found. See https://docs.prodigyrp.net/prp-bridge/events.html for the full reference.");
|
||||
}
|
||||
|
||||
return Response::text($this->formatEventList($events));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all prp-bridge client-side events.
|
||||
*/
|
||||
protected function getClientEvents(): array
|
||||
{
|
||||
return [
|
||||
// Core — Notifications & Sound
|
||||
[
|
||||
'name' => 'prp-bridge:notify',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Notifications & Sound',
|
||||
'description' => 'Sends a notification to the player. Trigger from server via bridge.fw.notify. Type: success, error, inform.',
|
||||
'parameters' => [
|
||||
'type' => 'Notification type: "success", "error", or "inform"',
|
||||
'message' => 'The notification body text',
|
||||
'title' => 'Optional title text',
|
||||
'duration' => 'Duration in milliseconds (optional)',
|
||||
],
|
||||
'lua_example' => "-- Trigger from client\nTriggerEvent('prp-bridge:notify', 'success', 'You sold the item!', 'Shop', 5000)\n\n-- Trigger from server\nTriggerClientEvent('prp-bridge:notify', source, 'success', 'You sold the item!', 'Shop', 5000)",
|
||||
'js_example' => "// Trigger from client\nemit('prp-bridge:notify', 'success', 'You sold the item!', 'Shop', 5000);\n\n// Trigger from server\nemitNet('prp-bridge:notify', source, 'success', 'You sold the item!', 'Shop', 5000);",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:sound:play',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Notifications & Sound',
|
||||
'description' => 'Plays a sound on the client.',
|
||||
'parameters' => [
|
||||
'fileName' => 'Sound file name',
|
||||
'volume' => 'Volume level (0.0 – 1.0)',
|
||||
'noAutoPath' => 'Set true to use a fully qualified path instead of the automatic one',
|
||||
'resourceName' => 'Resource that owns the sound file',
|
||||
],
|
||||
'lua_example' => "TriggerEvent('prp-bridge:sound:play', 'cash_register', 0.5, false, 'my-resource')",
|
||||
'js_example' => "emit('prp-bridge:sound:play', 'cash_register', 0.5, false, 'my-resource');",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:sound:playSpatial',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Notifications & Sound',
|
||||
'description' => 'Plays a 3D spatial sound at world coordinates.',
|
||||
'parameters' => [
|
||||
'fileName' => 'Sound file name',
|
||||
'volume' => 'Volume level (0.0 – 1.0)',
|
||||
'coords' => 'vector3 world position',
|
||||
'distance' => 'Max audible distance',
|
||||
'shouldMuffle' => 'Whether to apply interior muffling',
|
||||
'noAutoPath' => 'Set true to use a fully qualified path',
|
||||
'resourceName' => 'Resource that owns the sound file',
|
||||
],
|
||||
'lua_example' => "TriggerEvent('prp-bridge:sound:playSpatial', 'explosion', 1.0, vector3(100.0, 200.0, 30.0), 50.0, false, false, 'my-resource')",
|
||||
'js_example' => "emit('prp-bridge:sound:playSpatial', 'explosion', 1.0, [100.0, 200.0, 30.0], 50.0, false, false, 'my-resource');",
|
||||
],
|
||||
|
||||
// Core — Callbacks
|
||||
[
|
||||
'name' => 'prp-bridge:progress',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Callbacks',
|
||||
'description' => 'Progress bar callback. Invoked via lib.callback from the server.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "-- Invoked internally via lib.callback from the server\n-- Use lib.callback.await on the server to trigger it\nlib.callback('prp-bridge:progress', source, function(result)\n print('Progress result:', result)\nend, { duration = 5000, label = 'Processing...' })",
|
||||
'js_example' => '// Invoked internally via lib.callback from the server',
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:minigame',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Callbacks',
|
||||
'description' => 'Minigame callback. Invoked via lib.callback from the server.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "-- Invoked internally via lib.callback from the server\nlib.callback('prp-bridge:minigame', source, function(success)\n if success then\n print('Minigame passed!')\n end\nend, { type = 'circle', difficulty = 'easy' })",
|
||||
'js_example' => '// Invoked internally via lib.callback from the server',
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:confirmDialog',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Callbacks',
|
||||
'description' => 'Confirm dialog callback. Invoked via lib.callback from the server.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "-- Invoked internally via lib.callback from the server\nlib.callback('prp-bridge:confirmDialog', source, function(confirmed)\n if confirmed then\n print('Player confirmed!')\n end\nend, { title = 'Are you sure?', content = 'This cannot be undone.' })",
|
||||
'js_example' => '// Invoked internally via lib.callback from the server',
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:inputDialog',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Callbacks',
|
||||
'description' => 'Input dialog callback. Invoked via lib.callback from the server.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "-- Invoked internally via lib.callback from the server\nlib.callback('prp-bridge:inputDialog', source, function(input)\n print('Player entered:', input)\nend, { title = 'Enter value', inputs = { { type = 'input', label = 'Name' } } })",
|
||||
'js_example' => '// Invoked internally via lib.callback from the server',
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:placeProp',
|
||||
'side' => 'client',
|
||||
'category' => 'Core — Callbacks',
|
||||
'description' => 'Prop placer callback. Opens the prop placement UI. Invoked via lib.callback from the server.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "-- Invoked internally via lib.callback from the server\nlib.callback('prp-bridge:placeProp', source, function(coords)\n if coords then\n print('Prop placed at:', coords)\n end\nend, { model = 'prop_barrier_work05a' })",
|
||||
'js_example' => '// Invoked internally via lib.callback from the server',
|
||||
],
|
||||
|
||||
// Allowlist
|
||||
[
|
||||
'name' => 'prp-bridge:client:updateAllowlist',
|
||||
'side' => 'client',
|
||||
'category' => 'Allowlist',
|
||||
'description' => 'Fired when the player\'s allowlists are updated or loaded.',
|
||||
'parameters' => [
|
||||
'allowlists' => 'table<string, boolean> — map of allowlist name to whether the player has it',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:client:updateAllowlist', function(allowlists)\n if allowlists['my_allowlist'] then\n print('Player has my_allowlist!')\n end\nend)",
|
||||
'js_example' => "on('prp-bridge:client:updateAllowlist', (allowlists) => {\n if (allowlists['my_allowlist']) {\n console.log('Player has my_allowlist!');\n }\n});",
|
||||
],
|
||||
|
||||
// Medical
|
||||
[
|
||||
'name' => 'prp-bridge:client:revived',
|
||||
'side' => 'client',
|
||||
'category' => 'Medical',
|
||||
'description' => 'Fired when the local player is revived.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:client:revived', function()\n print('Player was revived!')\nend)",
|
||||
'js_example' => "on('prp-bridge:client:revived', () => {\n console.log('Player was revived!');\n});",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:client:died',
|
||||
'side' => 'client',
|
||||
'category' => 'Medical',
|
||||
'description' => 'Fired when the local player dies.',
|
||||
'parameters' => [],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:client:died', function()\n print('Player died!')\nend)",
|
||||
'js_example' => "on('prp-bridge:client:died', () => {\n console.log('Player died!');\n});",
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a single event for output.
|
||||
*/
|
||||
protected function formatEvent(array $event): string
|
||||
{
|
||||
return view('mcp.prodigy.prodigy-event-reference', [
|
||||
'event' => $event,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Format full event listing grouped by category.
|
||||
*/
|
||||
protected function formatEventList(array $events): string
|
||||
{
|
||||
$byCategory = collect($events)->groupBy('category')->toArray();
|
||||
|
||||
return view('mcp.prodigy.prodigy-event-list', [
|
||||
'eventsByCategory' => $byCategory,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
return [
|
||||
'event_name' => $schema
|
||||
->string()
|
||||
->description('The prp-bridge client event name to look up (e.g. "prp-bridge:notify"). Omit to list all client events.')
|
||||
->default(''),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,133 @@
|
||||
<?php
|
||||
|
||||
namespace App\Mcp\Tools\Prodigy\Client;
|
||||
|
||||
use Illuminate\Contracts\JsonSchema\JsonSchema;
|
||||
use Laravel\Mcp\Request;
|
||||
use Laravel\Mcp\Response;
|
||||
use Laravel\Mcp\Server\Attributes\Description;
|
||||
use Laravel\Mcp\Server\Tool;
|
||||
|
||||
#[Description('prp-bridge client-side exports reference. Covers the IsAllowlisted allowlist check, the PropPlacer UI, and the Ped Interactions system (AddPedInteraction, RemovePedInteraction).')]
|
||||
class GetProdigyClientExport extends Tool
|
||||
{
|
||||
/**
|
||||
* Handle the tool request.
|
||||
*/
|
||||
public function handle(Request $request): Response
|
||||
{
|
||||
$exportName = $request->get('export_name', '');
|
||||
|
||||
$exports = $this->getClientExports();
|
||||
|
||||
if ($exportName) {
|
||||
$export = collect($exports)->firstWhere('name', $exportName);
|
||||
if ($export) {
|
||||
return Response::text($this->formatExport($export));
|
||||
}
|
||||
|
||||
return Response::text("prp-bridge client export '$exportName' not found. See https://docs.prodigyrp.net/prp-bridge/exports.html for the full reference.");
|
||||
}
|
||||
|
||||
return Response::text($this->formatExportList($exports));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all prp-bridge client-side exports.
|
||||
*/
|
||||
protected function getClientExports(): array
|
||||
{
|
||||
return [
|
||||
// Allowlist
|
||||
[
|
||||
'name' => 'IsAllowlisted',
|
||||
'category' => 'Allowlist',
|
||||
'side' => 'client',
|
||||
'description' => 'Returns whether the current player character has a specific allowlist.',
|
||||
'parameters' => [
|
||||
['name' => 'allowlist', 'type' => 'string', 'description' => 'The allowlist key to check (e.g. "police_allowlist")'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if the character has the allowlist, false otherwise'],
|
||||
'lua_example' => "local isAllowed = exports['prp-bridge']:IsAllowlisted('police_allowlist')\nif isAllowed then\n print('Player has police_allowlist')\nend",
|
||||
],
|
||||
|
||||
// Prop Placer
|
||||
[
|
||||
'name' => 'PropPlacer',
|
||||
'category' => 'Prop Placer',
|
||||
'side' => 'client',
|
||||
'description' => 'Opens the interactive prop placement UI. Returns the final position and heading, or nil if the player cancelled.',
|
||||
'parameters' => [
|
||||
['name' => 'model', 'type' => 'number', 'description' => 'Model hash of the prop to place'],
|
||||
['name' => 'forceGround', 'type' => 'boolean?', 'description' => 'Force the prop to snap to the ground (optional)'],
|
||||
['name' => 'allowedMaterials', 'type' => 'table?', 'description' => 'Table of allowed surface material types (optional)'],
|
||||
['name' => 'maxDistance', 'type' => 'number?', 'description' => 'Maximum placement distance from the player (optional)'],
|
||||
],
|
||||
'returns' => ['type' => 'vector4 | nil', 'description' => 'vector4(x, y, z, heading) of the placed prop, or nil if cancelled'],
|
||||
'lua_example' => "local result = exports['prp-bridge']:PropPlacer(\n GetHashKey('prop_barrier_work05a'),\n true,\n nil,\n 10.0\n)\nif result then\n print('Placed at:', result.x, result.y, result.z, 'heading:', result.w)\nelse\n print('Placement cancelled')\nend",
|
||||
],
|
||||
|
||||
// Ped Interactions
|
||||
[
|
||||
'name' => 'AddPedInteraction',
|
||||
'category' => 'Ped Interactions',
|
||||
'side' => 'client',
|
||||
'description' => 'Registers a ped interaction. The ped spawns when a player enters the radius and is removed when they leave. Returns true on success, or false with an error string.',
|
||||
'parameters' => [
|
||||
['name' => 'id', 'type' => 'string', 'description' => 'Unique identifier for this ped interaction'],
|
||||
['name' => 'payload', 'type' => 'table', 'description' => 'Configuration table (model, coords, heading, radius, options, scenario/anim, component, weapon)'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean, string?', 'description' => 'true on success; false, "missing" if id/payload is nil; false, "exists" if id is already registered'],
|
||||
'lua_example' => "exports['prp-bridge']:AddPedInteraction('my_dealer', {\n model = 's_m_y_dealer_01',\n coords = vector3(100.0, 200.0, 30.0),\n heading = 180.0,\n radius = 50.0,\n scenario = 'WORLD_HUMAN_STAND_IMPATIENT',\n options = {\n {\n icon = 'fas fa-comments',\n label = 'Talk to Dealer',\n distance = 2.0,\n onSelect = function()\n openDealerMenu()\n end\n }\n }\n})",
|
||||
],
|
||||
[
|
||||
'name' => 'RemovePedInteraction',
|
||||
'category' => 'Ped Interactions',
|
||||
'side' => 'client',
|
||||
'description' => 'Removes a registered ped interaction and deletes the ped entity if it currently exists.',
|
||||
'parameters' => [
|
||||
['name' => 'id', 'type' => 'string', 'description' => 'The ID used when the ped was registered with AddPedInteraction'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if the ped was removed; false if the ID was not found'],
|
||||
'lua_example' => "local removed = exports['prp-bridge']:RemovePedInteraction('my_dealer')\nif not removed then\n print('Ped not found')\nend\n\n-- Auto-cleanup on resource stop is handled automatically.\n-- Use manual removal only when you need to remove the ped while the resource is still running.",
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a single export for output.
|
||||
*/
|
||||
protected function formatExport(array $export): string
|
||||
{
|
||||
return view('mcp.prodigy.prodigy-export-reference', [
|
||||
'export' => $export,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Format full export listing grouped by category.
|
||||
*/
|
||||
protected function formatExportList(array $exports): string
|
||||
{
|
||||
$byCategory = collect($exports)->groupBy('category')->toArray();
|
||||
|
||||
return view('mcp.prodigy.prodigy-export-list', [
|
||||
'exportsByCategory' => $byCategory,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
return [
|
||||
'export_name' => $schema
|
||||
->string()
|
||||
->description('The prp-bridge client export name to look up (e.g. "IsAllowlisted", "AddPedInteraction"). Omit to list all client exports.')
|
||||
->default(''),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,173 @@
|
||||
<?php
|
||||
|
||||
namespace App\Mcp\Tools\Prodigy\Server;
|
||||
|
||||
use Illuminate\Contracts\JsonSchema\JsonSchema;
|
||||
use Laravel\Mcp\Request;
|
||||
use Laravel\Mcp\Response;
|
||||
use Laravel\Mcp\Server\Attributes\Description;
|
||||
use Laravel\Mcp\Server\Tool;
|
||||
|
||||
#[Description('prp-bridge event reference for server-side events fired by the Prodigy Studios bridge resource. Includes player load/unload, group lifecycle, medical, and UniQueue events.')]
|
||||
class GetProdigyServerEventReference extends Tool
|
||||
{
|
||||
/**
|
||||
* Handle the tool request.
|
||||
*/
|
||||
public function handle(Request $request): Response
|
||||
{
|
||||
$eventName = $request->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("prp-bridge server-side event '$eventName' not found. See https://docs.prodigyrp.net/prp-bridge/events.html for the full reference.");
|
||||
}
|
||||
|
||||
return Response::text($this->formatEventList($events));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all prp-bridge server-side events.
|
||||
*/
|
||||
protected function getServerEvents(): array
|
||||
{
|
||||
return [
|
||||
// Framework
|
||||
[
|
||||
'name' => 'prp-bridge:server:playerLoad',
|
||||
'side' => 'server',
|
||||
'category' => 'Framework',
|
||||
'description' => 'Fired when a player character loads on the server.',
|
||||
'parameters' => [
|
||||
'src' => 'number — the player server ID',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:playerLoad', function(src)\n print('Player ' .. src .. ' character loaded')\nend)",
|
||||
'js_example' => "on('prp-bridge:server:playerLoad', (src) => {\n console.log(`Player \${src} character loaded`);\n});",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:server:playerUnload',
|
||||
'side' => 'server',
|
||||
'category' => 'Framework',
|
||||
'description' => 'Fired when a player character unloads on the server.',
|
||||
'parameters' => [
|
||||
'src' => 'number — the player server ID',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:playerUnload', function(src)\n print('Player ' .. src .. ' character unloaded')\nend)",
|
||||
'js_example' => "on('prp-bridge:server:playerUnload', (src) => {\n console.log(`Player \${src} character unloaded`);\n});",
|
||||
],
|
||||
|
||||
// Groups
|
||||
[
|
||||
'name' => 'prp-bridge:server:groupMemberAdded',
|
||||
'side' => 'server',
|
||||
'category' => 'Groups',
|
||||
'description' => 'Fired when a member joins a group.',
|
||||
'parameters' => [
|
||||
'src' => 'number — the player server ID who joined',
|
||||
'groupUuid' => 'string — unique identifier of the group',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:groupMemberAdded', function(src, groupUuid)\n print('Player ' .. src .. ' joined group ' .. groupUuid)\nend)",
|
||||
'js_example' => "on('prp-bridge:server:groupMemberAdded', (src, groupUuid) => {\n console.log(`Player \${src} joined group \${groupUuid}`);\n});",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:server:groupMemberRemoved',
|
||||
'side' => 'server',
|
||||
'category' => 'Groups',
|
||||
'description' => 'Fired when a member leaves or is kicked from a group.',
|
||||
'parameters' => [
|
||||
'src' => 'number — the player server ID who left',
|
||||
'groupUuid' => 'string — unique identifier of the group',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:groupMemberRemoved', function(src, groupUuid)\n print('Player ' .. src .. ' left group ' .. groupUuid)\nend)",
|
||||
'js_example' => "on('prp-bridge:server:groupMemberRemoved', (src, groupUuid) => {\n console.log(`Player \${src} left group \${groupUuid}`);\n});",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:server:groupDisbanded',
|
||||
'side' => 'server',
|
||||
'category' => 'Groups',
|
||||
'description' => 'Fired when a group is disbanded.',
|
||||
'parameters' => [
|
||||
'groupUuid' => 'string — unique identifier of the disbanded group',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:groupDisbanded', function(groupUuid)\n print('Group ' .. groupUuid .. ' was disbanded')\nend)",
|
||||
'js_example' => "on('prp-bridge:server:groupDisbanded', (groupUuid) => {\n console.log(`Group \${groupUuid} was disbanded`);\n});",
|
||||
],
|
||||
|
||||
// Medical
|
||||
[
|
||||
'name' => 'prp-bridge:server:revived',
|
||||
'side' => 'server',
|
||||
'category' => 'Medical',
|
||||
'description' => 'Fired when a player is revived. Source is implicit (use source/global.source).',
|
||||
'parameters' => [],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:revived', function()\n local src = source\n print('Player ' .. src .. ' was revived')\nend)",
|
||||
'js_example' => "on('prp-bridge:server:revived', () => {\n const src = global.source;\n console.log(`Player \${src} was revived`);\n});",
|
||||
],
|
||||
[
|
||||
'name' => 'prp-bridge:server:died',
|
||||
'side' => 'server',
|
||||
'category' => 'Medical',
|
||||
'description' => 'Fired when a player dies. Source is implicit (use source/global.source).',
|
||||
'parameters' => [],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:server:died', function()\n local src = source\n print('Player ' .. src .. ' died')\nend)",
|
||||
'js_example' => "on('prp-bridge:server:died', () => {\n const src = global.source;\n console.log(`Player \${src} died`);\n});",
|
||||
],
|
||||
|
||||
// UniQueue
|
||||
[
|
||||
'name' => 'prp-bridge:uniqueue:partyDestroyed',
|
||||
'side' => 'server',
|
||||
'category' => 'UniQueue',
|
||||
'description' => 'Fired when a UniQueue party is destroyed.',
|
||||
'parameters' => [
|
||||
'partyUuid' => 'string — unique identifier of the destroyed party',
|
||||
],
|
||||
'lua_example' => "AddEventHandler('prp-bridge:uniqueue:partyDestroyed', function(partyUuid)\n print('Party ' .. partyUuid .. ' was destroyed')\nend)",
|
||||
'js_example' => "on('prp-bridge:uniqueue:partyDestroyed', (partyUuid) => {\n console.log(`Party \${partyUuid} was destroyed`);\n});",
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a single event for output.
|
||||
*/
|
||||
protected function formatEvent(array $event): string
|
||||
{
|
||||
return view('mcp.prodigy.prodigy-event-reference', [
|
||||
'event' => $event,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Format full event listing grouped by category.
|
||||
*/
|
||||
protected function formatEventList(array $events): string
|
||||
{
|
||||
$byCategory = collect($events)->groupBy('category')->toArray();
|
||||
|
||||
return view('mcp.prodigy.prodigy-event-list', [
|
||||
'eventsByCategory' => $byCategory,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
return [
|
||||
'event_name' => $schema
|
||||
->string()
|
||||
->description('The prp-bridge server event name to look up (e.g. "prp-bridge:server:playerLoad"). Omit to list all server events.')
|
||||
->default(''),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,428 @@
|
||||
<?php
|
||||
|
||||
namespace App\Mcp\Tools\Prodigy\Server;
|
||||
|
||||
use Illuminate\Contracts\JsonSchema\JsonSchema;
|
||||
use Laravel\Mcp\Request;
|
||||
use Laravel\Mcp\Response;
|
||||
use Laravel\Mcp\Server\Attributes\Description;
|
||||
use Laravel\Mcp\Server\Tool;
|
||||
|
||||
#[Description('prp-bridge server-side exports reference. Covers Cooldowns, Allowlist, Groups, UniQueue, Sell Shops, and Cases exports provided by the Prodigy Studios bridge resource.')]
|
||||
class GetProdigyServerExport extends Tool
|
||||
{
|
||||
/**
|
||||
* Handle the tool request.
|
||||
*/
|
||||
public function handle(Request $request): Response
|
||||
{
|
||||
$exportName = $request->get('export_name', '');
|
||||
|
||||
$exports = $this->getServerExports();
|
||||
|
||||
if ($exportName) {
|
||||
$export = collect($exports)->firstWhere('name', $exportName);
|
||||
if ($export) {
|
||||
return Response::text($this->formatExport($export));
|
||||
}
|
||||
|
||||
return Response::text("prp-bridge server export '$exportName' not found. See https://docs.prodigyrp.net/prp-bridge/exports.html for the full reference.");
|
||||
}
|
||||
|
||||
return Response::text($this->formatExportList($exports));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all prp-bridge server-side exports.
|
||||
*/
|
||||
protected function getServerExports(): array
|
||||
{
|
||||
return [
|
||||
// Cooldowns
|
||||
[
|
||||
'name' => 'startGlobalCooldown',
|
||||
'category' => 'Cooldowns',
|
||||
'side' => 'server',
|
||||
'description' => 'Starts a global cooldown for all players for the given duration.',
|
||||
'parameters' => [
|
||||
['name' => 'cooldownKey', 'type' => 'string', 'description' => 'Unique key identifying this cooldown'],
|
||||
['name' => 'minutes', 'type' => 'number', 'description' => 'Duration of the cooldown in minutes'],
|
||||
],
|
||||
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
||||
'lua_example' => "exports['prp-bridge']:startGlobalCooldown('bank_robbery', 30)",
|
||||
],
|
||||
[
|
||||
'name' => 'startCooldownByIdentifier',
|
||||
'category' => 'Cooldowns',
|
||||
'side' => 'server',
|
||||
'description' => 'Starts a cooldown for a specific player identifier.',
|
||||
'parameters' => [
|
||||
['name' => 'identifier', 'type' => 'string', 'description' => 'The player state ID / identifier'],
|
||||
['name' => 'cooldownKey', 'type' => 'string', 'description' => 'Unique key identifying this cooldown'],
|
||||
['name' => 'minutes', 'type' => 'number', 'description' => 'Duration of the cooldown in minutes'],
|
||||
['name' => 'applyToAllCharacters', 'type' => 'boolean?', 'description' => 'Apply to all characters of the same player (optional)'],
|
||||
],
|
||||
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
||||
'lua_example' => "local identifier = GetPlayerIdentifier(source, 0)\nexports['prp-bridge']:startCooldownByIdentifier(identifier, 'drug_run', 15)",
|
||||
],
|
||||
[
|
||||
'name' => 'startCooldownByPlayerId',
|
||||
'category' => 'Cooldowns',
|
||||
'side' => 'server',
|
||||
'description' => 'Starts a cooldown for a player by their server ID.',
|
||||
'parameters' => [
|
||||
['name' => 'playerId', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
['name' => 'cooldownKey', 'type' => 'string', 'description' => 'Unique key identifying this cooldown'],
|
||||
['name' => 'minutes', 'type' => 'number', 'description' => 'Duration of the cooldown in minutes'],
|
||||
['name' => 'applyToAllCharacters', 'type' => 'boolean?', 'description' => 'Apply to all characters of the same player (optional)'],
|
||||
],
|
||||
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
||||
'lua_example' => "exports['prp-bridge']:startCooldownByPlayerId(source, 'drug_run', 15)",
|
||||
],
|
||||
[
|
||||
'name' => 'isCooldownActive',
|
||||
'category' => 'Cooldowns',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns whether a global cooldown is currently active.',
|
||||
'parameters' => [
|
||||
['name' => 'cooldownKey', 'type' => 'string', 'description' => 'The cooldown key to check'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if the global cooldown is active, false otherwise'],
|
||||
'lua_example' => "if exports['prp-bridge']:isCooldownActive('bank_robbery') then\n -- notify player to wait\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'isCooldownActiveForIdentifier',
|
||||
'category' => 'Cooldowns',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns whether a cooldown is active for a specific player identifier.',
|
||||
'parameters' => [
|
||||
['name' => 'identifier', 'type' => 'string', 'description' => 'The player state ID / identifier'],
|
||||
['name' => 'cooldownKey', 'type' => 'string', 'description' => 'The cooldown key to check'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if the cooldown is active for that identifier, false otherwise'],
|
||||
'lua_example' => "local identifier = GetPlayerIdentifier(source, 0)\nif exports['prp-bridge']:isCooldownActiveForIdentifier(identifier, 'drug_run') then\n -- notify player they must wait\nend",
|
||||
],
|
||||
|
||||
// Allowlist
|
||||
[
|
||||
'name' => 'GetAllowlist',
|
||||
'category' => 'Allowlist',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all allowlists for a character by their state ID.',
|
||||
'parameters' => [
|
||||
['name' => 'stateId', 'type' => 'string', 'description' => 'The character state ID'],
|
||||
],
|
||||
'returns' => ['type' => 'table<string, boolean>', 'description' => 'Map of allowlist name to whether the character has it'],
|
||||
'lua_example' => "local allowlists = exports['prp-bridge']:GetAllowlist(stateId)\nfor name, has in pairs(allowlists) do\n print(name, has)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'HasAllowlist',
|
||||
'category' => 'Allowlist',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns whether a character has a specific allowlist.',
|
||||
'parameters' => [
|
||||
['name' => 'stateId', 'type' => 'string', 'description' => 'The character state ID'],
|
||||
['name' => 'allowlist', 'type' => 'string', 'description' => 'The allowlist key to check'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if the character has the allowlist'],
|
||||
'lua_example' => "if exports['prp-bridge']:HasAllowlist(stateId, 'police_allowlist') then\n print('Has police allowlist')\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'AddAllowlist',
|
||||
'category' => 'Allowlist',
|
||||
'side' => 'server',
|
||||
'description' => 'Adds an allowlist to a character.',
|
||||
'parameters' => [
|
||||
['name' => 'source', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
['name' => 'stateId', 'type' => 'string', 'description' => 'The character state ID'],
|
||||
['name' => 'allowlist', 'type' => 'string', 'description' => 'The allowlist key to add'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if successfully added'],
|
||||
'lua_example' => "local success = exports['prp-bridge']:AddAllowlist(source, stateId, 'police_allowlist')\nif not success then\n print('Failed to add allowlist')\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'RemoveAllowlist',
|
||||
'category' => 'Allowlist',
|
||||
'side' => 'server',
|
||||
'description' => 'Removes an allowlist from a character.',
|
||||
'parameters' => [
|
||||
['name' => 'source', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
['name' => 'stateId', 'type' => 'string', 'description' => 'The character state ID'],
|
||||
['name' => 'allowlist', 'type' => 'string', 'description' => 'The allowlist key to remove'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true if successfully removed'],
|
||||
'lua_example' => "local success = exports['prp-bridge']:RemoveAllowlist(source, stateId, 'police_allowlist')\nif not success then\n print('Failed to remove allowlist')\nend",
|
||||
],
|
||||
|
||||
// Groups
|
||||
[
|
||||
'name' => 'CreateGroup',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Creates a new group with the specified player as the leader.',
|
||||
'parameters' => [
|
||||
['name' => 'leaderSrc', 'type' => 'number', 'description' => 'Server ID of the player who will be the group leader'],
|
||||
],
|
||||
'returns' => ['type' => 'table<{ success, error?, group? }>', 'description' => 'Result table with success boolean, optional error string, and optional group object'],
|
||||
'lua_example' => "local result = exports['prp-bridge']:CreateGroup(source)\nif result.success then\n local group = result.group\n print('Group created:', group.getUUID())\nelse\n print('Error:', result.error)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupFromMember',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns the group a player is currently in, or nil.',
|
||||
'parameters' => [
|
||||
['name' => 'src', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
],
|
||||
'returns' => ['type' => 'Group?', 'description' => 'The Group object if the player is in a group, nil otherwise'],
|
||||
'lua_example' => "local group = exports['prp-bridge']:GetGroupFromMember(source)\nif group then\n print('Player is in group:', group.getUUID())\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupFromMemberByIdentifier',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns the group a player identifier is currently in, or nil.',
|
||||
'parameters' => [
|
||||
['name' => 'identifier', 'type' => 'string', 'description' => 'The player state ID / identifier'],
|
||||
],
|
||||
'returns' => ['type' => 'Group?', 'description' => 'The Group object if found, nil otherwise'],
|
||||
'lua_example' => "local identifier = GetPlayerIdentifier(source, 0)\nlocal group = exports['prp-bridge']:GetGroupFromMemberByIdentifier(identifier)\nif group then\n print('Group UUID:', group.getUUID())\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupByUuid',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns a group by its unique identifier.',
|
||||
'parameters' => [
|
||||
['name' => 'uuid', 'type' => 'string', 'description' => 'The group UUID'],
|
||||
],
|
||||
'returns' => ['type' => 'Group?', 'description' => 'The Group object, or nil if not found'],
|
||||
'lua_example' => "local group = exports['prp-bridge']:GetGroupByUuid('some-group-uuid')\nif group then\n print('Found group with', #group.getMembers(), 'members')\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupByPartyUuid',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns a group by its linked UniQueue party UUID.',
|
||||
'parameters' => [
|
||||
['name' => 'uuid', 'type' => 'string', 'description' => 'The UniQueue party UUID linked to the group'],
|
||||
],
|
||||
'returns' => ['type' => 'Group?', 'description' => 'The Group object, or nil if not found'],
|
||||
'lua_example' => "local group = exports['prp-bridge']:GetGroupByPartyUuid(partyUuid)\nif group then\n print('Found group for party:', group.getUUID())\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupIdFromMember',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns the group UUID for a player if they are in a group.',
|
||||
'parameters' => [
|
||||
['name' => 'src', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
],
|
||||
'returns' => ['type' => 'string?', 'description' => 'The group UUID string, or nil if not in a group'],
|
||||
'lua_example' => "local groupId = exports['prp-bridge']:GetGroupIdFromMember(source)\nif groupId then\n print('Group ID:', groupId)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupIdFromMemberByIdentifier',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns the group UUID for a player identifier if they are in a group.',
|
||||
'parameters' => [
|
||||
['name' => 'identifier', 'type' => 'string', 'description' => 'The player state ID / identifier'],
|
||||
],
|
||||
'returns' => ['type' => 'string?', 'description' => 'The group UUID string, or nil if not in a group'],
|
||||
'lua_example' => "local identifier = GetPlayerIdentifier(source, 0)\nlocal groupId = exports['prp-bridge']:GetGroupIdFromMemberByIdentifier(identifier)\nif groupId then\n print('Group ID:', groupId)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetGroupPlayerIds',
|
||||
'category' => 'Groups',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all player server IDs currently in the specified group.',
|
||||
'parameters' => [
|
||||
['name' => 'uuid', 'type' => 'string', 'description' => 'The group UUID'],
|
||||
],
|
||||
'returns' => ['type' => 'number[]', 'description' => 'Array of player server IDs in the group'],
|
||||
'lua_example' => "local playerIds = exports['prp-bridge']:GetGroupPlayerIds(groupUuid)\nfor _, playerId in ipairs(playerIds) do\n TriggerClientEvent('myresource:start', playerId)\nend",
|
||||
],
|
||||
|
||||
// UniQueue
|
||||
[
|
||||
'name' => 'CreateQueue',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Creates a new mission queue. Most Prodigy resources create their own queues — use this only when building custom missions.',
|
||||
'parameters' => [
|
||||
['name' => 'name', 'type' => 'string', 'description' => 'Unique queue identifier'],
|
||||
['name' => 'type', 'type' => 'string', 'description' => 'Queue type: "civ" (civilian missions) or "crime" (crime missions)'],
|
||||
['name' => 'requiredPolicePower', 'type' => 'number', 'description' => 'Police power required to run the mission'],
|
||||
['name' => 'maxConcurrentTasks', 'type' => 'number', 'description' => 'Max missions from this queue running simultaneously'],
|
||||
['name' => 'cooldown', 'type' => 'number', 'description' => 'Seconds after a task ends before the next mission can run'],
|
||||
],
|
||||
'returns' => ['type' => 'UniQueue', 'description' => 'The created queue object'],
|
||||
'lua_example' => "local queue = exports['prp-bridge']:CreateQueue(\n 'my_mission',\n 'crime',\n 4, -- requires 4 police power\n 1, -- max 1 concurrent task\n 60 -- 60 second cooldown\n)\n\nqueue.setExecFunction(function(queueName, partyUuid, partyMembers, taskId)\n startMission(partyMembers, taskId)\nend)",
|
||||
],
|
||||
[
|
||||
'name' => 'GetQueue',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns a queue by its name, or nil if not found.',
|
||||
'parameters' => [
|
||||
['name' => 'name', 'type' => 'string', 'description' => 'The queue name used in CreateQueue'],
|
||||
],
|
||||
'returns' => ['type' => 'UniQueue?', 'description' => 'The queue object, or nil if not found'],
|
||||
'lua_example' => "local queue = exports['prp-bridge']:GetQueue('my_mission')\nif queue then\n print('Queue position count:', queue.getNumOfExecTasks())\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetQueuesByType',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all queue names of a given type.',
|
||||
'parameters' => [
|
||||
['name' => 'type', 'type' => 'string', 'description' => 'Queue type: "civ" or "crime"'],
|
||||
],
|
||||
'returns' => ['type' => 'table<string, boolean>', 'description' => 'Map of queue names of that type'],
|
||||
'lua_example' => "local crimeQueues = exports['prp-bridge']:GetQueuesByType('crime')\nfor queueName in pairs(crimeQueues) do\n print('Crime queue:', queueName)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'CreateParty',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Creates a new UniQueue party of the given type.',
|
||||
'parameters' => [
|
||||
['name' => 'type', 'type' => 'string', 'description' => 'Party type: "civ" or "crime"'],
|
||||
],
|
||||
'returns' => ['type' => 'UniQueueParty', 'description' => 'The created party object'],
|
||||
'lua_example' => "local party = exports['prp-bridge']:CreateParty('crime')\n\n-- Add members by identifier\nlocal identifier = GetPlayerIdentifier(source, 0)\nlocal result = party.addMember(identifier)\nif not result.success then\n print('Error:', result.error)\nend\n\n-- Join a queue\nlocal queue = exports['prp-bridge']:GetQueue('my_mission')\nqueue.add(party)",
|
||||
],
|
||||
[
|
||||
'name' => 'GetParty',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns a party by its UUID, or nil if not found.',
|
||||
'parameters' => [
|
||||
['name' => 'uuid', 'type' => 'string', 'description' => 'The party UUID'],
|
||||
],
|
||||
'returns' => ['type' => 'UniQueueParty?', 'description' => 'The party object, or nil if not found'],
|
||||
'lua_example' => "local party = exports['prp-bridge']:GetParty(partyUuid)\nif party then\n local members = party.getMembersAsArray()\n print('Party has', #members, 'members')\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetPartiesByType',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all party UUIDs of a given type.',
|
||||
'parameters' => [
|
||||
['name' => 'queueType', 'type' => 'string', 'description' => 'Party type: "civ" or "crime"'],
|
||||
],
|
||||
'returns' => ['type' => 'table<string, boolean>', 'description' => 'Map of party UUIDs of that type'],
|
||||
'lua_example' => "local crimeParties = exports['prp-bridge']:GetPartiesByType('crime')\nfor partyUuid in pairs(crimeParties) do\n print('Crime party:', partyUuid)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetPartiesFromPlayer',
|
||||
'category' => 'UniQueue',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all party UUIDs the player identifier is currently in.',
|
||||
'parameters' => [
|
||||
['name' => 'identifier', 'type' => 'string', 'description' => 'The player state ID / identifier'],
|
||||
],
|
||||
'returns' => ['type' => 'table<string, boolean>', 'description' => 'Map of party UUIDs the player is in'],
|
||||
'lua_example' => "local identifier = GetPlayerIdentifier(source, 0)\nlocal parties = exports['prp-bridge']:GetPartiesFromPlayer(identifier)\nfor partyUuid in pairs(parties) do\n print('In party:', partyUuid)\nend",
|
||||
],
|
||||
|
||||
// Sell Shops
|
||||
[
|
||||
'name' => 'RegisterSellShop',
|
||||
'category' => 'Sell Shops',
|
||||
'side' => 'server',
|
||||
'description' => 'Registers a sell shop with accepted items and prices. Safe to call repeatedly — re-registering the same ID does nothing.',
|
||||
'parameters' => [
|
||||
['name' => 'id', 'type' => 'string', 'description' => 'Unique shop identifier'],
|
||||
['name' => 'payload', 'type' => 'table', 'description' => 'Config table with label, items (keyed by item name with label and price), optional reason and coords'],
|
||||
],
|
||||
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
||||
'lua_example' => "exports['prp-bridge']:RegisterSellShop('pawn_shop', {\n label = 'Pawn Shop',\n items = {\n ['gold_bar'] = { label = 'Gold Bar', price = 500 },\n ['silver_bar'] = { label = 'Silver Bar', price = 200 },\n ['diamond'] = { label = 'Diamond', price = 1000 },\n }\n})",
|
||||
],
|
||||
[
|
||||
'name' => 'OpenSellShop',
|
||||
'category' => 'Sell Shops',
|
||||
'side' => 'server',
|
||||
'description' => 'Opens a registered sell shop for a player. The player sees a stash UI and items are consumed for cash on move.',
|
||||
'parameters' => [
|
||||
['name' => 'source', 'type' => 'number', 'description' => 'The player server ID'],
|
||||
['name' => 'id', 'type' => 'string', 'description' => 'The shop ID registered with RegisterSellShop'],
|
||||
],
|
||||
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
||||
'lua_example' => "RegisterNetEvent('myresource:openShop', function()\n local src = source\n -- Register before opening (safe to call every time)\n exports['prp-bridge']:RegisterSellShop('pawn_shop', {\n label = 'Pawn Shop',\n items = {\n ['gold_bar'] = { label = 'Gold Bar', price = 500 },\n }\n })\n exports['prp-bridge']:OpenSellShop(src, 'pawn_shop')\nend)",
|
||||
],
|
||||
|
||||
// Cases
|
||||
[
|
||||
'name' => 'CreateCase',
|
||||
'category' => 'Cases',
|
||||
'side' => 'server',
|
||||
'description' => 'Registers a new loot case type. All item chances must sum to exactly 100.',
|
||||
'parameters' => [
|
||||
['name' => 'caseId', 'type' => 'string', 'description' => 'Unique case identifier (e.g. "CRIME_CASE")'],
|
||||
['name' => 'payload', 'type' => 'table', 'description' => 'Config table with optional label and required items array (each with name, chance, optional min/max/metadata/image)'],
|
||||
],
|
||||
'returns' => ['type' => 'boolean', 'description' => 'true on success; false if item chances do not sum to 100'],
|
||||
'lua_example' => "local success = exports['prp-bridge']:CreateCase('ROBBERY_CASE', {\n label = 'Robbery Loot',\n items = {\n { name = 'money', chance = 50, min = 200, max = 800 },\n { name = 'lockpick', chance = 30 },\n { name = 'weapon_pistol', chance = 20 },\n }\n})\nif not success then\n print('Item chances must sum to 100!')\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetCase',
|
||||
'category' => 'Cases',
|
||||
'side' => 'server',
|
||||
'description' => 'Gets case data by its unique identifier.',
|
||||
'parameters' => [
|
||||
['name' => 'caseId', 'type' => 'string', 'description' => 'The case ID used in CreateCase'],
|
||||
],
|
||||
'returns' => ['type' => 'CaseDataPayload?', 'description' => 'The case data table, or nil if not found'],
|
||||
'lua_example' => "local caseData = exports['prp-bridge']:GetCase('ROBBERY_CASE')\nif caseData then\n print('Case label:', caseData.label)\n print('Item count:', #caseData.items)\nend",
|
||||
],
|
||||
[
|
||||
'name' => 'GetAllCases',
|
||||
'category' => 'Cases',
|
||||
'side' => 'server',
|
||||
'description' => 'Returns all registered case types and their item data.',
|
||||
'parameters' => [],
|
||||
'returns' => ['type' => 'CaseDataPayload[]', 'description' => 'Array of all registered case data tables'],
|
||||
'lua_example' => "local allCases = exports['prp-bridge']:GetAllCases()\nfor _, caseData in ipairs(allCases) do\n print('Case:', caseData.label or 'unlabelled', '- Items:', #caseData.items)\nend",
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a single export for output.
|
||||
*/
|
||||
protected function formatExport(array $export): string
|
||||
{
|
||||
return view('mcp.prodigy.prodigy-export-reference', [
|
||||
'export' => $export,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Format full export listing grouped by category.
|
||||
*/
|
||||
protected function formatExportList(array $exports): string
|
||||
{
|
||||
$byCategory = collect($exports)->groupBy('category')->toArray();
|
||||
|
||||
return view('mcp.prodigy.prodigy-export-list', [
|
||||
'exportsByCategory' => $byCategory,
|
||||
])->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
return [
|
||||
'export_name' => $schema
|
||||
->string()
|
||||
->description('The prp-bridge server export name to look up (e.g. "startGlobalCooldown", "CreateGroup", "RegisterSellShop"). Omit to list all server exports.')
|
||||
->default(''),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -129,7 +129,7 @@ class GetQBCoreClientEventReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -235,7 +235,7 @@ class GetQBCoreClientFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -139,7 +139,7 @@ class GetQBCoreConfig extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -150,7 +150,7 @@ class GetQBCorePlayers extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -475,7 +475,7 @@ class GetQBCoreResourceList extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -311,7 +311,7 @@ class GetQBCoreResourceReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -163,7 +163,7 @@ class GetQBCoreSharedData extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -129,7 +129,7 @@ class GetQBCoreServerEventReference extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
@@ -392,7 +392,7 @@ class GetQBCoreServerFunction extends Tool
|
||||
/**
|
||||
* Get the tool's input schema.
|
||||
*
|
||||
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
||||
* @return array<string, JsonSchema>
|
||||
*/
|
||||
public function schema(JsonSchema $schema): array
|
||||
{
|
||||
|
||||
+32
-1
@@ -3,13 +3,44 @@
|
||||
namespace App\Models;
|
||||
|
||||
// use Illuminate\Contracts\Auth\MustVerifyEmail;
|
||||
use Database\Factories\UserFactory;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Foundation\Auth\User as Authenticatable;
|
||||
use Illuminate\Notifications\DatabaseNotification;
|
||||
use Illuminate\Notifications\DatabaseNotificationCollection;
|
||||
use Illuminate\Notifications\Notifiable;
|
||||
use Illuminate\Support\Carbon;
|
||||
|
||||
/**
|
||||
* @property int $id
|
||||
* @property string $name
|
||||
* @property string $email
|
||||
* @property Carbon|null $email_verified_at
|
||||
* @property string $password
|
||||
* @property string|null $remember_token
|
||||
* @property Carbon|null $created_at
|
||||
* @property Carbon|null $updated_at
|
||||
* @property-read DatabaseNotificationCollection<int, DatabaseNotification> $notifications
|
||||
* @property-read int|null $notifications_count
|
||||
*
|
||||
* @method static \Database\Factories\UserFactory factory($count = null, $state = [])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereCreatedAt($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereEmail($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereEmailVerifiedAt($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereName($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User wherePassword($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereRememberToken($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User whereUpdatedAt($value)
|
||||
*
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class User extends Authenticatable
|
||||
{
|
||||
/** @use HasFactory<\Database\Factories\UserFactory> */
|
||||
/** @use HasFactory<UserFactory> */
|
||||
use HasFactory, Notifiable;
|
||||
|
||||
/**
|
||||
|
||||
Reference in new issue
Block a user