Skip to main content
Glama

sync

Index a documents directory into a vector store, with options to rebuild all content, retry failed files, or prune sources excluded by .lilbeeignore.

Instructions

Sync the documents directory into the vector store.

force_rebuild re-ingests everything. retry_skipped retries failed files. prune_ignored drops sources .lilbeeignore excludes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ocrNoWhich pages OCR reads.
ocr_timeoutNo
force_rebuildNo
prune_ignoredNo
retry_skippedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.16
    • addedInput schema / properties / ocr
      Added value: +{
      +  "description": "Which pages OCR reads.",
      +  "enum": [
      +    "auto",
      +    "all",
      +    "off"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / ocr_timeout
      Added value: +{
      +  "type": "number"
      +}
  2. Changed1 schema field changedv1.0.5
    • addedInput schema / properties / prune_ignored
      Added value: +{
      +  "type": "boolean"
      +}
  3. Changed5 schema fields changedv1.0.2
    • removedInput schema / properties / force_rebuild / default
      Removed value: -false
    • removedInput schema / properties / force_rebuild / title
      Removed value: -"Force Rebuild"
    • removedInput schema / properties / retry_skipped / default
      Removed value: -false
    • removedInput schema / properties / retry_skipped / title
      Removed value: -"Retry Skipped"
    • removedInput schema / title
      Removed value: -"syncArguments"
  4. First observedv1.0.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose real destructive semantics: prune_ignored drops sources, force_rebuild re-ingests everything. However, it omits default (incremental?) behavior, permission/auth requirements, and whether the drops are reversible.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in one sentence, then three tight clauses map directly to the boolean flags. Every sentence earns its place with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained, and the destructive flags are covered. It is close to complete for a 5-param mutation tool, missing only default incremental behavior and any auth/permission note.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 20% (ocr documented, ocr_timeout not), so the description must compensate, and it does: it explains force_rebuild, retry_skipped, and prune_ignored with concrete meaning. Only ocr_timeout remains undocumented in both places, keeping it from a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence gives a specific verb+resource+destination: 'Sync the documents directory into the vector store.' It clearly distinguishes this from sibling ingest paths like crawl and add. It stops short of explicitly naming those siblings, so it earns a 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description never states when to reach for sync versus crawl, add, import_dataset, or list_documents. The flag explanations describe modes of this tool, not selection criteria against alternatives. Usage is only implied by the tool name.

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