Synchronize Knowledge Index

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

Even though destructiveHint=true already signals potential destruction, the description adds useful behavioral context: the operation is staged, supports preview and execute, and reuses vectors for unchanged files while reconciling add/modify/delete changes. This gives the agent a clearer mental model of what will happen, though 'safely' is vague and no rollback or irreversibility detail is provided.

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 a single, tightly worded sentence that front-loads the primary action and then adds only high-signal behavioral details. There is no filler or redundancy.

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 destructive, two-phase sync tool with no output schema and an unexplained confirmationToken, the description is not fully complete: it does not say what a preview returns, whether execute requires confirmationToken, or how the token is obtained. Still, the core staged-sync model and destructive scope are communicated well enough for a basic agent to act cautiously.

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 0% schema description coverage, the description must compensate for documenting the parameters. It partially maps to the 'action' parameter by saying 'Preview or execute,' but it adds no real meaning beyond the schema enum, and it leaves confirmationToken completely unexplained—its purpose, whether execution requires it, and how an agent would obtain it are all absent.

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 opens with a specific verb-plus-resource pair, 'Preview or execute a staged content-hash sync,' and then explains the sync behavior with added/modified/deleted files. This makes the tool's role clear and distinguishes it from siblings like rag_build, rag_clear_index, and rag_restore_index.

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 this tool is for incrementally reconciling an index with changed source files, especially through the phrases 'staged content-hash sync' and 'unchanged files reuse existing vectors.' However, it never explicitly states when to choose rag_sync over rag_build, rag_clear_index, or rag_restore_index, nor does it describe prerequisites or sequencing.

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