Skip to main content
Glama

sync_status

Compare the local folder with Roblox Studio to reveal local edits, Studio edits, new or removed scripts, and conflicts. Read-only, so you can review differences before syncing.

Instructions

What differs between the local folder and Studio: local edits, Studio edits, new/removed scripts, conflicts. Read-only.

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_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirNo
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

B3.2/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 does usefully disclose that the tool is read-only and that nothing is mutated. It does not state whether a live Studio connection is required, what happens when no Studio is open, or how the diff is presented, leaving real behavioral gaps.

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 sentence, front-loaded with the core question and then a compact colon list of categories, followed by the read-only qualifier. No wasted wording; slightly list-like but appropriately sized.

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 two-optional-parameter read-only tool with no output schema, the description covers what is compared but not the calling preconditions (open Studio, selected workspace) or what the response looks like. Adequate but with clear gaps.

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 only 50%: 'studio' is described in the schema, but 'dir' has no description anywhere. The description mentions neither parameter and adds no meaning beyond what the schema provides, so it does not compensate for the 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?

The description names a concrete operation (reporting differences) between two specific resources, the local folder and Studio, and enumerates the diff categories (local edits, Studio edits, new/removed scripts, conflicts). This is enough for an agent to separate it from sync_pull/sync_push, 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 Guidelines3/5

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

The trailing 'Read-only' implies this is the inspect-before-acting step in the sync workflow, but the description never says when to prefer it over sync_pull or sync_push. Usage must be inferred from the read-only marker rather than stated.

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