Skip to main content
Glama

objects_in_region

Read-only

Find parts overlapping a box, sphere, or area around an instance, returning part paths, world positions, and sizes. Use it for spatial queries like what's near X or inside a region.

Instructions

List parts whose bounds overlap a region: a box (center+size), a sphere (center+radius), or 'around' an instance (its bounding box, optionally padded). Spatial query for "what's near X / inside this area". Returns part paths + world pos + size. Read-only. Give center with size (box) or radius (sphere), or around instead. To find what is under a screen point use pick; to find by name use search_objects.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "objects_in_region"
  }
}

Input Schema

NameRequiredDescriptionDefault
padNogrow the 'around' box by this many studs each side
sizeNo[x,y,z] box size (box mode)
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.
aroundNoinstance path — use its bounding box as the region
centerNo[x,y,z] region center
ignoreNoDot paths of instances to leave out, together with their descendants.
radiusNosphere radius (sphere mode)
maxPartsNoMaximum parts to return, up to 500. Default 100.
classFilterNoOnly return parts of this class or a subclass, e.g. "MeshPart".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • changedInput schema / properties / classFilter / description
      Previous value: -"IsA filter"New value: +"Only return parts of this class or a subclass, e.g. \"MeshPart\"."
    • addedInput schema / properties / ignore / description
      Added value: +"Dot paths of instances to leave out, together with their descendants."
    • changedInput schema / properties / maxParts / description
      Previous value: -"default 100"New value: +"Maximum parts to return, up to 500. Default 100."
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so 'Read-only' is largely redundant. The description adds the return shape ('part paths + world pos + size') and clarifies that 'around' uses the instance's bounding box with optional padding, but says nothing about permissions, cost, or truncation behavior beyond what maxParts in the schema implies.

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 text is dense and front-loads the core definition followed by usage, return value, and mode instructions. Only 'Read-only' is wasted since annotations already carry it, and the mode sentence is slightly compressed to the point of terse.

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 9-parameter tool with no output schema, the description covers the return contents (paths, world position, size), the three region modes, and the sibling alternatives, which is enough to call it correctly. A note on default behavior when no mode parameters are supplied would close the remaining gap.

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; the description earns above that by explaining the mutual dependence of parameters ('Give center with size (box) or radius (sphere), or around instead'), which the schema lists flatly without expressing the mode exclusivity. It still doesn't explain pad or ignore semantics beyond the schema.

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 opens with a specific verb and resource ('List parts whose bounds overlap a region') and enumerates the three region modes (box, sphere, around), so the agent can tell exactly what the tool does and how it differs from siblings like pick and search_objects.

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?

It gives the triggering scenario ('Spatial query for "what's near X / inside this area"') and explicitly routes away to alternatives with conditions: 'To find what is under a screen point use pick; to find by name use search_objects.' Both when-to-use and when-not-to-use are covered.

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