> ## Documentation Index
> Fetch the complete documentation index at: https://docs.the40thieves.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# index_vault

> Chunk and embed the vault (or a folder) into the search index.

Chunk and embed the vault (or a folder) into the search index. Incremental: chunks whose content hash is unchanged are skipped; removed chunks are pruned. response\_format=concise drops the bookkeeping counters and keeps the failure, skip and degradation signals.

| | |
| - | - |
| **Domain** | vault |
| **Scopes** | `admin:vault` |
| **Access** | write |
| **Tags** | `read-only`, `admin`, `domain:vault`, `external-network` |
| **Profile** | core, full |

## Annotations

| Annotation | Value |
| - | - |
| Read-only | yes |
| Destructive | no |
| Idempotent | no |
| Accepts an idempotency key | no |

`Idempotent` is the advisory MCP `idempotentHint`. `Destructive` is also `yes` for a tool that
asks for confirmation only on some calls.

## Confirmation (human in the loop)

No human confirmation is required to call this tool.

## Input

| Parameter | Type | Required | Default | Description |
| - | - | - | - | - |
| `vault` | `string` | | — | Vault id. May be omitted when only one vault is available. length 1–64; pattern `^[a-z0-9_-]+$` |
| `folder` | `string` | | — | length 1–1024 |
| `response_format` | `enum` | | — | concise returns only the high-signal fields; detailed (the shipped default) returns the full payload. Errors and safety warnings are never trimmed. When omitted, the server's tools.defaults.responseFormat applies. One of: `"concise"`, `"detailed"` |
| `verbosity` | `enum` | | — | Legacy alias for response\_format: terse = concise, full = detailed. One of: `"full"`, `"terse"` |

## Output

| Field | Type | Always present | Description |
| - | - | - | - |
| `vault` | `string` | | — |
| `notes_seen` | `number` | | — |
| `notes_indexed` | `number` | | — |
| `chunks_upserted` | `number` | | — |
| `chunks_deleted` | `number` | | — |
| `chunks_unchanged` | `number` | | — |
| `edges_inserted` | `number` | | — |
| `edges_deleted` | `number` | | — |
| `secrets_skipped` | `number` | | — |
| `vec_enabled` | `boolean` | | — |
| `fts_enabled` | `boolean` | | — |
| `notes_upserted` | `number` | | — |
| `notes_deleted` | `number` | | — |
| `notes_embed_failed` | `number` | | — |
| `chunks_dedup_reused` | `number` | | — |
| `chunks_dedup_unresolved` | `number` | | — |
| `embed_batch_rejections` | `number` | | — |
| `notes_stale_skipped` | `number` | | — |
| `notes_epoch_stale_skipped` | `number` | | — |
| `notes_frontmatter_failed` | `number` | | — |
| `frontmatter_failures` | `object[]` | | — |
| `frontmatter_failures[].path` | `string` | with parent | — |
| `frontmatter_failures[].error` | `string` | with parent | — |
| `notes_read_refused` | `number` | | — |
| `read_refusals` | `object[]` | | — |
| `read_refusals[].path` | `string` | with parent | — |
| `read_refusals[].error` | `string` | with parent | — |
| `model` | `string` | | — |
| `dimensions` | `number` | | — |
| `status` | `enum` | | One of: `"working"` |

*4 more field(s) not shown; `describe_capability` returns the full output schema.*

## Related tools

Other tools in the `vault` domain: [`add_vault`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/add_vault/), [`get_vault`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/get_vault/), [`list_vaults`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/list_vaults/), [`refresh_plugin_capabilities`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/refresh_plugin_capabilities/), [`reload_vault`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/reload_vault/), [`reset_vault_cache`](https://docs.the40thieves.dev/reliquary-tc/tools/reference/reset_vault_cache/).

Back to the [tool catalog](https://docs.the40thieves.dev/reliquary-tc/tools/tool-catalog.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.