Skip to main content
Glama
Sign In
mcp-local-rag

mcp-local-rag

by xiuxiansk
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

sync_start

Synchronize the index with files on disk: ingest new and changed files, remove entries for deleted ones, and leave unchanged files untouched. Returns a job ID for tracking via sync_status.

Instructions

Reconcile the index with the files on disk: ingest new and changed files, leave unchanged files alone, and remove index entries for files that are gone. Returns { jobId } without waiting for the run to finish; poll sync_status with that jobId for progress and the final outcome. Only one job is kept, and it is lost when the server process exits.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sync_start"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoOptional absolute path to a file or directory inside a configured base directory; list_files returns those directories as baseDirs. A file synchronizes only itself and a directory only its own subtree, leaving every path outside it untouched. Omit it to synchronize every configured base directory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.17.3

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description fully discloses key behaviors: asynchronous execution (returns { jobId } without waiting), polling via sync_status, job retention (only one job kept), and loss on server exit. It also explains impact on unchanged and missing files. This goes well beyond basic safety hints.

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?

Three sentences, no fluff, all information is relevant and front-loaded. It efficiently covers purpose, async behavior, job lifecycle, and parameter scoping in a compact form.

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

Completeness5/5

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

The description is complete for a tool of this complexity: it explains the return value, polling mechanism, job limitation, and optional path semantics. No output schema exists, so return-value explanation is sufficient. It covers all critical operational aspects.

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

Parameters3/5

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

The schema already provides 100% coverage for the single 'path' parameter, including optionality, base directory behavior, and scoping rules. The description adds no new parameter semantics beyond what the schema says. Baseline 3 is appropriate.

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: 'Reconcile the index with the files on disk' with specific actions (ingest new/changed, leave unchanged, remove gone). This distinguishes it from siblings like ingest_file (single file ingest) and delete_file, and it explicitly notes the async jobId return and polling via sync_status.

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

Usage Guidelines4/5

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

The description implies when to use it: to reconcile the index with disk, with optional path scoping. It provides context on behavior (leaves unchanged files alone) but does not explicitly state when not to use it or name alternatives (e.g., use ingest_file for a single file). Still, context is clear and useful.

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

Deploy Server

Other Tools