Skip to main content
Glama

Index Status

localnest_index_status
Read-onlyIdempotent

Check the status and metadata of your local semantic index to monitor indexing progress and verify data availability for search operations.

Instructions

Return local semantic index status and metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
response_formatNojson

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
metaNo

Implementation Reference

  • The registration and handler definition for 'localnest_index_status'. It calls vectorIndex.getStatus() and processes the result through normalizeIndexStatus.
    registerJsonTool(
      'localnest_index_status',
      {
        title: 'Index Status',
        description: 'Return local semantic index status and metadata.',
        inputSchema: {},
        annotations: {
          readOnlyHint: true,
          destructiveHint: false,
          idempotentHint: true,
          openWorldHint: false
        }
      },
      async () => normalizeIndexStatus(vectorIndex.getStatus())
    );
Behavior3/5

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

Annotations already declare read-only, idempotent, non-destructive behavior. The description adds that the tool returns 'status and metadata', which provides context about the output, but doesn't elaborate on what specific status states exist or caching behavior.

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?

The description is extremely concise at only six words. It efficiently conveys the core purpose without redundancy, though its brevity contributes to the lack of parameter documentation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema (reducing the need to describe return values) and comprehensive annotations, the description is minimally adequate. However, the complete omission of the 'response_format' parameter leaves a documentation gap for a tool that otherwise has low complexity.

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?

Schema description coverage is 0% and the description fails to compensate. It provides no explanation of 'response_format' (json vs markdown), why an agent might choose one over the other, or that it defaults to 'json'. The description adds zero semantic value beyond the schema keys.

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 uses a specific verb ('Return') and identifies the resource ('local semantic index') and scope ('status and metadata'). It implicitly distinguishes from sibling tools like 'index_project' (which likely builds the index) and 'search_code' (which queries it), though it doesn't explicitly state these contrasts.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage—agents can infer this is for checking index readiness before searching—but provides no explicit guidance on when to use this versus 'index_project' or what preconditions might apply.

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/wmt-mobile/localnest'

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