Skip to main content
Glama

set_property

DestructiveIdempotent

Sets one property on a single Roblox instance in the edit copy as a single Studio undo step, failing with the Roblox error when the property is read-only or the value type is wrong.

Instructions

Set one property on one instance in the edit copy, recorded as one Studio undo step. Fails with the Roblox error if the property is read-only or the value has the wrong type. For more than one change use mass_edit (one call, one undo step); for attributes use set_attribute.

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

Input Schema

NameRequiredDescriptionDefault
nameYesProperty name, e.g. "Transparency" or "BackgroundColor3".
pathYesInstance to change. 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.
valueYesNew value. 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"}.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.1
    • addedInput schema / properties / name / description
      Added value: +"Property name, e.g. \"Transparency\" or \"BackgroundColor3\"."
    • addedInput schema / properties / path / description
      Added value: +"Instance to change. 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)\"."
    • addedInput schema / properties / value / description
      Added value: +"New value. 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.5/5.0
Behavior4/5

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

Adds real context beyond the annotations: the write lands in the edit copy, costs exactly one Studio undo step, and fails with the underlying Roblox error when the property is read-only or the value type is wrong. That failure-mode disclosure is what an agent most needs and is not derivable from readOnlyHint/destructiveHint/idempotentHint. It doesn't say whether a failed call leaves any partial state, but the single-property scope makes that largely moot.

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, each earning its place: what it does, how it fails, and where to go instead. The core behavior is front-loaded before the alternatives.

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?

For a single-property setter with four params, full schema coverage, annotations, and no output schema, this is complete: purpose, failure modes, undo semantics, and sibling routing are all covered. Nothing an agent needs to call it correctly is missing.

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% and already documents path format, property naming, place defaulting, and all typed wrappers ({Vector3}, {Color3}, {UDim2}, {CFrame}, {EnumItem}, {BrickColor}). The description adds no parameter-level meaning beyond that, so 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 and resource with scope: "Set one property on one instance in the edit copy, recorded as one Studio undo step." This differentiates it from mass_edit (multiple changes) and set_attribute (attributes) without needing to open either 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?

Explicitly names both alternatives and the conditions that select them: "For more than one change use mass_edit (one call, one undo step); for attributes use set_attribute." The routing is unambiguous and includes the rationale (undo granularity).

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