Skip to main content
Glama
Sign In
Obsidian Everywhere

Obsidian Everywhere

by junnnnnw00
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Read Vault File

read_file
Read-onlyIdempotent

Reads any Obsidian vault file, converting PDFs, Office docs, images, and code files to paginated text or image content. For unknown binaries, returns metadata and status.

Instructions

Read any indexed vault file. Markdown delegates to read_note; PDF/Office/OpenDocument/EPUB/RTF/text/code/data files return locally extracted, paginated text; supported images return MCP image content. Legacy or unknown binary formats return metadata and a clear unsupported status.

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": {
      "path": "<path>"
    },
    "name": "read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPDF page number.
pathYesVault-relative file path (or resolvable filename).
limitNoMaximum text lines (default 500).
sheetNoXLSX sheet name.
slideNoPPTX slide number.
offsetNoZero-based extracted-text line offset.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare read-only and idempotent behavior. The description adds valuable context not present in annotations: it explains output forms (paginated text, MCP image content, unsupported status), format-type branching, and delegation behavior for Markdown. This exceeds the minimum expected from annotated tools.

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 two sentences with high information density. The first sentence anchors the tool's core purpose; the second efficiently lists format-specific behavior. Every clause contributes useful details without repetition or irrelevant padding.

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?

This is a multi-format file reader with branching behavior, but the description covers all main output modes: Markdown delegation, text extraction with pagination, image content, and unsupported binary fallback. Combined with complete schema descriptions, this is sufficient for an agent to predict and interpret results.

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 description coverage is 100%, so all six parameters are individually documented. The description adds a context-level explanation of pagination and image output, but does not enrich semantics for specific parameters like sheet, slide, or offset. The schema already handles the heavy lifting.

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 the tool's function: reading any indexed vault file. It also distinguishes itself from the read_note sibling by specifying that Markdown files delegate to read_note, while other formats return extracted text or image content. This is a specific verb-resource pairing with explicit scope.

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 gives clear context for when read_file is appropriate: for PDFs, Office documents, images, and other non-Markdown files. It also implies that Markdown reading should go through read_note. However, it does not explicitly say 'use read_note instead of read_file for Markdown,' so the guidance is clear but slightly indirect.

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