Sync remembered history

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

With no annotations, the description discloses critical behavior: pruning is an irreversible full wipe of that source, is dry-run unless yes is true, and only includes conversation/issue history if enabled. It stops short of describing normal-sync idempotency or outputs, but the destructive-path details are well covered.

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 whole definition is one dense sentence, but it front-loads the primary sync purpose and packs prune behavior into the second half without redundancy. It could be split into clearer sentences, but nothing is wasted.

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 4-parameter tool with no output schema or annotations, the description covers the main action, the alternate destructive modes, the confirmation flag, and dry-run behavior. It leaves minor details unexplored (e.g., sync merge semantics), but an agent has enough to invoke it correctly.

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 value by explaining the relationship between pruneSource, pruneStaleShell, and yes (dry-run unless confirmed) and by illustrating what counts as a dead source. This goes beyond the field-level descriptions.

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 and resource: ingest new git, diff, shell, docs, and optionally conversation/issue history into the NexusMem local database. It also clearly distinguishes the alternate prune mode from normal syncing, so an agent can tell it apart from the read/search siblings.

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 gives clear context: use normal sync to add history, or pass pruneSource/pruneStaleShell when the goal is to delete a dead source's nodes. It does not explicitly compare against sibling tools, but the mode guidance is unambiguous and sufficient.

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