Skip to main content
Glama

Read a reference section

get_reference_section
Read-onlyIdempotent

Reads a single section or the contents list from a Whalory reference, profile, or channel file. Call without an anchor on long files to fetch the contents list first.

Instructions

Read one section (or the contents list) of a Whalory reference file under references/ (method, fa/, en/), profiles/ or data/channels/. Long files: call without anchor to get the contents list first.

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": "get_reference_section"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYese.g. references/router.md, fa/craft.md, en/prose.md, profiles/whalory.json
anchorNoHeading slug; omit it to get the contents list
max_charsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive, so the safety profile needs no restating. The description adds real context with the two-step contents-list strategy for long files. It says nothing about what happens when max_chars truncates output or when an anchor does not match, which are the behaviors an agent would most want to know here.

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?

Two sentences, zero filler, and the resource scope is front-loaded before the procedural hint. Nothing could be removed without losing information.

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, so the description carries some burden for return shape; it hints at this by mentioning the contents list but never describes what a returned section looks like. For a simple read tool with good annotations this is close to adequate, but the truncation behavior of max_chars and the failure mode for a bad anchor remain unexplained.

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 67% and the description mostly echoes what the schema already says: the anchor-omitted case is stated verbatim in the anchor field description, and the path examples duplicate the path field's own examples. max_chars, the parameter most in need of explanation, is not mentioned at all. Baseline 3 is warranted because the schema carries most of the weight.

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 ("Read") and a precisely scoped resource: one section or the contents list of a Whalory reference file, with the permitted roots enumerated (references/, profiles/, data/channels/). It does not name a sibling such as get_playbook or profile_lookup to mark the boundary, so an agent must infer that profile_lookup is not the right tool for profiles/whalory.json.

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?

It gives concrete procedural guidance for the common case: "Long files: call without anchor to get the contents list first." That tells the agent how to sequence calls rather than guessing. It stops short of explicit when-not guidance or naming an alternative tool for a different need.

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