Skip to main content
Glama

query_instances

Query Roblox instances to get, find children or descendants, search by name or class, and retrieve class information or project structure.

Instructions

Query Roblox instances: get, children, find child/descendant, wait for child, class info, search by name/class. [PRO] file_tree, project_structure, descendants, ancestors, search by property/tag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesQuery action to perform. Basic: get, children, find_child, find_descendant, wait_for_child, class_info, search_name, search_class. [PRO]: search_property, search_tag, file_tree, project_structure, descendants, ancestors.
pathNoInstance path to query (e.g., "game.Workspace.Part"). Used by: get, children, find_child, find_descendant, wait_for_child, descendants, ancestors.
childNameNoName of the child instance to find. Used by: find_child, wait_for_child.
descendantNameNoName of the descendant instance to find. Used by: find_descendant.
classNameNoRoblox class name. Used by: find_child/find_descendant (optional filter), class_info (required), search_class (required).
recursiveNoIf true, returns all descendants instead of just immediate children. Used by: children. Default: false.
maxDepthNoMaximum depth for recursive traversal. Used by: children (default: 10), file_tree (default: 5).
timeoutNoMaximum time to wait in seconds. Used by: wait_for_child. Default: 5. Maximum: 30.
rootNoRoot path to search/scan from. Used by: search_name, search_class, search_property, search_tag, file_tree, project_structure. Default: "game".
queryNoSearch pattern for name search (supports * and ? wildcards). Used by: search_name.
propertyNameNo[PRO] Property name to search by. Used by: search_property.
propertyValueNo[PRO] Property value to match. Used by: search_property.
tagNo[PRO] Tag string to search by (case-sensitive). Used by: search_tag.
includeServicesNo[PRO] Include Roblox services when root is "game". Used by: file_tree. Default: true.
includeSubclassesNoInclude subclasses in class search (e.g., BasePart finds Part, MeshPart). Used by: search_class. Default: true.
caseSensitiveNoCase-sensitive name search. Used by: search_name. Default: false.
maxResultsNoMaximum results to return. Used by: search_name, search_class, search_property, search_tag, descendants. Default: 100.
depthNo[PRO] Maximum depth for project structure traversal. Used by: project_structure. Default: 3.
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Without annotations, the description must carry behavioral disclosure. It provides feature-tier context via [PRO] labels, implying some features may be gated. However, it lacks critical behavioral details: return format (what does 'query' return?), error handling (timeout behavior for 'wait_for_child'), performance characteristics (descendant searches can be expensive), or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense but efficient single-sentence structure. Front-loads the verb ('Query') and resource, followed by categorized action lists. Every phrase maps to specific functionality. No redundant prose, though the density sacrifices some readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 18 parameters and high schema coverage, the description doesn't need to re-document inputs. However, lacking both an output schema and return value description in prose, the agent cannot predict what data structure the tool yields (instance references, full property bags, paths?), which is a gap for a complex query tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the structured data fully documents all 18 parameters. The description adds no additional semantic context (syntax examples beyond schema, validation rules, or dependency constraints between parameters like 'action' and 'path'). Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States specific query actions (get, children, find_child, etc.) and identifies the resource (Roblox instances). The [PRO] grouping distinguishes capability tiers. It differentiates from siblings like 'mutate_instances' by emphasizing read/query operations, though it doesn't explicitly contrast with 'spatial_query'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Lists available actions but provides no guidance on when to select this tool versus siblings like 'spatial_query' or 'workspace_state'. No mention of prerequisites, execution order, or when specific actions (e.g., 'wait_for_child' vs 'find_child') are appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hope1026/roblox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server