sync_project

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

With no annotations provided, the description carries the burden of behavioral disclosure. It reveals that the tool downloads all YAML files, may use bulk or batched fallback, and that force=true re-syncs an already cached project—important caveats. It doesn't cover potential side effects like cache overwriting, but the core behavior is well disclosed.

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?

The description is two sentences, front-loaded with the main purpose, and every clause adds value. No redundant or filler content.

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?

Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description provides adequate high-level context: what it does, how it works (downloads all YAML), and the force option. It is slightly incomplete regarding the lifecycle of the local cache or how to verify sync success, but not critically so.

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?

Schema coverage is 100% for both parameters: projectId and force. The description adds no new semantic meaning beyond the schema; it only restates the force behavior ('Use force=true to re-sync an already cached project') which matches the schema description. Baseline of 3 is appropriate.

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?

The description clearly states the action ('Sync an entire FlutterFlow project to the local cache') with a specific verb and resource. It distinguishes itself from sibling tools by emphasizing the whole-project cache download, not just fetching individual files or listings.

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?

It provides clear context: use for 'fast offline reads' and to re-sync with 'force=true'. Though it doesn't explicitly name alternatives or when-not-to-use, the context is sufficient to identify appropriate usage compared to more targeted file-fetching tools like get_project_yaml.

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