Skip to main content
Glama
rps321321

obsidian-mcp-pro

by rps321321
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Get Note

get_note
Read-onlyIdempotent

Read an Obsidian note in full or return only a section, block, or line range to keep token usage low. Returns frontmatter, inline tags, and body text.

Instructions

Read a note in full or as a fragment. With no fragment options, returns parsed frontmatter (as a labeled header), a flat list of inline #tags, and the body. With section, returns just the body under that heading (path-form like 'Tasks/Today' is supported). With block, returns the paragraph or block tagged ^id. With lines, returns the inclusive 1-indexed line range. Fragment modes skip the frontmatter/tag header and return raw text — use them to keep token usage tight on long notes.

Input Schema

NameRequiredDescriptionDefault
pathYesRelative path from vault root to the note (e.g., 'folder/note.md'). Extension required.
blockNoBlock id (without the leading `^`). Returns just the paragraph or block tagged with that id.
linesNoLine range, 1-indexed and inclusive (e.g., '10-25' or '42'). Returns just those lines.
sectionNoHeading path (e.g., 'Tasks' or 'Project A/Status'). Returns just that section's body.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.1.1
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Addedv2.0.0
  3. Removedv1.9.0
  4. Changed3 schema fields changedv1.8.0
    • addedInput schema / properties / block
      Added value: +{
+  "description": "Block id (without the leading `^`). Returns just the paragraph or block tagged with that id.",
+  "type": "string"
+}
    • addedInput schema / properties / lines
      Added value: +{
+  "description": "Line range, 1-indexed and inclusive (e.g., '10-25' or '42'). Returns just those lines.",
+  "pattern": "^\\d+(-\\d+)?$",
+  "type": "string"
+}
    • addedInput schema / properties / section
      Added value: +{
+  "description": "Heading path (e.g., 'Tasks' or 'Project A/Status'). Returns just that section's body.",
+  "type": "string"
+}
  5. Addedv0.1.6
  6. Removedv0.1.4
  7. Changed1 schema field changedv0.1.2
    • changedInput schema / properties / path / description
      Previous value: -"Relative path to the note within the vault"New value: +"Relative path from vault root to the note (e.g., 'folder/note.md'). Extension required."
  8. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/closed-world, and the description adds real value on the return shape: parsed frontmatter as a labeled header, a flat inline tag list, and body; fragment modes skip the header and return raw text. It does not describe failure behavior (missing note, nonexistent section or block id), which is the remaining gap.

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

Conciseness4/5

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

Front-loaded with the default behavior, then one clause per mode, ending with a practical recommendation about token usage. Dense but every sentence earns its place; slightly long in its enumeration.

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?

No output schema exists, and the description does carry that burden by explaining exactly what each mode returns. For a read-only, four-parameter tool with full schema coverage that is nearly sufficient; error/edge-case behavior is the only missing piece.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds semantic detail beyond the schema: section supports path-form headings ('Tasks/Today'), block targets the paragraph tagged with that id, and lines are inclusive 1-indexed. These clarify how parameters compose with the output modes, not just their types.

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

Purpose5/5

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

States a specific verb and resource ('Read a note') and immediately enumerates the four retrieval modes. It is clearly separable from siblings like search_notes, list_notes, and read_base without opening the schema.

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

Usage Guidelines4/5

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

Each mode is tied to a condition ('With section...', 'With block...', 'With lines...') and it explicitly recommends fragment modes for token efficiency on long notes. It lacks an explicit exclusion against sibling tools (e.g., use search_notes to locate a note first), so not a 5.

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