Skip to main content
Glama

read_page

Read-onlyIdempotent

Retrieve the full Markdown text of a single vault page by its path, using paths returned by list_pages. Use it to read note contents for search, analysis, or summarization.

Instructions

Return the full Markdown text of one page.

Args: path: Path relative to the vault root, as returned by list_pages (for example "lca/Allocation.md").

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_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the description's remaining burden is small. It adds real value beyond them by stating the return is the *full* Markdown text (no truncation/pagination caveat) and that paths are vault-root relative and originate from list_pages.

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?

The purpose sentence is front-loaded and the parameter note is compact and concrete. Minor deduction for the docstring-style "Args:" formatting, which is a code artifact rather than prose tuned for an agent, but nothing is wasted.

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?

For a single-parameter read tool with an output schema and rich annotations, the description covers everything the agent needs: what comes back, in what format, and how to form the path. No meaningful gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry the parameter, and it does: it specifies the base (vault root), the provenance (as returned by list_pages), and gives a concrete example ("lca/Allocation.md"). An agent can construct a valid path from this alone.

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?

"Return the full Markdown text of one page" names a specific verb (return/read) and a specific resource (one page) with the output format stated. It is clearly distinct from list_pages and search by implication, though it never explicitly contrasts itself with those siblings.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the Args note that path is "as returned by list_pages" hints at the list-then-read workflow, but there is no explicit when-to-use/when-not guidance or named alternative for retrieving page content.

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

Deploy Server

Other Tools