Synchronize Document

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

Annotations already declare destructiveHint=true, idempotentHint=false and readOnlyHint=false, so the safety profile is partly covered. The description adds genuinely useful context beyond them: the first call is a no-op that yields a token. It still says nothing about what the destructive sync actually does (e.g., relinquish semantics or how local files are affected).

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 with no filler, and the core action is front-loaded ahead of the token caveat.

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?

An output schema exists so return values need not be described, but for a destructive, non-idempotent mutation with 8 fully undocumented parameters and a required confirm_token flow, this description leaves far too much unspecified for an agent to invoke it safely.

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% across 8 parameters, so the description must compensate and largely does not. It explains only confirm_token's role; the required 'document' and 'comment' parameters, plus relinquish, compact, process_id and the save_local_before/after flags, are entirely undocumented.

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+resource ('Synchronize a workshared document with central'), which is distinguishable from siblings like revit_save_document and revit_close_document. It does not explicitly name or contrast an alternative sibling, so it falls short of a 5.

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?

The 'Needs confirm_token from a first call, which changes nothing' sentence conveys a required two-phase invocation pattern, which is real procedural guidance. However, it gives no when-to-use vs alternatives (save_document, close_document) and no prerequisites such as worksharing being enabled.

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