Datasets Sync Connection

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

Annotations already declare this is a non-read-only, non-destructive action, so the safety profile is covered. The description adds the meaningful effect detail that it forces a re-index and that an empty list triggers a full sync, but says nothing about whether the sync is asynchronous, how long it runs, or what permissions are required.

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 short sentences, no filler, with the core action stated first and the special-case parameter behavior second. Nothing needs to be cut.

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?

The output schema exists, so return values need not be described, and annotations cover the safety profile. What is missing is routing information against the similar sync tools and any hint about the connection_id parameter, which leaves the definition adequate but not complete.

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 description coverage is 0%, so the description carries the burden. It does explain that path accepts a list (empty list = full sync) and that path targets a warehouse path, but connection_id is left completely undefined in both schema and description.

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 verb and effect ('Force Sigma to re-index') plus the resource scope ('a warehouse path'), which is far more informative than the tool name 'sync_connection'. It does not, however, distinguish itself from sibling sync tools such as datasets_sync_all_tables_in_schema or datasets_bulk_sync_tenant_connections.

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?

'Pass empty list for full sync' is invocation guidance for a parameter, not tool-selection guidance. With several sibling sync operations in the toolset, the description offers nothing about when to pick this tool over datasets_sync_all_tables_in_schema or datasets_bulk_sync_tenant_connections.

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