Skip to main content
Glama

vault_read

Read-onlyIdempotent

Read files from your Obsidian vault to access note content and frontmatter for building a compounding knowledge base.

Instructions

Read a file from the Obsidian vault. Returns the full content including frontmatter.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRelative path to the file (e.g. 'notes/my-note.md')
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=false, covering safety and idempotency. The description adds value by specifying the return format ('full content including frontmatter'), which isn't covered by annotations. However, it doesn't disclose other behavioral traits like error handling (e.g., if file doesn't exist) or performance aspects.

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 a single, efficient sentence that front-loads the core action ('Read a file from the Obsidian vault') and adds necessary detail about the return value. Every word earns its place with no redundancy or fluff.

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?

Given the tool's low complexity (1 parameter, no output schema), rich annotations (covering read-only, non-destructive, idempotent behavior), and clear purpose, the description is mostly complete. It specifies the return content, which compensates for the lack of output schema. A minor gap is no mention of error cases (e.g., missing files).

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%, with the schema fully documenting the single 'path' parameter. The description doesn't add any parameter-specific details beyond what the schema provides (e.g., no examples of valid paths beyond the schema's example). Baseline 3 is appropriate as the schema carries the full burden.

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 specific action ('Read a file') and resource ('from the Obsidian vault'), distinguishing it from siblings like vault_list (list files) or vault_write (write files). It also specifies the scope of what's returned ('full content including frontmatter'), making the purpose unambiguous.

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 implies usage for reading file content, but doesn't explicitly state when to use this tool versus alternatives like vault_frontmatter (which might extract only frontmatter) or vault_search (which searches content). It provides basic context but lacks explicit guidance on exclusions or comparisons with sibling tools.

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/tomjrworks/synapse-obsidian'

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