Skip to main content
Glama

sync_documents

Update the document index by processing only new, changed, or deleted files since the last sync to maintain current workspace memory.

Instructions

Incrementally sync the index with your workspace. Only processes new, changed, or deleted files since the last sync. Much faster than full ingestion. Run this when you've updated some documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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 effectively describes key traits: it's an incremental operation (not full), processes only new/changed/deleted files, is performance-optimized ('Much faster'), and triggers based on document updates. However, it doesn't mention potential side effects, error conditions, or authentication needs, leaving some behavioral aspects uncovered.

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?

The description is highly concise and front-loaded, with three sentences that each add value: the first explains the incremental sync operation, the second highlights performance benefits, and the third provides usage guidance. There is no wasted text or 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?

Given the tool's complexity (a sync operation with performance implications), no annotations, and an output schema present (which handles return values), the description is mostly complete. It covers purpose, usage, and key behavioral traits but lacks details on error handling, side effects, or prerequisites, which could be important for safe invocation.

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?

The tool has 0 parameters with 100% schema description coverage, so the baseline is 4. The description adds no parameter-specific information (as there are none), which is appropriate and doesn't detract from the score.

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

Purpose5/5

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

The description clearly states the tool's purpose with specific verbs ('sync', 'processes') and resources ('index', 'workspace', 'files'), and distinguishes it from the sibling tool 'ingest_documents' by emphasizing incremental vs. full processing. It explicitly mentions the scope of operations (new, changed, or deleted files since last sync).

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use this tool ('Run this when you've updated some documents') and contrasts it with an alternative approach ('Much faster than full ingestion'), helping the agent choose between this and sibling tools like 'ingest_documents' for document updates.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/besslframework-stack/project-tessera'

If you have feedback or need assistance with the MCP directory API, please join our Discord server