Skip to main content
Glama
Sign In
mindyard

mindyard

by floriantriclin
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Read page

read_page
Read-only

Retrieve a Markdown wiki page or root file by path, with raw bytes for editing, line pagination, version metadata, and clear errors for missing or out-of-wiki paths.

Instructions

Read one file of the target wiki (confined to its root).

Use it to open a page found with list_pages or search_wiki, and the index, log and schema files at the wiki root. A missing path or one outside the wiki is refused with an error.

Default: rendered for display, Obsidian wikilinks stripped, so never show '[[...]]' to the user. Pass raw=True to get the verbatim bytes before editing a page, so write_batch keeps the '[[...]]' syntax on disk.

offset is 1-based and limit caps the lines returned. Returns {content, version, total_lines, start_line, end_line, truncated}. Pass 'version' back as 'expected_version' when modifying this page.

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

Input Schema

NameRequiredDescriptionDefault
rawNoVerbatim bytes, wikilinks kept: use before editing.
pathYesFile path relative to the wiki root, e.g. 'index.md' or 'wiki/topic.md' (as listed by list_pages or search_wiki).
wikiYesWiki id, as returned by list_wikis.
limitNoMaximum number of lines; all when omitted.
offsetNoFirst line to return, 1-based.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.1.3
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of lines; all when omitted."
    • addedInput schema / properties / offset / description
      Added value: +"First line to return, 1-based."
    • addedInput schema / properties / path / description
      Added value: +"File path relative to the wiki root, e.g. 'index.md' or 'wiki/topic.md' (as listed by list_pages or search_wiki)."
    • addedInput schema / properties / raw / description
      Added value: +"Verbatim bytes, wikilinks kept: use before editing."
    • addedInput schema / properties / wiki / description
      Added value: +"Wiki id, as returned by list_wikis."
  2. First observedv0.1.1

TDQS

A4.8/5.0
Behavior5/5

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

Goes well past the readOnlyHint annotation by disclosing a non-obvious output transformation: the default rendering strips Obsidian wikilinks, and raw=True is required before editing so write_batch preserves '[[...]]' on disk. It also discloses offset/limit semantics and the version round-trip contract for safe modification.

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?

Front-loaded with the identity and scope, then usage, then defaults, then paging/return contract — a sensible ordering with no filler sentences. Minor redundancy: it restates the return object shape that the output schema already defines, which is the one part that does not need to be here.

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 five-parameter read tool with a full output schema and read-only annotations, everything an agent needs is present: scope containment, the raw-vs-rendered trap, paging semantics, and the concurrency token handoff. Nothing material is left to inference.

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

Parameters4/5

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

Schema coverage is 100%, so all five parameters are already documented; the description still adds workflow meaning the schema lacks — raw=True is tied to a later write_batch edit, and the returned 'version' is tied to being passed back as 'expected_version'. It does not add much for wiki/path beyond what the schema says.

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 ('Read one file of the target wiki') and immediately bounds the scope ('confined to its root'). It also distinguishes itself from list_pages and search_wiki by positioning itself as the tool you use on a page those tools returned.

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?

Explicitly names the discovery tools whose output feeds this one (list_pages, search_wiki) and the specific root-level files it is meant for (index, log, schema). It also states the failure condition: a missing path or one outside the wiki is refused with an error.

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