Description
Returns a high-level overview of the entire game, including all services, script counts, instance totals, and direct children. This is useful for understanding the overall structure and complexity of a place at a glance.
This tool scans all known services and provides counts of descendants, scripts, and direct children for each service. It may cap results at 50,000 descendants per service for performance.
HTTP Endpoint
POST /tool/summarize_game
Request Parameters
No parameters required.
The name of the current place
Array of service information objects Service name (e.g., “Workspace”, “ReplicatedStorage”)
The class name of the service
Number of immediate children
Total number of descendants (all nested instances)
Number of Script, LocalScript, and ModuleScript instances
True if descendant count was capped at the limit
Additional information (e.g., capping notice)
Total script count across all services
Total instance count across all services
Helpful suggestion for next steps
Example
const response = await fetch ( 'http://127.0.0.1:7766/tool/summarize_game' , {
method: 'POST' ,
headers: { 'Content-Type' : 'application/json' },
body: JSON . stringify ({})
});
const data = await response . json ();
console . log ( data . result );
// Example output:
// {
// "placeName": "My Adventure Game",
// "placeId": 123456789,
// "services": [
// {
// "name": "Workspace",
// "className": "Workspace",
// "directChildren": 12,
// "totalDescendants": 1543,
// "scripts": 8
// },
// {
// "name": "ReplicatedStorage",
// "className": "ReplicatedStorage",
// "directChildren": 5,
// "totalDescendants": 234,
// "scripts": 15
// }
// ],
// "totalScripts": 45,
// "totalInstances": 2891,
// "tip": "Use get_file_tree with a specific path and low depth to explore further."
// }
Implementation Details
From InstanceTools.lua:329-387:
Scans all known Roblox services
Counts scripts (Script, LocalScript, ModuleScript)
Caps descendant scanning at 50,000 per service for performance
Yields every 5,000 instances to prevent timeout
Only processes services in the KNOWN_SERVICES table