Skip to main content
Glama

MemorySync Documentation

Read a documentation page

read_doc
Read-only

Read the full Markdown text of one documentation page. Prefer this over a search snippet when you need exact method names, parameters, fields or limits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path such as '/quickstart' or '/api/memory/add', or its full URL.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNo
errorNoPresent only when the page could not be read.
titleNo
contentNoThe full page as Markdown.
messageNo
sectionNo

TDQS

A4.2/5.0
Behavior4/5

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

Annotations include readOnlyHint=true and openWorldHint=false, which already establish this as a safe, non-mutating operation. The description adds value beyond annotations by disclosing the return format ('full Markdown text') and clarifying that it returns complete content rather than a snippet. No contradiction exists between the description and 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?

The description is two tight sentences with zero wasted words. The first sentence front-loads the core purpose (read full Markdown page), and the second earns its place by adding usage guidance. Each sentence contributes distinct value.

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 simple 1-parameter read tool with rich annotations, a fully descriptive schema, and an output schema present, the description covers the essential context: what it does and when to prefer it over search. The only minor gap is that it does not reference list_doc_sections, one of the sibling tools, so the full alternative landscape is not explicitly mapped.

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 description coverage is 100% — the single 'path' parameter is thoroughly documented with examples ('/quickstart', '/api/memory/add', or full URL). With such high schema coverage, the baseline is 3, and the description does not need to compensate. The description adds no additional parameter-level meaning beyond what the schema already provides.

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?

The description states a specific verb+resource: 'Read the full Markdown text of one documentation page.' It clearly defines the scope (full text, Markdown format) and distinguishes from the search sibling by noting it is preferred over a 'search snippet' when exact details are needed. This differentiates the tool from search_docs and makes its purpose unambiguous.

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?

The second sentence provides a clear context rule: 'Prefer this over a search snippet when you need exact method names, parameters, fields or limits.' This is explicit when-to-use guidance that implicitly identifies search_docs as the alternative. However, it does not explicitly name the sibling tools or state when not to use it, so it falls just short of a 5.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: listing sections, reading a full page, and searching. There is no overlap in what they accomplish.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern (list_, read_, search_). Minor singular/plural variation is acceptable and readable.

Tool Count5/5

Three tools is perfectly scoped for a documentation server, covering the essential operations without bloat.

Completeness5/5

For a read-only documentation server, the surface is complete: orient, search, and read full content. No obvious missing operations.

Resources