Skip to main content
Glama

Index status

ragdown_stats
Read-only

Show index health: documents folder, file and chunk counts, embedder, indexing primary status, and last sync. List every indexed file when include_files is enabled.

Instructions

The documents folder, index size (files, chunks), embedder, whether this process is the indexing primary, and the last sync. include_files lists every indexed file.

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_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
include_filesNo

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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds genuinely useful context by naming 'whether this process is the indexing primary' — a non-obvious diagnostic — but it says nothing about the cost or potential size of the response when include_files is enabled.

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?

Two compact sentences with no filler. The opening noun fragment ('The documents folder, index size...') is slightly awkward but effectively front-loads the returned data, and the parameter note is kept to a single trailing sentence.

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?

With no output schema, the description must convey what comes back, and it does so by listing each reported field. The only gap is the absence of any warning about response size or format when include_files=true, which matters for a file-enumerating flag.

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% and the single boolean has no description, so the sentence 'include_files lists every indexed file' is the only explanation of what the flag does. That is sufficient for a one-param tool, though it omits any hint that the result could be large.

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 description enumerates the concrete contents of the response (documents folder, index size in files/chunks, embedder, indexing-primary status, last sync), so an agent can tell this is a diagnostics/status tool rather than a document reader like ragdown_list or ragdown_read_doc. It lacks an explicit verb, but the resource and scope are unmistakable.

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?

There is no statement of when to call this tool, when not to, or which sibling to prefer. The agent must infer from the name and sibling list that this is for checking index health rather than listing or reading documents.

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