Skip to main content
Glama

script_read

Reads Roblox script source with line numbers, including unsaved Studio editor changes, and prefers synced local files to inspect or verify code.

Instructions

Read a script's source (includes unsaved editor changes), with line numbers. Prefer the local files if the place is synced (sync_pull).

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": "script_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
endNo
pathYese.g. ServerScriptService.Main
startNo
studioNoOptional. Target Studio (name substring, place id or id). Only needed when several Studios are open and none was selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden. It usefully discloses that unsaved editor-buffer content is returned and that lines are numbered, but it says nothing about behavior on a missing path, permissions, large-file truncation, or whether start/end define a bounded range. Those are meaningful gaps for an unannotated tool.

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?

Two short sentences, front-loaded with the core action and scoping detail, then the routing advice. No redundant restatement of the name or filler.

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 simple read tool with no output schema and one required parameter, the definition covers purpose, output shape (line-numbered source), buffer-vs-disk behavior, and the sibling alternative. Only the meaning of start/end and failure behavior are 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 50%: path and studio are documented in the schema, while start and end have no description in either place. The description never explains that start/end select a line range or whether the bounds are inclusive, so it only indirectly hints at them via 'with line numbers'. It does not compensate for the coverage gap.

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 a script's source') and adds two distinguishing characteristics: unsaved editor changes are included, and output is line-numbered. It does not differentiate from the sibling script_grep (search vs. read), but it does name sync_pull as the alternative for synced places.

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

Usage Guidelines4/5

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

Gives an explicit conditional alternative: 'Prefer the local files if the place is synced (sync_pull).' That is a clear when-not-to-use rule. It offers no guidance on choosing between this tool and script_grep or script_check, leaving that inference to the agent.

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