Skip to main content
Glama
Sign In
apex-memory

apex-memory

by Shaurya-GitH
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

read

Retrieve a complete note or a specific section with its subsections, including IDs, versions, header fields, and live-source flags for safe updates.

Instructions

Read a whole note (no heading) or one section with its subsections. A section's content has headings relative to it (a direct child is '#'), exactly what patch_section's replace accepts. Returns ids and versions for the outline, the page header fields and live-source flags.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo
headingNo
max_charsNo
section_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does substantial work: it states what is returned (ids and versions for the outline, page header fields, live-source flags) and explains heading-relativity semantics of section content. It omits read-only confirmation, permission requirements, and what happens when max_chars is exceeded, keeping it from a 5.

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?

Three dense sentences that are front-loaded with the primary read modes and contain no filler. Some phrasing ('live-source flags') is jargon that an unfamiliar agent may not parse, but nothing is redundant.

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

Completeness3/5

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

There is no output schema, and the description partially compensates by describing return contents. However, for a 4-parameter tool with zero schema documentation, key behaviors — path resolution, max_chars truncation, and interaction between heading and section_id — remain unaddressed.

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

Parameters2/5

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

Schema description coverage is 0% across 4 parameters, so the description must compensate. It adds meaning for 'heading' (omitting it reads the whole note; subsection headings are relative) and hints at 'section_id' via the returned outline ids, but says nothing about 'path' or the truncation semantics of 'max_chars'.

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?

The description uses a specific verb and resource: 'Read a whole note (no heading) or one section with its subsections.' It clearly scopes the granularity of the read and implicitly distinguishes itself from patch_section (a mutation). It does not explicitly differentiate from siblings like search or brief, which may also return note content, so it falls short of a 5.

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 by the '(no heading)' / 'one section' phrasing, which maps the two modes of calling the tool. There is no explicit when-to-use guidance versus search, brief, or links, and no mention of prerequisites or exclusions.

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