d365fo_start_sync

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

No annotations are provided, so the description must carry the full burden. It mentions downloading and caching metadata but does not disclose side effects (e.g., whether it's destructive), idempotency, rate limits, or auth requirements. The return value is vaguely described.

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 clear and well-structured with a summary paragraph followed by an Args section. It is slightly verbose, as some details could be integrated, but overall it is efficient and front-loaded with the core purpose.

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 description adequately explains parameters but lacks details on the return value (only says 'Dictionary with sync session details') and does not mention prerequisites, error scenarios, or relationship to other sync tools. Given the absence of output schema, more context is needed.

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?

The schema has 0% description coverage, so the description compensates by explaining each parameter in detail, including the strategy options and their meanings, the global_version_id fallback behavior, and profile optionality. This adds significant value beyond the 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 starts a metadata synchronization session and returns a session ID. It lists the types of metadata cached. However, it does not differentiate from sibling sync tools like d365fo_cancel_sync or d365fo_get_sync_progress.

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?

No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites, such as needing an active connection, or when not to use it (e.g., if a sync is already running).

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