Skip to main content
Glama

search_by_property

Read-only

Find all instances under a root whose property exactly matches a value and list their paths, so you can locate parts, labels, or objects by property without editing anything.

Instructions

Find every instance under a root whose property equals a given value, and list their paths. Read-only. Use it for questions like "which parts are still Anchored=false" or "which labels use Font Arial". To find by name or class use search_objects; to search the Roblox marketplace use search_assets.

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": {
      "name": "<name>",
      "value": "<value>"
    },
    "name": "search_by_property"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesProperty to compare, e.g. "Anchored" or "Material".
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.
valueYesValue to match exactly. Write a primitive (string, number, boolean) or a typed wrapper: {Vector3:[x,y,z]}, {Color3:[r,g,b]} (0-1), {UDim2:[xScale,xOffset,yScale,yOffset]}, {CFrame:[x,y,z] or all 12 components}, {EnumItem:"Enum.Material.Wood"}, {BrickColor:"Bright red"}.
rootPathNoWhere to start searching. 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)". Omit to use the whole DataModel (game).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / name / description
      Added value: +"Property to compare, e.g. \"Anchored\" or \"Material\"."
    • addedInput schema / properties / rootPath / description
      Added value: +"Where to start searching. 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)\". Omit to use the whole DataModel (game)."
    • addedInput schema / properties / value / description
      Added value: +"Value to match exactly. Write a primitive (string, number, boolean) or a typed wrapper: {Vector3:[x,y,z]}, {Color3:[r,g,b]} (0-1), {UDim2:[xScale,xOffset,yScale,yOffset]}, {CFrame:[x,y,z] or all 12 components}, {EnumItem:\"Enum.Material.Wood\"}, {BrickColor:\"Bright red\"}."
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so 'Read-only' in the description is redundant. It does add that the result is a list of paths, which is useful behavioral context, but says nothing about result volume, ordering, or behavior when nothing matches.

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?

Three sentences, front-loaded with the core behavior, then the routing alternatives. Every sentence carries information and none repeat the schema.

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 4-parameter read tool with no output schema, the definition covers scope, matching semantics, and partial return shape (paths). Missing only minor operational detail such as result limits or the no-match case, which is small given the complete 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 would be 3, but the example queries clarify how the name/value pair is meant to be read (bare property names like Anchored, exact-match values) and 'under a root' reinforces the rootPath scoping. That is genuine added meaning over the schema text.

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: find every instance under a root whose property equals a given value, and list their paths. It is immediately distinguishable from search_objects (name/class) and search_assets (marketplace), so an agent can pick it without opening a 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 concrete example questions ('which parts are still Anchored=false', 'which labels use Font Arial') that map directly to the property-search use case, and explicitly routes elsewhere for name/class and marketplace searches. The when-to-use and when-not-to-use conditions are both present.

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