Skip to main content
Glama

Status

status

Check whether codebase index is current and healthy. Reports index size, engine availability, memory usage, and staleness warnings when files have changed since last index.

Instructions

Use at the start of a session, or when unsure if search results might be stale. Reports whether a codebase is indexed, index size/engine availability, memory usage, and a stale/staleness_warning pair if files changed since the last index (a background reindex is auto-triggered).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains what the tool reports and discloses that a background reindex is auto-triggered when files change, which is a meaningful side-effect an agent should know about.

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 a single, front-loaded sentence that starts with the key usage guidance and then enumerates the reported fields. Every clause earns its place; there is no redundancy or filler.

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 tool has no parameters and an output schema, so the description need not explain return values in depth. It covers purpose, usage timing, reported metrics, staleness behavior, and the auto-reindex side effect, making it complete for an agent to decide when and why to call it.

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 parameter semantics are not applicable. The baseline for zero-parameter tools is 4, and the description appropriately focuses on behavior rather than parameter details.

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 states a specific action ('Reports') and a precise resource scope: codebase index status, including index size, engine availability, memory usage, and staleness information. It clearly distinguishes itself from sibling tools like search and index by centering on index health and staleness.

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 gives explicit when-to-use guidance: at the start of a session or when search results might be stale. It does not name alternative tools explicitly, but the use cases are clear enough to guide an agent away from search or index tools.

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