get_index_info Leave feedback

get_index_info reports what an index holds — document count, the paths it covers, files that failed, its status — and which other indexes exist. With includeSupportedFormats: true it also lists the formats the engine indexes. Example prompt: “What is in the contracts index?”

Tool description (as the AI agent sees it):

Describes a search index without changing it: whether it exists, how many documents it holds, which paths are indexed, which documents failed to index, its format version, and the other indexes available. Call this when the user asks what is indexed, how big an index is, which indexes exist, or before searching to confirm the right documents are in the index. Safe to call with no arguments: it reports on the default index even when that index does not exist yet. Also lists the document formats the engine can index when includeSupportedFormats is true. Returns JSON: index, exists, documentCount, indexedPaths (relative to the storage folder), documentsWithErrors, version, segmentCount, termCount, status, availableIndexes, optional supportedFormats and evaluation. On failure the response starts with ‘Index-info lookup failed for’ followed by the exception type and message, and isError is set.

{
  "name": "get_index_info",
  "arguments": {
    "indexName": "contracts"
  }
}

JSON — captured from server 26.10.1 (evaluation note trimmed):

{
  "index": "contracts",
  "exists": true,
  "documentCount": 5,
  "indexedPaths": [ "contracts" ],
  "documentsWithErrors": [],
  "version": "26.10",
  "segmentCount": 1,
  "termCount": 158,
  "status": "Ready",
  "availableIndexes": [ "contracts" ]
}

For an index that does not exist yet, exists is false and a hint says to call add_to_index. indexedPaths is the list that remove_from_index accepts.

• “What is in the contracts index?”
• “Which indexes do I have?”
• “Can you index .pst files? List the supported formats.”