Skip to main content
Glama

read_notes

Retrieves a device's working notes from harald-work//notes.md, returning an empty string when none exist so coding agents can review prior findings.

Instructions

the working notes for a device, or an empty string when there are none.

notes live in harald-work//notes.md, relative to the server's working directory.

Input Schema

NameRequiredDescriptionDefault
slugYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.5/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 disclosure burden. It does disclose one genuinely useful behavior — an empty string is returned when no notes exist — but says nothing about read-only semantics, permissions, or what happens for an unknown/invalid slug (error vs empty string).

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

Conciseness3/5

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

Short and free of padding, but it is front-loaded with the return value (a sentence fragment with no subject or verb) instead of the action. The path convention detail is useful; the structure is awkward for an agent scanning for purpose.

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

Completeness2/5

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

An output schema exists, so the leading sentence about the return value largely duplicates structured data while the actual gaps — read-only nature, slug provenance, missing-file/error behavior — go unfilled. For a tool with zero annotation coverage and an undocumented required parameter, this leaves an agent with real unanswered questions.

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 0% — the single 'slug' parameter has no description at all. The description partially compensates by showing the path template harald-work/<slug>/notes.md, revealing that slug is a directory identifier, but it never says what a slug looks like or where to obtain one (e.g., list_devices).

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

Purpose3/5

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

The description is a noun phrase ('the working notes for a device') rather than a verb+resource statement, so the action is only inferable from the name read_notes. It does add useful specificity about where notes live, but it never explicitly says 'reads/returns the note file for the given device slug' nor distinguishes itself from the sibling save_note.

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 call this versus alternatives; the obvious counterpart save_note is never mentioned. The agent must infer read-vs-write from the tool names alone.

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