Index Status
get_index_statusCheck the full-text search index build status to diagnose delays or IndexUnavailableError, revealing if the index is still building, queryable, or failed, along with document count and error details.
Instructions
Return background-build state of the FTS index.
Use this when initialize returned but bucket-3/4 calls
block longer than expected or surface
IndexUnavailableError — the status field
distinguishes "still building" from "build failed," and the
error field carries the exception message from the last
background-build attempt that captured one. error may be
populated when status is "queryable" (a successful
build followed by a later failed rebuild leaves the captured
diagnostic in place until the next successful build clears
it) and is always None when status is "building".
Returns: Dict with the following fields:
- status (str): ``"queryable"``, ``"building"``, or
``"failed"``.
- documents_indexed (int): Count of documents committed to
the FTS index right now (rises during ``"building"``).
``0`` both for an empty index and when the count could not
be read — see ``documents_indexed_error`` to tell them apart.
- documents_indexed_error (str | None): ``None`` on a normal
read; the SQLite error message when the document count
could not be read (e.g. a locked or closed database), in
which case ``documents_indexed`` is ``0``.
- error (str | None): ``None`` unless the background build
raised.
- skipped_files (list[dict]): Files dropped from the index for a
surfaced deterministic reason. Each entry is
``{"path", "category", "detail"}`` where ``category`` is one of
``"parse_error"``, ``"encoding_error"``,
``"missing_frontmatter"``, or ``"internal_error"`` (an
unexpected indexer error, vs a content problem). Empty when
nothing was skipped.
Distinguishes a parse-dropped note from an unsynced one without
reading container logs. Exclude-pattern and transient-I/O skips
are intentionally not listed.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||