Skip to main content
Glama

get_properties

Read-only

Read property values of a Roblox instance as JSON, optionally filtered by names, to inspect positions, sizes, and other class data without modifying the place.

Instructions

Read property values of one instance as JSON. Read-only. Without names it returns Name, ClassName, all attributes and a common set (Position, Size, CFrame, Color, Material, Transparency, Anchored, Text, Visible, Enabled, Value, Source and more) that applies to the class; Roblox has no API to list every property, so pass names for anything else. For identity, children, tags and attributes in one call use describe; for attributes only use get_attributes.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "get_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesInstance to read. Dot path from the DataModel root, e.g. "Workspace.Map.Door" or "StarterGui.HUD.Frame". A leading "game." is optional; a duplicate sibling name takes the suffix Tufan prints, e.g. "Part (2)".
namesNoExact property names to read, e.g. ["Size", "ZIndex"]. Names that do not exist on the class are left out of the result.
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • addedInput schema / properties / names / description
      Added value: +"Exact property names to read, e.g. [\"Size\", \"ZIndex\"]. Names that do not exist on the class are left out of the result."
    • addedInput schema / properties / path / description
      Added value: +"Instance to read. Dot path from the DataModel root, e.g. \"Workspace.Map.Door\" or \"StarterGui.HUD.Frame\". A leading \"game.\" is optional; a duplicate sibling name takes the suffix Tufan prints, e.g. \"Part (2)\"."
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered; the description still adds substantive behavior: the exact default property set returned when names is omitted, and the Roblox platform limitation that no API enumerates every property. It does not cover pagination or size limits, but those are minor for a single-instance read.

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?

Front-loaded with the action and the return shape, then the fallback behavior, then sibling routing. The parenthetical property enumeration is long but earns its place by defining the default result; otherwise there is no filler.

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

Completeness5/5

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

There is no output schema, and the description compensates by describing what the JSON contains in both the default and explicit-names cases, plus the platform limitation that shapes expectations. Nothing an agent needs to call this correctly or interpret the result is missing.

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 real semantics beyond the schema: it explains the default-vs-explicit tradeoff for the optional names array and why the platform forces explicit names. That is meaning an agent cannot get from the field descriptions alone.

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 ('Read property values of one instance as JSON') and immediately scopes the result shape. It explicitly separates itself from two siblings, describe and get_attributes, so an agent can pick correctly without inspecting schemas.

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

Usage Guidelines5/5

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

Gives concrete when-to-use branches: omit names for the common default set, pass names for anything else, use describe for identity/children/tags/attributes in one call, use get_attributes for attributes only. That is explicit routing with named alternatives rather than implied usage.

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