Skip to main content
Glama

Read Note

read_note

Retrieve a markdown note from your vault by its unique ID. Use this to access stored wiki content when your AI agent needs the full text of a specific note.

Instructions

Read a note by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
note_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It does not state whether the note is returned whole or paginated, what happens on missing/invalid id, or any permission requirements. 'Read' implies non-mutating, but nothing is confirmed.

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?

One short sentence, front-loaded with the verb and resource, with no filler. It is appropriately sized for a simple one-parameter tool.

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?

With an output schema present, return format needn't be described. However, for a retrieval tool with no annotations and an undocumented parameter, the description is minimally adequate—it should at least clarify id format or error behavior.

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?

The single parameter note_id has no description in the schema (0% coverage), but the description's phrase 'by id' indicates the required identifier. Baseline for a short schema is limited, and it adds only minimal meaning beyond the parameter name.

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 (read) and resource (note), plus the lookup key. It distinguishes from create/update/delete/move siblings by implication, but does not explicitly differentiate from search_notes, which also retrieves notes.

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 guidance on when to use this versus search_notes or the other note tools. An agent must infer that this is for direct retrieval by known id, but nothing is stated.

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