Skip to main content
Glama

check_index_status

Check codebase indexing status to determine if search tools are ready or if indexing is required.

Instructions

USE THIS TOOL to check if the codebase has been indexed and whether search tools will return results. Call this BEFORE search_code or search_docs if you're unsure about indexing state.

TRIGGER - Call this tool when:

  • You're unsure if the codebase has been indexed

  • search_code or search_docs returned empty results

  • Starting work on a new project or session

  • You want to verify index health before searching

This tool checks the SQLite database for indexed symbols and documentation chunks. It's a lightweight diagnostic - much faster than re-indexing.

INTERPRETING RESULTS:

  • If "indexed" is false OR "symbols_indexed" is 0: You MUST call index_codebase first

  • If "suggestion" says "CALL index_codebase FIRST": Indexing is required

  • If "suggestion" says "ready to search": Search tools will work

Do NOT use this tool for:

  • Actually indexing the codebase (use index_codebase)

  • Searching for code or documentation

  • Git history queries

Args: directory: Path to the project directory to check.

Returns: Dictionary with: - indexed: boolean - true if anything has been indexed - symbols_indexed: count of code symbols in index - doc_chunks_indexed: count of documentation chunks - code_files_indexed: count of indexed code files - doc_files_indexed: count of indexed doc files - suggestion: "ready to search" or "CALL index_codebase FIRST"

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
directoryYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Discloses it checks SQLite database and is lightweight. Explains return values and interpretation. No annotations provided, so description carries full burden; it is thorough but could explicitly state it is read-only.

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?

Well-structured with sections and bullet points, front-loading the purpose. While somewhat verbose, every section adds value and aids navigability.

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 description covers all relevant aspects: purpose, triggers, interpretation of results, and return values. Output schema exists and is explained. Given the tool's simplicity and low parameter count, the description is complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description adds only a brief line for the directory parameter ('Path to the project directory to check'), which adds minimal value beyond the schema's type definition. No additional constraints or examples are provided.

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 clearly states the tool checks if the codebase has been indexed and whether search tools will return results. It distinguishes itself from siblings like search_code and search_docs by specifying its diagnostic role.

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?

Provides explicit triggers for when to call (before search tools, after empty results, new project) and when not to use (for indexing, searching). Includes alternative tool names like index_codebase.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kapillamba4/code-memory'

If you have feedback or need assistance with the MCP directory API, please join our Discord server