Skip to main content
Glama

Read notes

read_notes
Read-onlyIdempotent

Read one note by name, or list the notes of your notebook (names, sizes, update times) when no name is given, optionally filtered by a name prefix.

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": {
      "notebook": "<notebook>"
    },
    "name": "read_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyNoName of the note to read; omit to list notes.
prefixNoWhen listing, only names starting with this prefix.
notebookYesSecret notebook token returned by create_notebook.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description still adds value beyond them by disclosing what listing returns (names, sizes, update times), a detail not present in the annotations.

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 filler; the primary read behavior comes first and the fallback listing mode follows with its filter and return fields.

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 3-parameter read tool with full schema coverage and no output schema, the definition covers both modes well. One gap remains: it never says what a single-note read returns (e.g., note content), only what the listing mode returns.

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%, so key, prefix and notebook are already documented in the schema. The description largely restates those semantics (omit name to list, prefix filters) rather than adding format or edge-case detail, which is the baseline-3 case.

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 (read) and resource (note) plus a clearly scoped second mode — listing notebook notes with the fields returned (names, sizes, update times). The dual read/list behavior is unambiguous and trivially separable from write_note and delete_note.

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

Usage Guidelines4/5

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

Gives an explicit condition that selects listing mode ('when no name is given') and explains when prefix applies ('optionally filtered by a name prefix', 'when listing'). It does not name an alternative tool or state exclusions, but the mode-selection guidance is concrete.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.