sync_project

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

With no annotations, the description carries the full behavioral burden and handles it well by disclosing that the tool creates/updates scripts and folders and removes previously synced instances that no longer exist on disk. This warns the agent about destructive side effects. It does not cover failure modes or conflict handling, but the core mutation behavior is transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences: the first front-loads the action and mode; the second lists effects. There is no filler or repetition.

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

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

For a single-parameter tool with no annotations or output schema, the description gives enough context to call it safely: what to pass, where it acts, and what side effects to expect. It does not describe return values or error outcomes, but those are less critical for invoking a sync operation.

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

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

While the schema only says 'project' is a required string with no description, the tool description explains that it represents a Rojo project file, which is the key semantic needed to invoke it correctly. It stops short of spelling out path/form requirements, so it is not perfect.

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

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

States a specific action ('Push scripts from a Rojo project file') and the target context ('open place, edit mode only'), then details the side effects of the sync. The combination of Rojo sync with create/update/remove behavior sets it apart from sibling tools like run_luau or reload_plugin.

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

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

The description makes the intended use clear: synchronize a Rojo project into the currently open place, and explicitly restricts use to edit mode. It does not name alternative sibling tools or provide when-not-to-use guidance beyond the edit-mode constraint.

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