Skip to main content
Glama

obsidian_read_note

Read a single Obsidian note by name or vault-relative path, returning redacted content, outgoing wikilinks, and truncation metadata so you know if the note was clipped.

Instructions

Read one note by name or vault-relative path (resolves like a wikilink). Returns content with credential-looking lines redacted, plus outgoing wikilinks and an obsidian:// link. Very long notes are clipped at a line boundary: check truncated, and bytes_returned against bytes_total, before treating the content as the whole note.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "note": "<note>"
    },
    "name": "obsidian_read_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYes'Projects/Roadmap.md' or just 'Roadmap'
vault_pathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.11

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the behavioral disclosure burden and does well: it states that credential-looking lines are redacted, that outgoing wikilinks and an obsidian:// link are returned, and that long notes are clipped at a line boundary. It gives concrete fields (`truncated`, `bytes_returned`, `bytes_total`) to check before treating content as complete. It stops short of describing error behavior or access requirements, so it is strong but not fully exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three tightly written sentences, front-loaded with the core action and followed by return behavior and truncation caveats. Every sentence adds information an agent needs, with no repetition or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description appropriately explains the return shape: redacted content, outgoing wikilinks, an obsidian:// link, and truncation metadata. The main remaining gap is that `vault_path` is not explained and note-not-found behavior is unspecified. For a simple read tool, it is otherwise complete enough to call correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: the required `note` parameter has an example, while `vault_path` is undocumented in the schema. The description adds useful meaning for `note` by explaining name or vault-relative path resolution like a wikilink, but it never explains what `vault_path` does or when to supply it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Read one note by name or vault-relative path.' The wikilink-style resolution clarifies what kind of lookup it performs. It distinguishes itself naturally from sibling tools like obsidian_list_notes, obsidian_search_notes, and obsidian_save_note by emphasizing reading a single note, but it does not explicitly name or route against those siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied: use this when you know which single note to read. The description does not explicitly say when to use it instead of obsidian_search_notes or obsidian_list_notes, nor does it state what to do if the note name is unknown or ambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools