/vault-wiki:obsidian-read

/vault-wiki:obsidian-read

Fetch notes and metadata from an Obsidian vault via REST API or MCP server. Lists vault structure, retrieves note content, and inspects metadata.

Setup

• VAULT_ID: from [vault-id] argument or environment
• OBSIDIAN_API_URL: localhost:27123 (REST API) or MCP server
• QUERY: optional search string from --query argument
• LIMIT: optional result limit from --limit argument (default 10)

Instructions

Parse arguments

• Extract VAULT_ID from first positional argument
• Extract QUERY from --query if present
• Extract LIMIT from --limit if present (default 10)

Connect to Obsidian

Attempt REST API first (http://localhost:27123/api/vault/info). If unavailable, fall back to MCP server (from .mcp.json config).

Execute query

1. If QUERY is provided:
   • Use vault search endpoint (REST) or MCP search method
   • Limit results to LIMIT
   • Return note paths and snippet context
2. If no QUERY:
   • List all notes in vault using vault structure endpoint
   • Include frontmatter metadata (tags, date_updated, type)

Output

Print results as structured list with:

• Note path
• Title (from frontmatter or first heading)
• Tags (if present)
• Last modified date
• Optional snippet (first 100 chars if search context available)