Skip to main content
Glama

get_index_health

Read-onlyIdempotent

Check the indexing status and readiness of your codebase by retrieving health, stats, and pipeline progress. Identifies project root and suggests next actions if the index is empty. Verifies the index before running queries.

Instructions

Get index status, statistics, health, and pipeline progress (indexing, summarization, embedding). Includes the session projectRoot; when the index is empty, next_steps names the empty root and points at list_projects + call_project_tool for other registered projects. Read-only, no side effects. Use to verify the index is ready before running queries. Returns JSON: { status, stats, projectRoot, next_steps?, config, warnings, pipelineProgress, embedding }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.3.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
  2. Added
  3. Removedv1.38.0
  4. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already carry readOnly/idempotent/destructive safety, and the description reinforces this and adds genuinely new behavioral context: the empty-index next_steps behavior, the projectRoot inclusion, and the exact JSON envelope. No contradiction with annotations.

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 two sentences: a front-loaded purpose statement and a state-sensitive behavior note, plus a compact return-shape hint. Every sentence contributes information relevant to correct invocation.

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?

With no output schema, the description carries the full burden of explaining return values, and it enumerates the JSON fields. It also explains empty-index behavior and provides follow-up tool names, making it complete for a zero-parameter read-only health check.

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 zero parameters, so the schema leaves nothing to document and the baseline is 4. The description correctly adds no parameter syntax and instead uses the space to describe the return payload.

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 opens with a specific action-resource pair ('Get index status, statistics, health, and pipeline progress') and spells out the payload, so an agent knows exactly what the tool reports. It is distinct in subject matter from siblings like get_session_stats, but it does not explicitly name or contrast those alternatives, so it stops just short of top differentiation.

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?

It gives a clear invocation condition: 'Use to verify the index is ready before running queries.' It also hints at routing to list_projects and call_project_tool when the index is empty. No explicit when-not-to-use or alternative health tools are named, so it misses the top criterion.

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