Skip to main content
Glama

Read Note

vault_read_note
Read-onlyIdempotent

Retrieve the full content or parsed properties of a markdown note using its vault-relative path. Returns raw markdown or JSON properties.

Instructions

Read a markdown note by its vault-relative path. Returns the full raw content including properties, or just the parsed properties when properties_only is set.

Example: vault_read_note({ path: "Projects/vault-cortex.md" }) Example: vault_read_note({ path: "Projects/vault-cortex.md", properties_only: true })

When to use: You know the exact path and need the full content of a specific note. Use properties_only: true when you only need properties (saves tokens on large notes). Prefer vault_search when you don't know the path. Prefer vault_get_memory for About Me/ files (returns content without properties).

Returns: Raw markdown string (default), or JSON object of properties (when properties_only: true).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesVault-relative path to the note (e.g. "About Me/Principles.md")
properties_onlyNoIf true, returns parsed properties as JSON instead of full note content
Behavior4/5

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

Annotations already indicate readOnly and idempotent. Description adds return formats (raw string or properties JSON) and token-saving benefit. Does not cover error behavior, but given annotations, it provides useful extra context.

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?

Very concise with clear sections: action, examples, usage guidance, return format. No unnecessary words.

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?

Covers all necessary aspects for a simple read tool with two parameters: input, output, when to use, benefits of optional parameter, and comparisons to siblings. Missing error handling is acceptable for this level.

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. Description adds concrete examples of both parameters, explains that properties_only returns parsed properties as JSON, and mentions token savings. This goes beyond the schema descriptions.

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?

Clearly states it reads a markdown note by vault-relative path with optional properties_only mode. Differentiates from sibling tools like vault_search and vault_get_memory by specifying when each is appropriate.

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

Usage Guidelines5/5

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

Explicitly tells when to use (know exact path, need full content) and when not to (prefer vault_search for unknown path, vault_get_memory for About Me files). Provides guidance on properties_only to save tokens.

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/aliasunder/vault-cortex'

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