pce_sync

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

With no annotations, the description carries full behavioral disclosure burden. It adds some useful context: 'refreshes index state' and explicitly states it 'does not explain code.' However, it does not disclose side effects, persistence, reversibility, or idempotence. For a mutation-like operation, this is a moderate but not severe gap.

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 well-structured with labeled sections (Purpose, When to use, Best practice, Avoid). It is front-loaded with the core purpose and every sentence provides actionable guidance without redundancy or fluff.

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 zero-parameter tool, the description covers purpose, usage timing, best practice, and exclusions. It does not mention return values or behavior when the index is already in sync, but these are minor given the tool's simplicity and the presence of sibling tools like pce_status for checking state.

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 tool has zero parameters and 100% schema description coverage, so the baseline is 4. No parameter documentation is needed since there is nothing to explain.

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 states a specific verb and resource: "Synchronize Serena and PCE index state" and explains its goal: "so subsequent query / impact calls work against the latest code." It clearly distinguishes itself from query/impact tools by positioning itself as a preparatory synchronization step, and the 'Avoid' section separates it from code understanding tools.

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 'When to use' guidance (after batch code modifications, deletions, renames, structural changes), 'Best practice' (one batch call per round of changes), and 'Avoid' (not for code understanding). This gives an agent clear decision criteria for when and how to invoke the tool.

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