sync

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains the effects of force_rebuild (drops tables and re-ingests) and retry_skipped (clears skip markers). However, it does not describe other important behaviors such as whether the sync is incremental, what happens to files removed from the directory, or whether the operation is idempotent. The description adds some transparency but leaves significant gaps.

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 extremely concise with two short sentences. It front-loads the main purpose and immediately provides parameter explanations. There is no redundant or extraneous information; every word earns its place. This is a model of conciseness for a simple tool.

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 the tool's complexity (two boolean parameters, no annotations, output schema present but unknown), the description covers the parameters well but lacks details on overall sync behavior (e.g., incremental vs. full sync, handling of deleted files, potential data loss). The output schema exists but the description does not need to explain return values. Still, the description leaves room for ambiguity about the core operation, so completeness is adequate but not excellent.

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 description coverage is 0%, so the description must compensate. It explains both parameters: force_rebuild (drops every table and re-ingests) and retry_skipped (clears failed-file skip markers). This adds meaning beyond the schema, which only provides type and name. The explanations are concise and actionable, earning a high score despite the lack of comprehensive parameter documentation.

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 action (sync) and the resource (documents directory into vector store). It distinguishes from siblings like 'add' and 'crawl' by focusing on synchronization rather than individual additions or crawling. However, it does not specify the sync direction (e.g., one-way or bidirectional), which leaves some ambiguity.

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 does not provide any guidance on when to use this tool versus alternatives such as 'add' or 'crawl'. It explains the two boolean parameters but lacks explicit context on prerequisites, typical use cases, or situations to avoid using this tool. This leaves the agent without decision support for tool selection.

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