Skip to main content
Glama

Index the memory folder

index_memory
Idempotent

Walks the workspace's Markdown notes into the search index (chunks, keyword index, entities). If an embedding provider is configured, stamps new and changed notes with it; the provider must match the existing index dimensions. Run it when search_memory or get_context report index.stale; saved facts are keyword-searchable without it. It does not wait for a slow or refusing embedding service: such files are reported (warning "index-unfinished") and finished in the background.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
okYes
totalYes
detailNo
errorsYes
failureNo
indexedYes
warningNo
skippedTooLargeNo
skippedNonUtf8NamesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "detail": {
      +      "type": "string"
      +    },
      +    "errors": {
      +      "type": "number"
      +    },
      +    "failure": {
      +      "type": "string"
      +    },
      +    "indexed": {
      +      "type": "number"
      +    },
      +    "ok": {
      +      "type": "boolean"
      +    },
      +    "skippedNonUtf8Names": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "skippedTooLarge": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "total": {
      +      "type": "number"
      +    },
      +    "warning": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ok",
      +    "total",
      +    "indexed",
      +    "errors"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Adds context well beyond the annotations: it discloses the embedding-provider dimension constraint, that a slow or refusing provider will not block the call, the 'index-unfinished' warning, and background completion. Annotations cover idempotency and non-destructiveness, and nothing here contradicts them.

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?

Front-loaded with what is indexed, then the embedding caveat, then the trigger condition. Every sentence carries actionable information, including the deferred-completion note that would otherwise surprise an agent.

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 an output schema present, return values need no explanation, and the description still covers the operation's side effects, preconditions, and failure mode. Nothing an agent needs in order to call this correctly is missing.

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?

Zero parameters, so per the baseline this scores 4. The description does not need to explain inputs and correctly spends no space on them, though it also adds nothing further about invocation surface.

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?

States a specific verb and resource ('walks the workspace's Markdown notes into the search index') and enumerates what gets built (chunks, keyword index, entities). It also distinguishes itself from read-side siblings by naming the stale-index signal emitted by search_memory and get_context.

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?

Explicit trigger ('Run it when search_memory or get_context report index.stale') plus an explicit when-not-needed clause ('saved facts are keyword-searchable without it'). The agent has a clear decision rule and does not have to infer one.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.