Skip to main content
Glama

Reindex documents

ragdown_reindex

Updates the Markdown index immediately after bulk edits made while the server was off, or re-embeds all content when full=true is set.

Instructions

Bring the index up to date with the folder now. Changes are normally picked up automatically within a second; use this after bulk edits made while no server was running, or full: true to re-embed everything.

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

Input Schema

NameRequiredDescriptionDefault
fullNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv6.10.0
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv1.0.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-destructive, closed operation, and the description adds meaningful behavior on top: automatic indexing normally happens within a second, and full: true triggers re-embedding of everything, which signals a materially heavier operation. It does not say whether the call blocks until completion or roughly how long a full re-embed takes.

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?

Two tightly packed sentences with no filler. The default behavior comes first, the exception second, and the parameter flag last, which matches the order an agent needs them.

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?

For a one-parameter index-refresh tool with no output schema, the description covers what it does, when it is needed, and what the flag changes. Missing only secondary detail such as whether the operation is synchronous or what it reports back, which annotations and the tool's simplicity make tolerable.

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 0%, so the description carries the burden, and it does define the single parameter: full: true means re-embed everything. The default/incremental behavior of full: false is only implied by contrast rather than stated outright, which keeps it short of 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?

States a specific verb and resource: bring the document index up to date against the folder. This is clearly distinct from sibling operations like ragdown_write or ragdown_edit, though the description never explicitly contrasts itself with them.

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?

Gives real when-to-use guidance: normally unnecessary because changes are picked up automatically within a second, and appropriate after bulk edits made while no server was running. It also explains the escalation path (full: true). No sibling is named as an alternative, but none performs reindexing, so the practical guidance is complete.

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