Skip to main content
Glama
Sign In
obsidian-mcp

obsidian-mcp

by ZethicTech
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

read_note

Read-onlyIdempotent

Retrieve the complete content of a note using its wikilink name or exact vault path.

Instructions

Read the full content of a note. Provide either file (wikilink name) or path (exact vault path).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNoNote name (wikilink-style resolution)
pathNoExact path from vault root

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.7

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, informing safety. The description adds that it returns 'full content' and clarifies parameter alternatives, which are not in annotations. No contradictions.

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, 18 words, front-loaded with purpose. No unnecessary information.

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?

For a simple read tool with rich annotations, the description is mostly complete. Missing details on output format and error handling, but likely sufficient for agent usage.

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% with descriptions. The description adds value by clarifying that parameters are alternatives ('Provide either... or...'), which is not explicit in schema.

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 explicitly states 'Read the full content of a note' with a clear verb and resource. It distinguishes between two input methods (file and path), providing specificity.

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?

The description guides parameter choice ('Provide either file... or path...'), but lacks broader usage context such as when to use this tool over siblings like search or get_file_info. No exclusions or prerequisites are mentioned.

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