Skip to content

vault_health_score

Composite vault link-health score (0-100) with a breakdown: orphan count, unresolved-link count, hub density, and cycle count over the readable note graph. response_format=concise drops total_links and the per-penalty breakdown. Domain: links.

Domain links
Scopes read:notes
Access read
Tags read-only, domain:links
Profile core, full
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.

No human confirmation is required to call this tool.

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_-]+$
hub_threshold integer 20 range 1–10000
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"
Field Type Always present Description
warnings object[] —
warnings[].path string with parent —
warnings[].reason enum with parent One of: "frontmatter_yaml"
warnings[].message string with parent —
warnings_omitted integer range ≥ -9007199254740991
vault string yes —
score number yes —
total_notes number yes —
total_links number —
metrics object yes —
metrics.orphans number yes —
metrics.unresolved_links number yes —
metrics.hubs number yes —
metrics.cycles number yes —
breakdown object —
breakdown.orphan_penalty number with parent —
breakdown.unresolved_penalty number with parent —
breakdown.cycle_penalty number with parent —
breakdown.hub_penalty number with parent —

Other tools in the links domain: find_link_cycles, find_orphans, find_unresolved_links, get_backlinks, get_link_strength, get_outgoing_links, graph_centrality, graph_communities, graph_path_between, prune_hub_links, rewrite_link, suggest_links.

Back to the tool catalog.