Skip to main content
Glama
EL4CTEO

Roblox Studio MCP

Inspect instances

inspect
Read-onlyIdempotent

Read properties, attributes, tags and children of Roblox instances in one batched call, with concise, standard or full detail per path. Bad paths return as failures, not errors.

Instructions

Reads properties, attributes, tags and children of one or more instances. Pass every path you care about in a single call — batching costs one round trip instead of N.

Property selection comes from the live Roblox API dump for each instance's actual class, so it stays correct across engine updates: concise — class and child count only standard — the properties that characterise the class (Part gets Size, Position, CFrame, Anchored, Material...) full — every readable property; expensive, use on one or two instances at most

Bad paths do not fail the call: they come back under failures while the valid ones still return, so one typo does not cost you the whole batch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsYesInstance paths, e.g. ["Workspace.Baseplate", "Lighting"].
detailNoHow much to return per item. 'concise' = name + class only, cheapest, use when scanning or counting. 'standard' = the properties that matter for most edits. 'full' = every readable property, expensive — use only after you have narrowed to a handful of instances.standard
physicsNoAlso report mass, density, assembly root and centre of mass for any BasePart. Mass appears nowhere in Studio — it is computed from volume and material — so this is the only way to answer 'why does this fall over', 'why does it sink', or 'why did half the model stay behind when I moved it'.
studioIdNoTarget Studio; omit for the active one.
propertiesNoRead exactly these properties instead of the detail-level default. Use when you want one specific value across many instances.
includeChildrenNoInclude a name/class listing of direct children.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.6.5
    • addedInput schema / properties / physics
      Added value: +{
      +  "default": false,
      +  "description": "Also report mass, density, assembly root and centre of mass for any BasePart. Mass appears nowhere in Studio — it is computed from volume and material — so this is the only way to answer 'why does this fall over', 'why does it sink', or 'why did half the model stay behind when I moved it'.",
      +  "type": "boolean"
      +}
  2. First observedv0.1.8

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, and the description adds real behavior beyond that: partial-failure semantics ('bad paths come back under failures' and do not abort the batch), per-detail cost/expense profiles, and the fact that property selection tracks the live API dump. This is exactly the kind of context an agent cannot get from the schema.

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?

Front-loaded with the core capability and the batching rationale, then a compact bulleted breakdown of detail levels, then the failure-handling note. Every sentence carries information; nothing is filler.

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?

With no output schema, the description still covers parameters fully and discloses the key return-side behavior (the `failures` bucket), but it does not describe the overall response shape beyond that. Sufficient to invoke correctly, slightly short of complete for a read tool with no output schema.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds class-specific meaning ('Part gets Size, Position, CFrame, Anchored, Material...') for the detail levels. Minor inconsistency: the description says concise returns 'class and child count only' while the schema says 'name + class only'.

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?

States a specific verb and resource: 'Reads properties, attributes, tags and children of one or more instances.' It is easy to distinguish from siblings such as tree (structure listing), find (search) and script_read (source). The scope (one or more instances, batched paths) is explicit.

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

Usage Guidelines4/5

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

Gives clear operational guidance: batch all paths into one call, and reserve 'full' detail for one or two instances because it is expensive. It does not name a specific alternative sibling (e.g. when to prefer tree or find), but the when-to-use context for each detail level is unambiguous.

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