Skip to main content
Glama

query_instances

Navigate and search Roblox instance hierarchies: get instance by path, list children, find child or descendant, wait for child, get class info, or search by name, class, property, or tag.

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.
sessionDebugIdNoOptional same Studio/plugin session debug identity for resolving duplicate-named path targets. Used by: get, children, descendants, ancestors.
siblingIndexNoOptional 1-based same-name sibling index fallback for resolving duplicate-named path targets. Used by: get, children, 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.
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It does not disclose behavioral traits such as whether the tool is read-only (though implied), rate limits, authentication needs, or side effects. It only mentions PRO features.

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?

The description is two sentences, concise and to the point. It could be better structured (e.g., grouping basic vs PRO actions), but it is not verbose or redundant.

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

Completeness2/5

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

Given the tool has no output schema and 20 parameters, the description does not explain what the tool returns (e.g., instance paths, tables, etc.). This is a significant gap for an agent to understand the tool's full behavior.

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?

Schema description coverage is 100%, so baseline is 3. The description adds a summary of actions but does not provide additional meaning beyond what each parameter's 'Used by:' note already conveys. It adds marginal value.

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

Purpose5/5

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

The description starts with 'Query Roblox instances' and lists specific actions like get, children, find child/descendant, etc., clearly indicating the verb and resource. It distinguishes from sibling tools like mutate_instances by being a read-only query tool.

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

Usage Guidelines3/5

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

The description does not provide explicit guidance on when to use this tool versus alternatives like mutate_instances or other sibling tools. While the action list implies different use cases, there is no direct comparison or exclusion criteria.

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