sync_library

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

With no annotations supplied, the description carries the full burden. It does disclose key side effects: writes markdown files into a local directory, organizes by tag with frontmatter, and keeps cursor state in <dir>/.web2md-sync.json. It omits what happens to previously synced files when library items are deleted, permission/auth requirements, and whether any report is returned.

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?

Two dense sentences with the core action and format front-loaded, and the incremental/state-file behavior immediately after. No filler, though the parenthetical could be tightened slightly.

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?

No output schema and no annotations, so the description must convey behavior, and it does cover destination format, incremental state, and the override flag. Still missing is what happens to orphaned files and any returned summary, which matters for a tool that mutates a local directory.

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 each parameter is already documented in the schema. The description only adds the notion that syncing is incremental by default, which gives context for the full flag, but it does not explain tag semantics or path constraints beyond 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?

States a specific verb (sync) and resource (Web2MD library) plus the output form: markdown files organized by tag with frontmatter. It is clearly distinct from read-only siblings like search_library and get_library_items, but never names them, so the differentiation is implicit rather than explicit.

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 phrase 'Incremental by default' implies the normal use case and hints that the full flag is the exception, but there is no explicit when-to-use/when-not guidance and no routing away from siblings such as search_library or get_library_items for read-only needs.

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