Skip to main content
Glama

read_note

Read-onlyIdempotent

Retrieve a note from a specified vault path, including its frontmatter, content, wiki-links, backlinks, and unresolved links.

Instructions

Read a note: frontmatter, content, wiki-links, backlinks, unresolved links.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesVault-root-relative note path
vaultYesVault name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds real value by disclosing the returned payload (frontmatter, content, wiki-links, backlinks, unresolved links), which is important given there is no output schema; it omits note-size or truncation behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single compact sentence that front-loads the verb and resource before enumerating outputs. Every clause earns its place, though it reads as a fragment rather than a structured description.

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 two-parameter read with no output schema, enumerating the returned fields is the key missing piece and it is provided. Nothing about error handling or missing-note behavior, but the core is complete.

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?

With 100% schema description coverage for both parameters (path as vault-root-relative note path, vault as vault name), the schema carries the semantics. The description adds nothing about parameter format or edge cases, so the baseline 3 applies.

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 a note') and enumerates exactly what the read covers: frontmatter, content, wiki-links, backlinks, unresolved links. It does not, however, distinguish itself from siblings like list_notes or search_notes that also surface note content.

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?

There is no statement of when to use this versus list_notes, search_notes, or history — the agent must infer usage from the tool name alone. No prerequisites, no exclusions, no alternative routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.