Skip to main content
Glama

sync_pull

Export Roblox Studio scripts to a local folder for reading, editing, and grepping with normal file tools. Re-running rewrites only changed files and creates .studio conflict copies instead of overwriting edits.

Instructions

Export the place's scripts to a local folder (Rojo-style: .server.luau / .client.luau / .luau) so you can read/edit/grep them with your normal file tools. Safe to re-run: only changed files are rewritten; files edited on both sides produce a .studio conflict copy instead of being overwritten.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sync_pull"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirNoLocal folder. Default ./roblox-src (or RBX_SYNC_DIR).
forceNoOverwrite local edits / rebind folder to another place.
pathsNoOnly these subtrees, e.g. ['ServerScriptService'].
studioNoOptional. Target Studio (name substring, place id or id). Only needed when several Studios are open and none was selected.
sourcemapNoAlso generate Rojo-compatible sourcemap.json for Luau LSP / luau-analyze.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does real work: it discloses that only changed files are rewritten, that bidirectional edits produce a <file>.studio conflict copy rather than data loss, and that the tool is idempotent. It omits prerequisites such as needing an active Studio connection and how results are reported.

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 dense sentences with the export action and output format front-loaded, followed by the safety/re-run semantics. No filler and nothing buried.

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?

All five optional parameters are documented in the schema and the description covers the file-layout output and conflict behavior, which is the main thing an agent needs. It lacks a note on Studio-connection prerequisites and on how the tool reports what it wrote, which matters since there is no output schema.

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 coverage is 100% and every parameter, including force and sourcemap, is already documented in the schema. The description adds no syntax or format detail beyond what the schema provides, so the 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?

"Export the place's scripts to a local folder" states a specific verb and resource, and the parenthetical spells out the exact output layout (.server.luau / .client.luau / .luau). The directionality (export to local) distinguishes it from the sync_push sibling 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 Guidelines4/5

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

It gives clear operating context: use it so you can read/edit/grep the scripts with normal file tools, and it is safe to re-run. It stops short of naming an explicit alternative (e.g. sync_push to upload edits back) or stating when-not-to-use, so it is clear but not fully routing.

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