sync

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

No annotations provided, so the description carries full burden. It discloses that force_rebuild drops tables and clears skip markers, and retry_skipped clears skip markers without dropping. This is good, though it could mention duration or destructive nature more explicitly.

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 concise, with a clear one-line purpose followed by parameter descriptions. It is well-structured but could be slightly more front-loaded with a brief summary of default behavior.

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 two boolean parameters and existence of an output schema, the description covers the essential behavior. It lacks mention of prerequisites or default sync behavior (e.g., incremental sync), but this is minor.

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%, but the description fully compensates by explaining each parameter in detail, including side effects and equivalency to CLI commands. This enables correct usage.

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 tool syncs the documents directory with the vector store. The verb 'sync' and resource are specific. It does not explicitly differentiate from siblings like 'add' or 'crawl', but the context implies a batch update.

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 explains the two boolean flags and their effects, including equivalency to 'lilbee rebuild' for force_rebuild. However, it lacks explicit guidance on when to use this tool versus alternatives like 'add' or 'reset'.

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