Skip to main content
Glama
Sign In
vault-memory

vault-memory

by owrede
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

read_note

Read-onlyIdempotent

Fetch a note’s full content and frontmatter from its vault-relative path, enabling agents to inspect or reuse Obsidian knowledge.

Instructions

Read the full content + frontmatter of a note by its vault-relative path.

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

Input Schema

NameRequiredDescriptionDefault
pathYes
vaultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0-rc.5

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds useful return-content context ('full content + frontmatter'), but does not describe error behavior, pagination, or what happens with missing notes.

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?

A single front-loaded sentence with no wasted words. It states the action, returned data, and input format directly.

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

Completeness3/5

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

For a simple two-parameter read tool, the description states what is returned and the path semantics, and annotations cover safety. However, the vault parameter remains undefined in both schema and description, and there is no output schema to clarify return shape.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning. It clarifies that path is vault-relative, but says nothing about the required vault parameter. One of two parameters is explained, leaving a significant gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: read the full content plus frontmatter of a note. It clearly identifies the input as a vault-relative path. It does not, however, distinguish itself from sibling read/search tools such as fetch or search_text.

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

Usage Guidelines2/5

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

No explicit guidance on when to use this tool versus alternatives like fetch, get_brief, recall, or the search_* tools. The vault-relative path requirement implies usage, but alternatives and exclusions are absent.

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