sync_to_aggregator

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

With no annotations, the description bears full responsibility for behavioral disclosure. It mentions sync modes but fails to describe whether full_sync is destructive (replaces all ADRs), does not mention any side effects like overwriting data on the aggregator, and omits information about rate limits, required permissions, or error states. The schema covers parameter details, but the description itself under-communicates behavior.

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 succinct sentences front-load the core purpose and follow with key capabilities. No superfluous text; every word carries meaning.

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 has 8 parameters, no output schema, and no annotations, the description should cover return values, error handling, and post-sync behavior. It provides none of these. For a sync operation to an external service, details about success/failure, connectivity requirements, and data transformation are missing.

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%, so the baseline is 3. The description adds the concept of 'incremental and full sync modes' and 'optional metadata', which broadly maps to the parameters but does not provide additional meaning beyond the schema descriptions. No explanation of how 'include_metadata' or other booleans affect the sync output.

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 verb (Sync), resource (ADRs), target platform (ADR Aggregator with URL), and purpose (centralized tracking, visualization, team collaboration). It also mentions supported modes (incremental/full) and optional metadata, which distinguishes it from any sibling tools that might perform other ADR operations.

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 description implies usage when ADRs need to be synchronized to the aggregator platform, but it does not provide explicit guidance on when to use this tool versus alternatives, nor does it mention prerequisites such as authentication, network connectivity, or project path configuration. It lacks when-not-to-use or exclusion conditions.

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