Skip to main content
Glama

describe

Read-only

Retrieve complete context on one Roblox instance in a single call: identity, properties, attributes, tags, child summary, scripts and bounds. Read-only, replaces 5-6 separate queries.

Instructions

Full context of one instance in a SINGLE call: identity, key properties, attributes, tags, a class-bucketed child summary, attached scripts (with line counts), and world bounds. Replaces the 5-6 round-trips (get_properties + get_children + get_attributes + get_tags + script grep) it used to take to understand a node. Read-only. For a whole area use get_tree; for property values describe doesn't show, use get_properties with names.

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": "describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesInstance to describe. 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)".
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / path / description
      Added value: +"Instance to describe. 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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, yet the description adds real behavioral context: the child data is a bucketed summary rather than a full tree, scripts come with line counts, and property values are only partial (route to get_properties for the rest). That partial-output disclosure is the kind of thing an agent cannot get from the annotations, though nothing is said about size limits or truncation on large instances.

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 payload, then the round-trip justification, then the disambiguation. Three tightly packed sentences with no filler, and the sibling routing is placed last where an agent scans for alternatives.

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 carries the return-value burden and does so by enumerating the response sections and flagging that some property values are omitted. It stops short of describing what happens on very large instances (truncation, depth limits) or the shape of the bucketed child summary, which is the one place an agent could still be surprised.

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 both `path` (dot path, optional 'game.' prefix, 'Part (2)' duplicate suffix) and `place` are already fully documented. The description adds no syntax or format meaning beyond the schema, so the baseline 3 applies.

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 (describe) and resource (one instance) and then enumerates exactly what comes back: identity, key properties, attributes, tags, bucketed child summary, attached scripts with line counts, and world bounds. This is distinguishable from get_properties, get_tree, and get_attributes without opening any schema.

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 explicit routing: use get_tree for a whole area, use get_properties with names when a specific property value isn't shown here, and frames the tool as replacing the 5-6 round-trips of get_properties + get_children + get_attributes + get_tags + script grep. Both the when-to-use and the when-to-use-something-else cases are covered.

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