sync_portfolio

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

With no annotations provided, the description carries full burden and does well by disclosing key behavioral traits: safety recommendations ('ALWAYS run with dry_run:true first'), mode-specific behaviors (additive never deletes, mirror requires confirmations, backup treats GitHub as source), and sibling tool differentiation. It doesn't mention rate limits or authentication requirements, but covers most operational aspects.

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 efficiently structured with zero wasted sentences. It front-loads the core purpose, then explains modes, provides critical safety advice, and ends with sibling tool differentiation. Every sentence adds essential information for correct tool usage.

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?

For a complex synchronization tool with 5 parameters and no output schema, the description provides strong contextual completeness. It covers purpose, modes, safety practices, and sibling differentiation. The main gap is lack of information about return values or what happens after sync completes, but given the operational focus, it's reasonably 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?

With 100% schema description coverage, the baseline is 3. The description adds some value by explaining mode semantics ('additive' as safest default, 'mirror' with deletion confirmations, 'backup' mode purpose) and reinforcing the dry_run recommendation, but doesn't provide significant additional parameter context beyond what's already well-documented in 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's purpose with specific verbs ('sync ALL elements') and resources ('local portfolio', 'GitHub repository'), distinguishing it from sibling tools like 'portfolio_element_manager' for individual elements. It explicitly defines the scope as comprehensive synchronization.

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 provides explicit guidance on when to use this tool vs. alternatives: 'ALWAYS run with dry_run:true first' for safety, and 'For individual elements, use 'portfolio_element_manager' instead.' It also explains when to use different modes (additive for safety, mirror for exact sync, backup for GitHub as backup source).

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