vault_index_status
Check search index health and statistics to verify data freshness and identify indexing issues.
Instructions
Check search index health and statistics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Check search index health and statistics to verify data freshness and identify indexing issues.
Check search index health and statistics.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds 'health and statistics' as the expected diagnostic content, but does not disclose additional behavioral details like response shape, cost, or relevance to reindexing. This is acceptable given the annotation coverage, but not exceptional.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, front-loaded sentence with no filler: 'Check search index health and statistics.' Every word earns its place, and the structure is appropriately minimal for a no-input status tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only diagnostic tool with annotations covering its safety profile, the description is largely complete. It could specify what statistics are returned or how health is measured, but the low complexity means the agent has enough to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so there is nothing for the description to explain about parameter meaning. Per the baseline for zero-parameter tools, this is a strong score; the description does not need to compensate for any undocumented inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Check') with a specific resource ('search index health and statistics'), making the tool's purpose immediately clear. It is semantically distinct from sibling tools like search, which queries note content, and vault_reindex, which changes the index, so an agent can tell them apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no guidance on when to use this tool versus alternatives such as search or vault_reindex. It does not mention whether the agent should first run a health check before searching, or when the statistics would be useful, so the usage context is left entirely to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.