brand_brandcode_sync

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

With no annotations, the description fully carries behavioral disclosure. It explains direction defaults, delta-awareness via syncToken, return values (sync mode, changed areas, sync token), and auth needs for push. Lacks explicit mention of potential overwrite or conflict resolution 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.

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

Three sentences, no waste. Front-loads main purpose, then efficiently covers directions, prerequisites, usage triggers, and return values. Every sentence earns its place.

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 2 fully-described parameters, no output schema, and no annotations, the description adequately covers purpose, usage, prerequisites, and return summary. Could detail return structure more, but sufficient for agent understanding.

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 has 100% description coverage, baseline 3. Description adds extra context: direction default, auth requirement for push, and share_token only needed for pull. This slightly exceeds baseline by providing usage nuance beyond schema.

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 tool syncs local .brand/ with Brandcode Studio, specifies two directions (pull and push), and distinguishes itself from sibling tools like brand_brandcode_connect and brand_brandcode_status by stating what it is NOT for.

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?

Provides explicit when-to-use examples ('sync brand', 'push to Studio', etc.), when-not-to-use (initial connection, status), prerequisites (prior connect), and auth requirement for push, giving clear guidance on alternatives and context.

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