Skip to main content
Glama

get_reindex_status

Poll background reindex progress and completion status after reindexing documents, with processed totals, percent complete, error counts, and failed file details.

Instructions

Get the current status of a background reindex operation.

Lightweight — does not compute full index statistics. Use this to poll progress after calling reindex_documents().

Returns: JSON string with reindex status. When active: operation name, progress (processed/total), percent complete, indexed/skipped/errors counts, and start time. When inactive: active=false, plus last_result or last_error from the most recent completed reindex. When the last run had errors, last_result includes failed_files (deduped [{"path", "reason"}, ...], capped at 100) and failed_files_truncated, so you can see exactly which files failed and why. A failed full_rebuild surfaces in last_error, whose message lists the first failing paths, and the partial last_result still carries the failed_files list.

Usage: Call repeatedly after reindex_documents() to monitor progress. When reindex.active becomes false, the operation is complete. Use get_index_stats() for full index health metrics.

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": "get_reindex_status"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv4.3.1

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does most of it: it declares the call is lightweight, enumerates the active vs. inactive response shapes, explains that a completed run surfaces last_result/last_error, and documents the failed_files cap of 100 with a truncation flag. It never explicitly states the call is side-effect-free/read-only, which is the one behavioral trait left implicit.

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

Conciseness4/5

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

Purpose is front-loaded in sentence one, followed by a compact behavioral note and a clearly labeled Returns block and Usage line. The Returns block is fairly long and partly duplicates the existing output schema, so a sentence or two of it is not strictly earning its place.

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?

For a zero-parameter polling tool this covers everything an agent needs: when to call it, how to tell the job finished, what each terminal state returns, how failures are reported, and which sibling to use for a different question. Although an output schema exists, the description's explanation of failure fields adds interpretation the schema alone would not convey.

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 takes no parameters, so there is no parameter meaning to add; the schema is trivially complete at 100% coverage. The baseline for a zero-parameter tool applies, and the description correctly spends no words on arguments.

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 first sentence gives a specific verb and resource: 'Get the current status of a background reindex operation,' with the 'background' qualifier scoping it to async jobs. It explicitly contrasts itself with get_index_stats ('does not compute full index statistics'), so an agent can separate it from its closest sibling without opening either schema.

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?

Usage is stated concretely: poll after calling reindex_documents(), stop when reindex.active becomes false, and use get_index_stats() for full health metrics. Both the trigger condition and the named alternative are given, leaving nothing to inference.

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