Skip to main content
Glama
Roblox Studio MCP Gateway

Roblox Studio MCP Gateway

by camilin7483

roblox_read

Read the properties of a single instance by its path so you can inspect Roblox place objects before editing or debugging.

Instructions

Read properties of one instance by path.

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": {
      "instance_path": "<instance_path>"
    },
    "name": "roblox_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
instance_pathYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the burden; 'Read' does convey a non-mutating, safe operation, which is meaningful. Beyond that it says nothing about path resolution rules, error behavior for bad paths, or whether property values are serialized or truncated – gaps that matter for a no-annotation tool.

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?

One short, front-loaded sentence with no filler. The brevity is efficient, though it edges toward under-specification rather than tightness.

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

Completeness3/5

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

An output schema exists, so return values needn't be explained, and the tool is simple (one param, no nesting). However, the one non-obvious thing an agent needs – the instance path format – is missing, so the definition is only minimally complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and there is one required parameter. The phrase 'by path' is the only hint, and it does not define the path syntax (dot-separated hierarchy, leading service name, indexing) or give an example. With the schema documenting nothing, the description falls short of compensating.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Read properties of one instance by path'. The 'one instance' scope is a useful disambiguation, but nothing distinguishes it from siblings like roblox_attrs, roblox_tree, or roblox_class that plausibly also surface instance properties.

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

Usage Guidelines2/5

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

There is no guidance on when to choose this over roblox_attrs or roblox_tree, and no stated prerequisites. It doesn't say what happens if the path is invalid or if the instance doesn't exist.

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