Skip to main content
Glama
digster

obsidian-cli-mcp

by digster

read_note

Read the full Markdown contents of an Obsidian note by name, path, or the currently active note.

Instructions

Read a note's full Markdown contents.

Specify the note by file (name) or path (exact). If both are omitted, the currently active note in Obsidian is used.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNo
pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Without annotations, the description carries the burden. It discloses that it reads Markdown contents and defaults to the active note. No side effects are implied, which is appropriate for a read tool.

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?

Two sentences with no wasted words. The main action is front-loaded, and the parameter usage is clearly explained in the second sentence.

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

Completeness5/5

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

For a simple read tool with an output schema, the description is complete. It covers what the tool does, how to specify the note, and the fallback behavior.

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 0%, but the description explains that 'file' is the name and 'path' is the exact path, and both are optional. It adds the key behavior that omitting both uses the active note.

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?

The description clearly states it reads a note's full Markdown contents, specifying the verb and resource. It distinguishes from sibling tools like create_note or delete_note by focusing on reading.

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?

The description explains how to specify the note (by file name or path) and the fallback to the active note. It provides clear usage context but does not explicitly mention when not to use or alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/digster/obsidian-cli-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server