Skip to content

MCP Resources

MCP resources expose vault metadata that clients can read directly without invoking tools. Most resources return application/json; ui://vault/app.html is an exception — it returns a self-contained HTML SPA for MCP Apps clients.

Quick Reference

URI Description
config://vault Current collection configuration
stats://vault Collection statistics
tags://vault All tags grouped by indexed field
tags://vault/{field} Tags for a specific field
folders://vault All folder paths
toc://vault/{path} Table of contents for a document
similar://vault/{path} Semantically similar notes for a document
recent://vault Most recently modified notes
ui://vault/app.html Interactive vault explorer SPA (MCP Apps)

config://vault

Current collection configuration and runtime state.

Response:

{
  "source_dir": "/data/vault",
  "read_only": true,
  "indexed_fields": ["tags", "cluster"],
  "required_fields": [],
  "exclude_patterns": [".obsidian/**", ".trash/**"],
  "semantic_search_available": true,
  "attachment_extensions": ["pdf", "png", "jpg"]
}

stats://vault

Collection statistics — document count, chunk count, and capabilities.

Response:

{
  "document_count": 42,
  "chunk_count": 156,
  "folder_count": 5,
  "semantic_search_available": true,
  "indexed_frontmatter_fields": ["tags", "cluster"],
  "attachment_extensions": ["pdf", "png", "jpg"]
}

tags://vault

All frontmatter tag values grouped by indexed field.

Response:

{
  "tags": ["craft", "pacing", "worldbuilding"],
  "cluster": ["fiction", "non-fiction"]
}

tags://vault/{field}

Tag values for a specific indexed frontmatter field. This is a URI template — replace {field} with the field name.

Example: tags://vault/tags

Response:

["craft", "pacing", "worldbuilding"]

folders://vault

All folder paths in the vault.

Response:

["", "Journal", "Projects", "Research"]

The empty string "" represents the root folder (top-level documents).

toc://vault/{path}

Table of contents (heading outline) for a specific document. This is a URI template — replace {path} with the document's relative path.

Example: toc://vault/Journal/note.md

Response:

[
  {"level": 1, "title": "My Note"},
  {"level": 2, "title": "Introduction"},
  {"level": 2, "title": "Main Points"},
  {"level": 3, "title": "First Point"},
  {"level": 2, "title": "Conclusion"}
]

The TOC prepends a synthetic H1 from the document title and deduplicates if the first real heading matches the title.

similar://vault/{path}

Top 10 semantically similar notes for a document. Requires embeddings to be built. This is a URI template — replace {path} with the document's relative path.

Results are at chunk granularity — the same document may appear multiple times if it has many chunks. Each entry is a full SearchResult object.

Example: similar://vault/Journal/note.md

Response:

[
  {"path": "Journal/related-note.md", "title": "Related Note", "folder": "Journal", "heading": null, "content": "...", "score": 0.87, "search_type": "semantic", "frontmatter": {}},
  {"path": "Research/topic.md", "title": "Topic Overview", "folder": "Research", "heading": null, "content": "...", "score": 0.82, "search_type": "semantic", "frontmatter": {}}
]

recent://vault

The 20 most recently modified notes. Each entry is a full NoteInfo object with an added modified_at_iso field. The original modified_at is preserved as a Unix timestamp float.

Response:

[
  {"path": "Journal/2024-01-15.md", "title": "Daily Note", "folder": "Journal", "frontmatter": {}, "kind": "note", "modified_at": 1705314600.0, "modified_at_iso": "2024-01-15T10:30:00+00:00"},
  {"path": "Projects/roadmap.md", "title": "Roadmap", "folder": "Projects", "frontmatter": {}, "kind": "note", "modified_at": 1705250700.0, "modified_at_iso": "2024-01-14T16:45:00+00:00"}
]

ui://vault/app.html

Interactive vault explorer delivered as a single self-contained HTML resource. This is an MCP Apps resource — clients that support the MCP Apps protocol render it as an interactive iframe. See the MCP Apps guide for details on the four views (Context Card, Graph Explorer, Vault Browser, Note Preview).