Skip to main content
Glama

Get properties, attributes and tags of a Roblox instance

get-instance-properties

Inspect a Roblox Instance by path or debug ID to retrieve its properties, attributes, and tags for debugging or scripting.

Instructions

Inspect a Roblox Instance by path or debug ID to retrieve its properties, attributes, and tags.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rootNoThe path or expression returning the target instance (e.g., 'game.Workspace.Part' or 'game.Players.LocalPlayer')
debugIdNoTarget instance DebugId (used when path is unknown or instance is outside workspace)
propertiesNoOptional specific list of property names to retrieve. If omitted, common class properties will be probed automatically.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. 'Inspect ... to retrieve' weakly implies a read-only operation, but the description never states that nothing is mutated, offers no auth/permission requirements, and gives no sense of return shape or error behavior when the path is invalid.

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

Conciseness5/5

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

One sentence, front-loaded with the action and the returned data. Nothing is wasteful or redundant.

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

Completeness4/5

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

For a three-parameter read tool with no output schema and no annotations, this covers the essentials: what it targets and what it returns. It could add a note that omitting 'properties' triggers automatic probing of common class properties, which currently lives only in the schema.

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 all three parameters are documented in the schema itself. The description's phrase 'by path or debug ID' only hints at the root/debugId distinction already spelled out in the schema, so it adds little beyond the baseline.

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?

The description names a specific verb (inspect/retrieve) and the exact resources returned: properties, attributes, and tags of a Roblox instance. It's clear what the tool does, though it doesn't explicitly differentiate itself from nearby read-oriented siblings like search-instances or get-descendants-tree.

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?

It implies the two ways to target an instance (path or debug ID) and notes that the debug ID is for cases where the path is unknown, but it offers no guidance on when to choose this tool versus search-instances, get-descendants-tree, or get-game-info. No when-not or exclusion guidance is present.

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