obsidian_read_note

Obsidian · macOS · Windows

Effect: read (strongest supported action). Status: gated.

Gated means the tool requires an installed app, a connected account, permission, or runtime availability. Check those requirements on the listed platform before using it.

macOS

Purpose

Reads one note of an Obsidian vault: its text, frontmatter, tags, outgoing [[wikilinks]] (each with the note it leads to) and backlinks (the notes that link to it). `note` is a path inside the vault, like Projects/Plan.md, or a note name as a wikilink names it, like Plan. Only Markdown notes are read: attachments and Obsidian's settings folder are not.

Required inputs

note — Path of the note inside the vault, or its name as a [[wikilink]] names it.

Permissions and confirmation

No explicit confirmation parameter is exposed in this snapshot. This does not grant permission to act: obtain user authorization before any real action.

Use only the apps, accounts and resources authorized by the user on this platform. Consult this tool's platform-specific description for its connection and permission requirements; this catalog does not assert additional OAuth scopes or OS entitlements.

Full input schema — macOS

{
  "properties": {
    "max_bytes": {
      "description": "Maximum bytes of text to return (default 256 KB, max 2 MB). A longer note comes back with truncated=true.",
      "type": "integer"
    },
    "note": {
      "description": "Path of the note inside the vault, or its name as a [[wikilink]] names it.",
      "type": "string"
    },
    "vault": {
      "description": "Vault name or id from obsidian_list_vaults. Optional when there is only one vault.",
      "type": "string"
    }
  },
  "required": [
    "note"
  ],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{
  "note": "Projects/Launch plan.md",
  "vault": "Demo Vault"
}

Windows