Skip to main content
Glama

read_entry

Retrieve the full plain-text content of a Norton Guide entry by specifying its file path and byte offset. Returns lines and optional see-also references.

Instructions

Return the full plain-text content of the entry at a given offset.

Args: path: Absolute path to the .ng file. offset: Byte offset of the entry within the guide, as returned by list_entries or list_menus.

Returns: A dictionary containing:

- ``offset`` (int): The entry's offset.
- ``type`` (str): ``"short"`` or ``"long"``.
- ``lines`` (list[str]): Plain-text lines of the entry.
- ``see_also`` (list[dict]): For long entries only — each item has
  ``text`` (str) and ``offset`` (int) keys.  Empty list for short
  entries.

Raises: FileNotFoundError: If path does not point to an existing file. ValueError: If the offset does not point to a valid entry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
offsetYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations are provided, so the description carries the full burden. It thoroughly discloses the return value structure, error conditions (FileNotFoundError, ValueError), and the fact that it returns plain-text content.

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 description is well-structured with clear sections (Args, Returns, Raises) but is somewhat verbose. Every sentence adds value, though it could be slightly more concise.

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?

Given the tool's complexity, the description covers the return value (with keys and types), possible errors, and parameter purposes. It provides sufficient context for an agent to invoke it correctly.

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 coverage is 0%, meaning the schema has no descriptions. The description adds detailed meaning for both parameters: path is an absolute path to a .ng file, offset is a byte offset from list_entries or list_menus.

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 clearly states the action: 'Return the full plain-text content of the entry at a given offset.' It uses a specific verb and resource, distinguishing it from sibling tools like list_entries and read_entry_source.

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 description explains that the offset comes from list_entries or list_menus, implying the tool is used after listing. However, it does not explicitly state when not to use it or mention alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/davep/ngmcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server