Skip to main content
Glama
CROW: LLM Wiki

CROW: LLM Wiki

Official

read_note

Read-only

Retrieve a note’s full title, summary, and Markdown body by path so you can quote details missing from search results or cited summaries.

Instructions

Return the full text of one note: its title, its summary and its Markdown body.

Call it to read in full a note that recall cited or search found, before quoting details its summary lacks; for an answer drawn from several notes, use recall. No model call. An unknown path returns an error naming it.

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

Input Schema

NameRequiredDescriptionDefault
pathYesIts path as recall or search gives it, e.g. finance/pricing.md

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.5
    • changedInput schema / properties / path / description
      Previous value: -"The note's path as recall cites it, e.g. finance/pricing.md"New value: +"Its path as recall or search gives it, e.g. finance/pricing.md"
  2. First observedv1.0.4

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the description adds value beyond them by disclosing that there is "No model call" (cheap/fast) and that an unknown path returns an error naming it — a concrete failure mode an agent can act on. It stops short of noting body size or token cost for very large notes, so it is strong but not exhaustive.

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?

Two sentences, no filler, and the return payload is front-loaded before the routing guidance. Every clause carries information an agent needs to choose or call the tool.

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?

An output schema exists, so return-value documentation is not required; the description still names the payload shape briefly. For a single-parameter read tool with clear annotations, the description covers purpose, routing, cost hint, and failure behavior — nothing material is missing.

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 coverage is 100%, with the `path` parameter already documented with an example format, so the baseline is 3. The description only adds that the path is the one recall or search supplied and that an unknown path errors with its name, which is marginal extra meaning over the schema.

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?

States a specific verb and resource ("Return the full text of one note") and enumerates what comes back: title, summary, Markdown body. That scope is clearly distinguishable from `recall` and `search`, which the description also references.

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?

Gives an explicit trigger (read in full a note that `recall` cited or `search` found), an explicit reason (before quoting details its summary lacks), and an explicit alternative with its selection condition ("for an answer drawn from several notes, use `recall`"). Nothing is left to inference.

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