Skip to main content
Glama

sync_start

Start live-syncing changes from a local host directory to a sandbox directory. Performs an initial full sync and continuously polls for updates every second, automatically ignoring .git, node_modules, and other common directories.

Instructions

Start watching a local host directory and live-syncing changes into the sandbox. Does an initial full sync, then polls for changes every second. Ignores .git, node_modules, pycache, .venv, .DS_Store.

Args: local_dir: Absolute path on the host to watch. sandbox_dir: Destination directory in the sandbox (default: /workspace). sandbox: Named sandbox to sync to (default "default")

Returns: Sync job ID and initial sync stats.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
local_dirYes
sandbox_dirNo/workspace
sandboxNodefault

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations, the description fully covers behavioral traits: initial full sync, polling frequency, ignored files. It does not mention blocking behavior or resource implications, but is otherwise transparent.

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?

The description is concise: one sentence for purpose, then bullet-pointed technical details and args. Front-loaded with the main action, no redundant information.

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?

Given the complexity (sync tool with output schema), the description covers key aspects: initial sync, polling, ignores files, parameters, and return values. Could mention error handling or prerequisites, but is sufficiently complete.

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

Parameters5/5

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

The schema has 0% description coverage, so the description compensates fully by explaining all three parameters with types, defaults, and roles (local_dir absolute path, sandbox_dir destination, sandbox name). This adds essential meaning.

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?

The description clearly states the verb 'Start watching' and 'live-syncing', and specifies the resources: local host directory and sandbox. It distinguishes from siblings like sync_stop and upload/download by describing its live-syncing behavior.

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?

The description provides clear context on usage (initial sync, polling every second) but does not explicitly mention when not to use it or alternatives. It implies use for continuous syncing, which is adequate.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bird/sandbox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server