Skip to main content
Glama

read_script

Retrieves the source code of a Roblox Script, LocalScript, or ModuleScript by its path so you can inspect and understand existing behavior.

Instructions

Read the source of a Script/LocalScript/ModuleScript 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": {
      "path": "<path>"
    },
    "name": "read_script"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It does not state that the operation is read-only (only implied by 'Read'), what happens when the path is invalid or points to a non-script instance, whether the full source is returned untruncated, or whether any permission/Studio-connection prerequisite exists.

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?

One front-loaded sentence with no filler; the script-type enumeration is informative rather than redundant. Nothing wasteful is present.

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?

For a one-parameter read tool with no output schema, the definition is minimally sufficient to identify the action. However, it leaves the critical path syntax and failure behavior undefined, which an agent needs in order to call it correctly on the first try.

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

Parameters1/5

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

The single parameter has 0% schema description coverage, and the description only repeats 'by path' without defining the path format (e.g., dot-separated instance hierarchy, leading service name, whether collection-service prefixes are allowed). Given a required path parameter and an empty schema, the description does nothing to compensate.

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?

The description names a specific verb ('Read') and resource ('source of a Script/LocalScript/ModuleScript'), and the 'by path' clause scopes it. It implicitly distinguishes itself from list_scripts and write_script, though it never names those siblings explicitly.

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 when-to-use or when-not-to-use guidance and no mention of the obvious alternatives (list_scripts to discover paths, write_script to modify them). The only hint is the phrase 'by path', which implies the caller must already know a valid path.

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