sync

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

The description discloses that despite a read-only interface, it causes I/O and forces dirty buffers to disk, acknowledging the destructiveHint annotation. Beyond annotations, it adds that it returns JSON with sync status, providing behavioral context.

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 very concise (three sentences plus a short note) and front-loaded with the key function. Every sentence adds value without 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?

Given low complexity (one optional parameter, no output schema), the description covers purpose, when to use, behavioral implications, and return format. It is fully adequate for the tool's context.

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% for the single parameter 'dry_run' with a clear description. The tool description does not add additional meaning beyond what the schema provides, so score is baseline 3.

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 'flush cached filesystem writes to persistent storage' and the resource 'filesystem writes to persistent storage'. It distinguishes from siblings by noting 'Read-only in interface but causes I/O' and mentions 'dd' as alternative.

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?

Explicitly says 'Use to ensure data durability before critical operations like system shutdown' (when to use) and 'Not for general use before every file operation — most commands flush on close' (when not to use). Also suggests 'See also 'dd'' as an alternative.

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